2 * collectd - src/virt.c
3 * Copyright (C) 2006-2008 Red Hat Inc.
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; only version 2 of the license is applicable.
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 * Richard W.M. Jones <rjones@redhat.com>
20 * Przemyslaw Szczerbik <przemyslawx.szczerbik@intel.com>
27 #include "utils_complain.h"
28 #include "utils_ignorelist.h"
30 #include <libgen.h> /* for basename(3) */
31 #include <libvirt/libvirt.h>
32 #include <libvirt/virterror.h>
33 #include <libxml/parser.h>
34 #include <libxml/tree.h>
35 #include <libxml/xpath.h>
36 #include <libxml/xpathInternals.h>
39 #define PLUGIN_NAME "virt"
41 #ifdef LIBVIR_CHECK_VERSION
43 #if LIBVIR_CHECK_VERSION(0, 9, 2)
44 #define HAVE_DOM_REASON 1
47 #if LIBVIR_CHECK_VERSION(0, 9, 5)
48 #define HAVE_BLOCK_STATS_FLAGS 1
49 #define HAVE_DOM_REASON_PAUSED_SHUTTING_DOWN 1
52 #if LIBVIR_CHECK_VERSION(0, 9, 10)
53 #define HAVE_DISK_ERR 1
56 #if LIBVIR_CHECK_VERSION(0, 9, 11)
57 #define HAVE_CPU_STATS 1
58 #define HAVE_DOM_STATE_PMSUSPENDED 1
59 #define HAVE_DOM_REASON_RUNNING_WAKEUP 1
62 #if LIBVIR_CHECK_VERSION(1, 0, 1)
63 #define HAVE_DOM_REASON_PAUSED_SNAPSHOT 1
66 #if LIBVIR_CHECK_VERSION(1, 1, 1)
67 #define HAVE_DOM_REASON_PAUSED_CRASHED 1
70 #if LIBVIR_CHECK_VERSION(1, 2, 9)
71 #define HAVE_JOB_STATS 1
74 #if LIBVIR_CHECK_VERSION(1, 2, 10)
75 #define HAVE_DOM_REASON_CRASHED 1
78 #if LIBVIR_CHECK_VERSION(1, 2, 11)
79 #define HAVE_FS_INFO 1
82 #if LIBVIR_CHECK_VERSION(1, 2, 15)
83 #define HAVE_DOM_REASON_PAUSED_STARTING_UP 1
86 #if LIBVIR_CHECK_VERSION(1, 3, 3)
87 #define HAVE_PERF_STATS 1
88 #define HAVE_DOM_REASON_POSTCOPY 1
91 #endif /* LIBVIR_CHECK_VERSION */
93 static const char *config_keys[] = {"Connection",
100 "BlockDeviceFormatBasename",
107 "PluginInstanceFormat",
113 const char *domain_states[] = {
114 [VIR_DOMAIN_NOSTATE] = "no state",
115 [VIR_DOMAIN_RUNNING] = "the domain is running",
116 [VIR_DOMAIN_BLOCKED] = "the domain is blocked on resource",
117 [VIR_DOMAIN_PAUSED] = "the domain is paused by user",
118 [VIR_DOMAIN_SHUTDOWN] = "the domain is being shut down",
119 [VIR_DOMAIN_SHUTOFF] = "the domain is shut off",
120 [VIR_DOMAIN_CRASHED] = "the domain is crashed",
121 #ifdef HAVE_DOM_STATE_PMSUSPENDED
122 [VIR_DOMAIN_PMSUSPENDED] =
123 "the domain is suspended by guest power management",
127 #ifdef HAVE_DOM_REASON
128 #define DOMAIN_STATE_REASON_MAX_SIZE 20
129 const char *domain_reasons[][DOMAIN_STATE_REASON_MAX_SIZE] = {
130 [VIR_DOMAIN_NOSTATE][VIR_DOMAIN_NOSTATE_UNKNOWN] =
131 "the reason is unknown",
133 [VIR_DOMAIN_RUNNING][VIR_DOMAIN_RUNNING_UNKNOWN] =
134 "the reason is unknown",
135 [VIR_DOMAIN_RUNNING][VIR_DOMAIN_RUNNING_BOOTED] =
136 "normal startup from boot",
137 [VIR_DOMAIN_RUNNING][VIR_DOMAIN_RUNNING_MIGRATED] =
138 "migrated from another host",
139 [VIR_DOMAIN_RUNNING][VIR_DOMAIN_RUNNING_RESTORED] =
140 "restored from a state file",
141 [VIR_DOMAIN_RUNNING][VIR_DOMAIN_RUNNING_FROM_SNAPSHOT] =
142 "restored from snapshot",
143 [VIR_DOMAIN_RUNNING][VIR_DOMAIN_RUNNING_UNPAUSED] =
144 "returned from paused state",
145 [VIR_DOMAIN_RUNNING][VIR_DOMAIN_RUNNING_MIGRATION_CANCELED] =
146 "returned from migration",
147 [VIR_DOMAIN_RUNNING][VIR_DOMAIN_RUNNING_SAVE_CANCELED] =
148 "returned from failed save process",
149 #ifdef HAVE_DOM_REASON_RUNNING_WAKEUP
150 [VIR_DOMAIN_RUNNING][VIR_DOMAIN_RUNNING_WAKEUP] =
151 "returned from pmsuspended due to wakeup event",
153 #ifdef HAVE_DOM_REASON_CRASHED
154 [VIR_DOMAIN_RUNNING][VIR_DOMAIN_RUNNING_CRASHED] =
155 "resumed from crashed",
157 #ifdef HAVE_DOM_REASON_POSTCOPY
158 [VIR_DOMAIN_RUNNING][VIR_DOMAIN_RUNNING_POSTCOPY] =
159 "running in post-copy migration mode",
162 [VIR_DOMAIN_BLOCKED][VIR_DOMAIN_BLOCKED_UNKNOWN] =
163 "the reason is unknown",
165 [VIR_DOMAIN_PAUSED][VIR_DOMAIN_PAUSED_UNKNOWN] =
166 "the reason is unknown",
167 [VIR_DOMAIN_PAUSED][VIR_DOMAIN_PAUSED_USER] = "paused on user request",
168 [VIR_DOMAIN_PAUSED][VIR_DOMAIN_PAUSED_MIGRATION] =
169 "paused for offline migration",
170 [VIR_DOMAIN_PAUSED][VIR_DOMAIN_PAUSED_SAVE] = "paused for save",
171 [VIR_DOMAIN_PAUSED][VIR_DOMAIN_PAUSED_DUMP] =
172 "paused for offline core dump",
173 [VIR_DOMAIN_PAUSED][VIR_DOMAIN_PAUSED_IOERROR] =
174 "paused due to a disk I/O error",
175 [VIR_DOMAIN_PAUSED][VIR_DOMAIN_PAUSED_WATCHDOG] =
176 "paused due to a watchdog event",
177 [VIR_DOMAIN_PAUSED][VIR_DOMAIN_PAUSED_FROM_SNAPSHOT] =
178 "paused after restoring from snapshot",
179 #ifdef HAVE_DOM_REASON_PAUSED_SHUTTING_DOWN
180 [VIR_DOMAIN_PAUSED][VIR_DOMAIN_PAUSED_SHUTTING_DOWN] =
181 "paused during shutdown process",
183 #ifdef HAVE_DOM_REASON_PAUSED_SNAPSHOT
184 [VIR_DOMAIN_PAUSED][VIR_DOMAIN_PAUSED_SNAPSHOT] =
185 "paused while creating a snapshot",
187 #ifdef HAVE_DOM_REASON_PAUSED_CRASHED
188 [VIR_DOMAIN_PAUSED][VIR_DOMAIN_PAUSED_CRASHED] =
189 "paused due to a guest crash",
191 #ifdef HAVE_DOM_REASON_PAUSED_STARTING_UP
192 [VIR_DOMAIN_PAUSED][VIR_DOMAIN_PAUSED_STARTING_UP] =
193 "the domain is being started",
195 #ifdef HAVE_DOM_REASON_POSTCOPY
196 [VIR_DOMAIN_PAUSED][VIR_DOMAIN_PAUSED_POSTCOPY] =
197 "paused for post-copy migration",
198 [VIR_DOMAIN_PAUSED][VIR_DOMAIN_PAUSED_POSTCOPY_FAILED] =
199 "paused after failed post-copy",
202 [VIR_DOMAIN_SHUTDOWN][VIR_DOMAIN_SHUTDOWN_UNKNOWN] =
203 "the reason is unknown",
204 [VIR_DOMAIN_SHUTDOWN][VIR_DOMAIN_SHUTDOWN_USER] =
205 "shutting down on user request",
207 [VIR_DOMAIN_SHUTOFF][VIR_DOMAIN_SHUTOFF_UNKNOWN] =
208 "the reason is unknown",
209 [VIR_DOMAIN_SHUTOFF][VIR_DOMAIN_SHUTOFF_SHUTDOWN] = "normal shutdown",
210 [VIR_DOMAIN_SHUTOFF][VIR_DOMAIN_SHUTOFF_DESTROYED] = "forced poweroff",
211 [VIR_DOMAIN_SHUTOFF][VIR_DOMAIN_SHUTOFF_CRASHED] = "domain crashed",
212 [VIR_DOMAIN_SHUTOFF][VIR_DOMAIN_SHUTOFF_MIGRATED] =
213 "migrated to another host",
214 [VIR_DOMAIN_SHUTOFF][VIR_DOMAIN_SHUTOFF_SAVED] = "saved to a file",
215 [VIR_DOMAIN_SHUTOFF][VIR_DOMAIN_SHUTOFF_FAILED] =
216 "domain failed to start",
217 [VIR_DOMAIN_SHUTOFF][VIR_DOMAIN_SHUTOFF_FROM_SNAPSHOT] =
218 "restored from a snapshot which was taken while domain was shutoff",
220 [VIR_DOMAIN_CRASHED][VIR_DOMAIN_CRASHED_UNKNOWN] =
221 "the reason is unknown",
222 #ifdef VIR_DOMAIN_CRASHED_PANICKED
223 [VIR_DOMAIN_CRASHED][VIR_DOMAIN_CRASHED_PANICKED] = "domain panicked",
226 #ifdef HAVE_DOM_STATE_PMSUSPENDED
227 [VIR_DOMAIN_PMSUSPENDED][VIR_DOMAIN_PMSUSPENDED_UNKNOWN] =
228 "the reason is unknown",
231 #endif /* HAVE_DOM_REASON */
233 #define NR_CONFIG_KEYS ((sizeof config_keys / sizeof config_keys[0]) - 1)
234 #define NANOSEC_IN_SEC 1e9
236 #define GET_STATS(_f, _name, ...) \
238 status = _f(__VA_ARGS__); \
240 ERROR(PLUGIN_NAME ": Failed to get " _name); \
244 static virConnectPtr conn = 0;
245 static char *conn_string = NULL;
246 static c_complain_t conn_complain = C_COMPLAIN_INIT_STATIC;
248 /* Node information required for %CPU */
249 static virNodeInfo nodeinfo;
251 /* Seconds between list refreshes, 0 disables completely. */
252 static int interval = 60;
254 /* List of domains, if specified. */
255 static ignorelist_t *il_domains = NULL;
256 /* List of block devices, if specified. */
257 static ignorelist_t *il_block_devices = NULL;
258 /* List of network interface devices, if specified. */
259 static ignorelist_t *il_interface_devices = NULL;
261 static int ignore_device_match(ignorelist_t *, const char *domname,
262 const char *devpath);
264 /* Actual list of block devices found on last refresh. */
265 struct block_device {
266 virDomainPtr dom; /* domain */
267 char *path; /* name of block device */
270 /* Actual list of network interfaces found on last refresh. */
271 struct interface_device {
272 virDomainPtr dom; /* domain */
273 char *path; /* name of interface device */
274 char *address; /* mac address of interface device */
275 char *number; /* interface device number */
278 typedef struct domain_s {
283 struct lv_read_state {
284 /* Actual list of domains found on last refresh. */
288 struct block_device *block_devices;
289 int nr_block_devices;
291 struct interface_device *interface_devices;
292 int nr_interface_devices;
295 static void free_domains(struct lv_read_state *state);
296 static int add_domain(struct lv_read_state *state, virDomainPtr dom);
298 static void free_block_devices(struct lv_read_state *state);
299 static int add_block_device(struct lv_read_state *state, virDomainPtr dom,
302 static void free_interface_devices(struct lv_read_state *state);
303 static int add_interface_device(struct lv_read_state *state, virDomainPtr dom,
304 const char *path, const char *address,
305 unsigned int number);
307 #define METADATA_VM_PARTITION_URI "http://ovirt.org/ovirtmap/tag/1.0"
308 #define METADATA_VM_PARTITION_ELEMENT "tag"
309 #define METADATA_VM_PARTITION_PREFIX "ovirtmap"
311 #define BUFFER_MAX_LEN 256
312 #define PARTITION_TAG_MAX_LEN 32
314 struct lv_read_instance {
315 struct lv_read_state read_state;
316 char tag[PARTITION_TAG_MAX_LEN];
320 struct lv_user_data {
321 struct lv_read_instance inst;
325 #define NR_INSTANCES_DEFAULT 1
326 #define NR_INSTANCES_MAX 128
327 static int nr_instances = NR_INSTANCES_DEFAULT;
328 static struct lv_user_data lv_read_user_data[NR_INSTANCES_MAX];
330 /* HostnameFormat. */
331 #define HF_MAX_FIELDS 3
333 enum hf_field { hf_none = 0, hf_hostname, hf_name, hf_uuid };
335 static enum hf_field hostname_format[HF_MAX_FIELDS] = {hf_name};
337 /* PluginInstanceFormat */
338 #define PLGINST_MAX_FIELDS 2
340 enum plginst_field { plginst_none = 0, plginst_name, plginst_uuid };
342 static enum plginst_field plugin_instance_format[PLGINST_MAX_FIELDS] = {
345 /* BlockDeviceFormat */
346 enum bd_field { target, source };
348 /* InterfaceFormat. */
349 enum if_field { if_address, if_name, if_number };
352 #define EX_STATS_MAX_FIELDS 15
355 ex_stats_disk = 1 << 0,
356 ex_stats_pcpu = 1 << 1,
357 ex_stats_cpu_util = 1 << 2,
358 ex_stats_domain_state = 1 << 3,
359 #ifdef HAVE_PERF_STATS
360 ex_stats_perf = 1 << 4,
362 ex_stats_vcpupin = 1 << 5,
364 ex_stats_disk_err = 1 << 6,
367 ex_stats_fs_info = 1 << 7,
369 #ifdef HAVE_JOB_STATS
370 ex_stats_job_stats_completed = 1 << 8,
371 ex_stats_job_stats_background = 1 << 9,
375 static unsigned int extra_stats = ex_stats_none;
377 struct ex_stats_item {
381 static const struct ex_stats_item ex_stats_table[] = {
382 {"disk", ex_stats_disk},
383 {"pcpu", ex_stats_pcpu},
384 {"cpu_util", ex_stats_cpu_util},
385 {"domain_state", ex_stats_domain_state},
386 #ifdef HAVE_PERF_STATS
387 {"perf", ex_stats_perf},
389 {"vcpupin", ex_stats_vcpupin},
391 {"disk_err", ex_stats_disk_err},
394 {"fs_info", ex_stats_fs_info},
396 #ifdef HAVE_JOB_STATS
397 {"job_stats_completed", ex_stats_job_stats_completed},
398 {"job_stats_background", ex_stats_job_stats_background},
400 {NULL, ex_stats_none},
403 /* BlockDeviceFormatBasename */
404 _Bool blockdevice_format_basename = 0;
405 static enum bd_field blockdevice_format = target;
406 static enum if_field interface_format = if_name;
408 /* Time that we last refreshed. */
409 static time_t last_refresh = (time_t)0;
411 static int refresh_lists(struct lv_read_instance *inst);
415 unsigned long long total_user_cpu_time;
416 unsigned long long total_syst_cpu_time;
419 struct lv_block_info {
420 virDomainBlockStatsStruct bi;
422 long long rd_total_times;
423 long long wr_total_times;
426 long long fl_total_times;
429 static void init_block_info(struct lv_block_info *binfo) {
433 binfo->bi.rd_req = -1;
434 binfo->bi.wr_req = -1;
435 binfo->bi.rd_bytes = -1;
436 binfo->bi.wr_bytes = -1;
438 binfo->rd_total_times = -1;
439 binfo->wr_total_times = -1;
441 binfo->fl_total_times = -1;
444 #ifdef HAVE_BLOCK_STATS_FLAGS
446 #define GET_BLOCK_INFO_VALUE(NAME, FIELD) \
447 if (!strcmp(param[i].field, NAME)) { \
448 binfo->FIELD = param[i].value.l; \
452 static int get_block_info(struct lv_block_info *binfo,
453 virTypedParameterPtr param, int nparams) {
454 if (binfo == NULL || param == NULL)
457 for (int i = 0; i < nparams; ++i) {
458 /* ignore type. Everything must be LLONG anyway. */
459 GET_BLOCK_INFO_VALUE("rd_operations", bi.rd_req);
460 GET_BLOCK_INFO_VALUE("wr_operations", bi.wr_req);
461 GET_BLOCK_INFO_VALUE("rd_bytes", bi.rd_bytes);
462 GET_BLOCK_INFO_VALUE("wr_bytes", bi.wr_bytes);
463 GET_BLOCK_INFO_VALUE("rd_total_times", rd_total_times);
464 GET_BLOCK_INFO_VALUE("wr_total_times", wr_total_times);
465 GET_BLOCK_INFO_VALUE("flush_operations", fl_req);
466 GET_BLOCK_INFO_VALUE("flush_total_times", fl_total_times);
472 #undef GET_BLOCK_INFO_VALUE
474 #endif /* HAVE_BLOCK_STATS_FLAGS */
476 /* ERROR(...) macro for virterrors. */
477 #define VIRT_ERROR(conn, s) \
480 err = (conn) ? virConnGetLastError((conn)) : virGetLastError(); \
482 ERROR("%s: %s", (s), err->message); \
485 static void init_lv_info(struct lv_info *info) {
487 memset(info, 0, sizeof(*info));
490 static int lv_domain_info(virDomainPtr dom, struct lv_info *info) {
491 #ifdef HAVE_CPU_STATS
492 virTypedParameterPtr param = NULL;
494 #endif /* HAVE_CPU_STATS */
495 int ret = virDomainGetInfo(dom, &(info->di));
500 #ifdef HAVE_CPU_STATS
501 nparams = virDomainGetCPUStats(dom, NULL, 0, -1, 1, 0);
503 VIRT_ERROR(conn, "getting the CPU params count");
507 param = calloc(nparams, sizeof(virTypedParameter));
509 ERROR("virt plugin: alloc(%i) for cpu parameters failed.", nparams);
513 ret = virDomainGetCPUStats(dom, param, nparams, -1, 1, 0); // total stats.
515 virTypedParamsClear(param, nparams);
517 VIRT_ERROR(conn, "getting the disk params values");
521 for (int i = 0; i < nparams; ++i) {
522 if (!strcmp(param[i].field, "user_time"))
523 info->total_user_cpu_time = param[i].value.ul;
524 else if (!strcmp(param[i].field, "system_time"))
525 info->total_syst_cpu_time = param[i].value.ul;
528 virTypedParamsClear(param, nparams);
530 #endif /* HAVE_CPU_STATS */
535 static void init_value_list(value_list_t *vl, virDomainPtr dom) {
538 char uuid[VIR_UUID_STRING_BUFLEN];
540 sstrncpy(vl->plugin, PLUGIN_NAME, sizeof(vl->plugin));
544 /* Construct the hostname field according to HostnameFormat. */
545 for (int i = 0; i < HF_MAX_FIELDS; ++i) {
546 if (hostname_format[i] == hf_none)
549 n = DATA_MAX_NAME_LEN - strlen(vl->host) - 2;
551 if (i > 0 && n >= 1) {
552 strncat(vl->host, ":", 1);
556 switch (hostname_format[i]) {
560 strncat(vl->host, hostname_g, n);
563 name = virDomainGetName(dom);
565 strncat(vl->host, name, n);
568 if (virDomainGetUUIDString(dom, uuid) == 0)
569 strncat(vl->host, uuid, n);
574 vl->host[sizeof(vl->host) - 1] = '\0';
576 /* Construct the plugin instance field according to PluginInstanceFormat. */
577 for (int i = 0; i < PLGINST_MAX_FIELDS; ++i) {
578 if (plugin_instance_format[i] == plginst_none)
581 n = sizeof(vl->plugin_instance) - strlen(vl->plugin_instance) - 2;
583 if (i > 0 && n >= 1) {
584 strncat(vl->plugin_instance, ":", 1);
588 switch (plugin_instance_format[i]) {
592 name = virDomainGetName(dom);
594 strncat(vl->plugin_instance, name, n);
597 if (virDomainGetUUIDString(dom, uuid) == 0)
598 strncat(vl->plugin_instance, uuid, n);
603 vl->plugin_instance[sizeof(vl->plugin_instance) - 1] = '\0';
605 } /* void init_value_list */
607 static int init_notif(notification_t *notif, const virDomainPtr domain,
608 int severity, const char *msg, const char *type,
609 const char *type_instance) {
610 value_list_t vl = VALUE_LIST_INIT;
613 ERROR(PLUGIN_NAME ": init_notif: NULL pointer");
617 init_value_list(&vl, domain);
618 notification_init(notif, severity, msg, vl.host, vl.plugin,
619 vl.plugin_instance, type, type_instance);
620 notif->time = cdtime();
624 static void submit_notif(const virDomainPtr domain, int severity,
625 const char *msg, const char *type,
626 const char *type_instance) {
627 notification_t notif;
629 init_notif(¬if, domain, severity, msg, type, type_instance);
630 plugin_dispatch_notification(¬if);
632 plugin_notification_meta_free(notif.meta);
635 static void submit(virDomainPtr dom, char const *type,
636 char const *type_instance, value_t *values,
638 value_list_t vl = VALUE_LIST_INIT;
639 init_value_list(&vl, dom);
642 vl.values_len = values_len;
644 sstrncpy(vl.type, type, sizeof(vl.type));
645 if (type_instance != NULL)
646 sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
648 plugin_dispatch_values(&vl);
651 static void memory_submit(virDomainPtr dom, gauge_t value) {
652 submit(dom, "memory", "total", &(value_t){.gauge = value}, 1);
655 static void memory_stats_submit(gauge_t value, virDomainPtr dom,
657 static const char *tags[] = {"swap_in", "swap_out", "major_fault",
658 "minor_fault", "unused", "available",
659 "actual_balloon", "rss", "usable",
662 if ((tag_index < 0) || (tag_index >= (int)STATIC_ARRAY_SIZE(tags))) {
663 ERROR("virt plugin: Array index out of bounds: tag_index = %d", tag_index);
667 submit(dom, "memory", tags[tag_index], &(value_t){.gauge = value}, 1);
670 static void submit_derive2(const char *type, derive_t v0, derive_t v1,
671 virDomainPtr dom, const char *devname) {
673 {.derive = v0}, {.derive = v1},
676 submit(dom, type, devname, values, STATIC_ARRAY_SIZE(values));
677 } /* void submit_derive2 */
679 static void pcpu_submit(virDomainPtr dom, struct lv_info *info) {
680 #ifdef HAVE_CPU_STATS
681 if (extra_stats & ex_stats_pcpu)
682 submit_derive2("ps_cputime", info->total_user_cpu_time,
683 info->total_syst_cpu_time, dom, NULL);
684 #endif /* HAVE_CPU_STATS */
687 static double cpu_ns_to_percent(unsigned int node_cpus,
688 unsigned long long cpu_time_old,
689 unsigned long long cpu_time_new) {
690 double percent = 0.0;
691 unsigned long long cpu_time_diff = 0;
692 double time_diff_sec = CDTIME_T_TO_DOUBLE(plugin_get_interval());
694 if (node_cpus != 0 && time_diff_sec != 0 && cpu_time_old != 0) {
695 cpu_time_diff = cpu_time_new - cpu_time_old;
696 percent = ((double)(100 * cpu_time_diff)) /
697 (time_diff_sec * node_cpus * NANOSEC_IN_SEC);
700 DEBUG(PLUGIN_NAME ": node_cpus=%u cpu_time_old=%" PRIu64
701 " cpu_time_new=%" PRIu64 "cpu_time_diff=%" PRIu64
702 " time_diff_sec=%f percent=%f",
703 node_cpus, (uint64_t)cpu_time_old, (uint64_t)cpu_time_new,
704 (uint64_t)cpu_time_diff, time_diff_sec, percent);
709 static void cpu_submit(const domain_t *dom, unsigned long long cpuTime_new) {
714 if (extra_stats & ex_stats_cpu_util) {
715 /* Computing %CPU requires 2 samples of cpuTime */
716 if (dom->info.cpuTime != 0 && cpuTime_new != 0) {
718 submit(dom->ptr, "percent", "virt_cpu_total",
719 &(value_t){.gauge = cpu_ns_to_percent(
720 nodeinfo.cpus, dom->info.cpuTime, cpuTime_new)},
725 submit(dom->ptr, "virt_cpu_total", NULL, &(value_t){.derive = cpuTime_new},
729 static void vcpu_submit(derive_t value, virDomainPtr dom, int vcpu_nr,
731 char type_instance[DATA_MAX_NAME_LEN];
733 snprintf(type_instance, sizeof(type_instance), "%d", vcpu_nr);
734 submit(dom, type, type_instance, &(value_t){.derive = value}, 1);
737 static void disk_submit(struct lv_block_info *binfo, virDomainPtr dom,
739 char *dev_copy = strdup(dev);
740 const char *type_instance = dev_copy;
745 if (blockdevice_format_basename && blockdevice_format == source)
746 type_instance = basename(dev_copy);
748 if (!type_instance) {
753 char flush_type_instance[DATA_MAX_NAME_LEN];
754 snprintf(flush_type_instance, sizeof(flush_type_instance), "flush-%s",
757 if ((binfo->bi.rd_req != -1) && (binfo->bi.wr_req != -1))
758 submit_derive2("disk_ops", (derive_t)binfo->bi.rd_req,
759 (derive_t)binfo->bi.wr_req, dom, type_instance);
761 if ((binfo->bi.rd_bytes != -1) && (binfo->bi.wr_bytes != -1))
762 submit_derive2("disk_octets", (derive_t)binfo->bi.rd_bytes,
763 (derive_t)binfo->bi.wr_bytes, dom, type_instance);
765 if (extra_stats & ex_stats_disk) {
766 if ((binfo->rd_total_times != -1) && (binfo->wr_total_times != -1))
767 submit_derive2("disk_time", (derive_t)binfo->rd_total_times,
768 (derive_t)binfo->wr_total_times, dom, type_instance);
770 if (binfo->fl_req != -1)
771 submit(dom, "total_requests", flush_type_instance,
772 &(value_t){.derive = (derive_t)binfo->fl_req}, 1);
773 if (binfo->fl_total_times != -1) {
774 derive_t value = binfo->fl_total_times / 1000; // ns -> ms
775 submit(dom, "total_time_in_ms", flush_type_instance,
776 &(value_t){.derive = value}, 1);
783 static unsigned int parse_ex_stats_flags(char **exstats, int numexstats) {
784 unsigned int ex_stats_flags = ex_stats_none;
785 for (int i = 0; i < numexstats; i++) {
786 for (int j = 0; ex_stats_table[j].name != NULL; j++) {
787 if (strcasecmp(exstats[i], ex_stats_table[j].name) == 0) {
788 DEBUG(PLUGIN_NAME " plugin: enabling extra stats for '%s'",
789 ex_stats_table[j].name);
790 ex_stats_flags |= ex_stats_table[j].flag;
794 if (ex_stats_table[j + 1].name == NULL) {
795 ERROR(PLUGIN_NAME ": Unmatched ExtraStats option: %s", exstats[i]);
799 return ex_stats_flags;
802 static void domain_state_submit(virDomainPtr dom, int state, int reason) {
804 if ((state < 0) || (state >= STATIC_ARRAY_SIZE(domain_states))) {
805 ERROR(PLUGIN_NAME ": Array index out of bounds: state=%d", state);
809 char msg[DATA_MAX_NAME_LEN];
810 const char *state_str = domain_states[state];
811 #ifdef HAVE_DOM_REASON
812 if ((reason < 0) || (reason >= STATIC_ARRAY_SIZE(domain_reasons[0]))) {
813 ERROR(PLUGIN_NAME ": Array index out of bounds: reason=%d", reason);
817 const char *reason_str = domain_reasons[state][reason];
818 /* Array size for domain reasons is fixed, but different domain states can
819 * have different number of reasons. We need to check if reason was
820 * successfully parsed */
822 ERROR(PLUGIN_NAME ": Invalid reason (%d) for domain state: %s", reason,
827 const char *reason_str = "N/A";
830 snprintf(msg, sizeof(msg), "Domain state: %s. Reason: %s", state_str,
835 case VIR_DOMAIN_NOSTATE:
836 case VIR_DOMAIN_RUNNING:
837 case VIR_DOMAIN_SHUTDOWN:
838 case VIR_DOMAIN_SHUTOFF:
839 severity = NOTIF_OKAY;
841 case VIR_DOMAIN_BLOCKED:
842 case VIR_DOMAIN_PAUSED:
843 #ifdef DOM_STATE_PMSUSPENDED
844 case VIR_DOMAIN_PMSUSPENDED:
846 severity = NOTIF_WARNING;
848 case VIR_DOMAIN_CRASHED:
849 severity = NOTIF_FAILURE;
852 ERROR(PLUGIN_NAME ": Unrecognized domain state (%d)", state);
855 submit_notif(dom, severity, msg, "domain_state", NULL);
858 static int lv_config(const char *key, const char *value) {
859 if (virInitialize() != 0)
862 if (il_domains == NULL)
863 il_domains = ignorelist_create(1);
864 if (il_block_devices == NULL)
865 il_block_devices = ignorelist_create(1);
866 if (il_interface_devices == NULL)
867 il_interface_devices = ignorelist_create(1);
869 if (strcasecmp(key, "Connection") == 0) {
870 char *tmp = strdup(value);
872 ERROR(PLUGIN_NAME " plugin: Connection strdup failed.");
880 if (strcasecmp(key, "RefreshInterval") == 0) {
882 interval = strtol(value, &eptr, 10);
883 if (eptr == NULL || *eptr != '\0')
888 if (strcasecmp(key, "Domain") == 0) {
889 if (ignorelist_add(il_domains, value))
893 if (strcasecmp(key, "BlockDevice") == 0) {
894 if (ignorelist_add(il_block_devices, value))
899 if (strcasecmp(key, "BlockDeviceFormat") == 0) {
900 if (strcasecmp(value, "target") == 0)
901 blockdevice_format = target;
902 else if (strcasecmp(value, "source") == 0)
903 blockdevice_format = source;
905 ERROR(PLUGIN_NAME " plugin: unknown BlockDeviceFormat: %s", value);
910 if (strcasecmp(key, "BlockDeviceFormatBasename") == 0) {
911 blockdevice_format_basename = IS_TRUE(value);
914 if (strcasecmp(key, "InterfaceDevice") == 0) {
915 if (ignorelist_add(il_interface_devices, value))
920 if (strcasecmp(key, "IgnoreSelected") == 0) {
921 if (IS_TRUE(value)) {
922 ignorelist_set_invert(il_domains, 0);
923 ignorelist_set_invert(il_block_devices, 0);
924 ignorelist_set_invert(il_interface_devices, 0);
926 ignorelist_set_invert(il_domains, 1);
927 ignorelist_set_invert(il_block_devices, 1);
928 ignorelist_set_invert(il_interface_devices, 1);
933 if (strcasecmp(key, "HostnameFormat") == 0) {
935 char *fields[HF_MAX_FIELDS];
938 value_copy = strdup(value);
939 if (value_copy == NULL) {
940 ERROR(PLUGIN_NAME " plugin: strdup failed.");
944 n = strsplit(value_copy, fields, HF_MAX_FIELDS);
947 ERROR(PLUGIN_NAME " plugin: HostnameFormat: no fields");
951 for (int i = 0; i < n; ++i) {
952 if (strcasecmp(fields[i], "hostname") == 0)
953 hostname_format[i] = hf_hostname;
954 else if (strcasecmp(fields[i], "name") == 0)
955 hostname_format[i] = hf_name;
956 else if (strcasecmp(fields[i], "uuid") == 0)
957 hostname_format[i] = hf_uuid;
959 ERROR(PLUGIN_NAME " plugin: unknown HostnameFormat field: %s",
967 for (int i = n; i < HF_MAX_FIELDS; ++i)
968 hostname_format[i] = hf_none;
973 if (strcasecmp(key, "PluginInstanceFormat") == 0) {
975 char *fields[PLGINST_MAX_FIELDS];
978 value_copy = strdup(value);
979 if (value_copy == NULL) {
980 ERROR(PLUGIN_NAME " plugin: strdup failed.");
984 n = strsplit(value_copy, fields, PLGINST_MAX_FIELDS);
987 ERROR(PLUGIN_NAME " plugin: PluginInstanceFormat: no fields");
991 for (int i = 0; i < n; ++i) {
992 if (strcasecmp(fields[i], "none") == 0) {
993 plugin_instance_format[i] = plginst_none;
995 } else if (strcasecmp(fields[i], "name") == 0)
996 plugin_instance_format[i] = plginst_name;
997 else if (strcasecmp(fields[i], "uuid") == 0)
998 plugin_instance_format[i] = plginst_uuid;
1000 ERROR(PLUGIN_NAME " plugin: unknown PluginInstanceFormat field: %s",
1008 for (int i = n; i < PLGINST_MAX_FIELDS; ++i)
1009 plugin_instance_format[i] = plginst_none;
1014 if (strcasecmp(key, "InterfaceFormat") == 0) {
1015 if (strcasecmp(value, "name") == 0)
1016 interface_format = if_name;
1017 else if (strcasecmp(value, "address") == 0)
1018 interface_format = if_address;
1019 else if (strcasecmp(value, "number") == 0)
1020 interface_format = if_number;
1022 ERROR(PLUGIN_NAME " plugin: unknown InterfaceFormat: %s", value);
1028 if (strcasecmp(key, "Instances") == 0) {
1030 double val = strtod(value, &eptr);
1032 if (*eptr != '\0') {
1033 ERROR(PLUGIN_NAME " plugin: Invalid value for Instances = '%s'", value);
1037 ERROR(PLUGIN_NAME " plugin: Instances <= 0 makes no sense.");
1040 if (val > NR_INSTANCES_MAX) {
1041 ERROR(PLUGIN_NAME " plugin: Instances=%f > NR_INSTANCES_MAX=%i"
1042 " use a lower setting or recompile the plugin.",
1043 val, NR_INSTANCES_MAX);
1047 nr_instances = (int)val;
1048 DEBUG(PLUGIN_NAME " plugin: configured %i instances", nr_instances);
1052 if (strcasecmp(key, "ExtraStats") == 0) {
1053 char *localvalue = strdup(value);
1054 if (localvalue != NULL) {
1055 char *exstats[EX_STATS_MAX_FIELDS];
1057 strsplit(localvalue, exstats, STATIC_ARRAY_SIZE(exstats));
1058 extra_stats = parse_ex_stats_flags(exstats, numexstats);
1061 #ifdef HAVE_JOB_STATS
1062 if ((extra_stats & ex_stats_job_stats_completed) &&
1063 (extra_stats & ex_stats_job_stats_background)) {
1064 ERROR(PLUGIN_NAME " plugin: Invalid job stats configuration. Only one "
1065 "type of job statistics can be collected at the same "
1073 /* Unrecognised option. */
1077 static int lv_connect(void) {
1079 /* `conn_string == NULL' is acceptable */
1081 /* virDomainGetFSInfo requires full read-write access connection */
1082 if (extra_stats & ex_stats_fs_info)
1083 conn = virConnectOpen(conn_string);
1086 conn = virConnectOpenReadOnly(conn_string);
1088 c_complain(LOG_ERR, &conn_complain,
1089 PLUGIN_NAME " plugin: Unable to connect: "
1090 "virConnectOpen failed.");
1093 int status = virNodeGetInfo(conn, &nodeinfo);
1095 ERROR(PLUGIN_NAME ": virNodeGetInfo failed");
1099 c_release(LOG_NOTICE, &conn_complain,
1100 PLUGIN_NAME " plugin: Connection established.");
1104 static void lv_disconnect(void) {
1106 virConnectClose(conn);
1108 WARNING(PLUGIN_NAME " plugin: closed connection to libvirt");
1111 static int lv_domain_block_info(virDomainPtr dom, const char *path,
1112 struct lv_block_info *binfo) {
1113 #ifdef HAVE_BLOCK_STATS_FLAGS
1115 if (virDomainBlockStatsFlags(dom, path, NULL, &nparams, 0) < 0 ||
1117 VIRT_ERROR(conn, "getting the disk params count");
1121 virTypedParameterPtr params = calloc((size_t)nparams, sizeof(*params));
1122 if (params == NULL) {
1123 ERROR("virt plugin: alloc(%i) for block=%s parameters failed.", nparams,
1129 if (virDomainBlockStatsFlags(dom, path, params, &nparams, 0) < 0) {
1130 VIRT_ERROR(conn, "getting the disk params values");
1132 rc = get_block_info(binfo, params, nparams);
1135 virTypedParamsClear(params, nparams);
1139 return virDomainBlockStats(dom, path, &(binfo->bi), sizeof(binfo->bi));
1140 #endif /* HAVE_BLOCK_STATS_FLAGS */
1143 #ifdef HAVE_PERF_STATS
1144 static void perf_submit(virDomainStatsRecordPtr stats) {
1145 for (int i = 0; i < stats->nparams; ++i) {
1146 /* Replace '.' with '_' in event field to match other metrics' naming
1148 char *c = strchr(stats->params[i].field, '.');
1151 submit(stats->dom, "perf", stats->params[i].field,
1152 &(value_t){.derive = stats->params[i].value.ul}, 1);
1156 static int get_perf_events(virDomainPtr domain) {
1157 virDomainStatsRecordPtr *stats = NULL;
1158 /* virDomainListGetStats requires a NULL terminated list of domains */
1159 virDomainPtr domain_array[] = {domain, NULL};
1162 virDomainListGetStats(domain_array, VIR_DOMAIN_STATS_PERF, &stats, 0);
1164 ERROR("virt plugin: virDomainListGetStats failed with status %i.", status);
1168 for (int i = 0; i < status; ++i)
1169 perf_submit(stats[i]);
1171 virDomainStatsRecordListFree(stats);
1174 #endif /* HAVE_PERF_STATS */
1176 static void vcpu_pin_submit(virDomainPtr dom, int max_cpus, int vcpu,
1177 unsigned char *cpu_maps, int cpu_map_len) {
1178 for (int cpu = 0; cpu < max_cpus; ++cpu) {
1179 char type_instance[DATA_MAX_NAME_LEN];
1180 _Bool is_set = VIR_CPU_USABLE(cpu_maps, cpu_map_len, vcpu, cpu) ? 1 : 0;
1182 snprintf(type_instance, sizeof(type_instance), "vcpu_%d-cpu_%d", vcpu, cpu);
1183 submit(dom, "cpu_affinity", type_instance, &(value_t){.gauge = is_set}, 1);
1187 static int get_vcpu_stats(virDomainPtr domain, unsigned short nr_virt_cpu) {
1188 int max_cpus = VIR_NODEINFO_MAXCPUS(nodeinfo);
1189 int cpu_map_len = VIR_CPU_MAPLEN(max_cpus);
1191 virVcpuInfoPtr vinfo = calloc(nr_virt_cpu, sizeof(vinfo[0]));
1192 if (vinfo == NULL) {
1193 ERROR(PLUGIN_NAME " plugin: malloc failed.");
1197 unsigned char *cpumaps = calloc(nr_virt_cpu, cpu_map_len);
1198 if (cpumaps == NULL) {
1199 ERROR(PLUGIN_NAME " plugin: malloc failed.");
1205 virDomainGetVcpus(domain, vinfo, nr_virt_cpu, cpumaps, cpu_map_len);
1207 ERROR(PLUGIN_NAME " plugin: virDomainGetVcpus failed with status %i.",
1214 for (int i = 0; i < nr_virt_cpu; ++i) {
1215 vcpu_submit(vinfo[i].cpuTime, domain, vinfo[i].number, "virt_vcpu");
1216 if (extra_stats & ex_stats_vcpupin)
1217 vcpu_pin_submit(domain, max_cpus, i, cpumaps, cpu_map_len);
1225 #ifdef HAVE_DOM_REASON
1226 static int get_domain_state(virDomainPtr domain) {
1227 int domain_state = 0;
1228 int domain_reason = 0;
1230 int status = virDomainGetState(domain, &domain_state, &domain_reason, 0);
1232 ERROR(PLUGIN_NAME " plugin: virDomainGetState failed with status %i.",
1237 domain_state_submit(domain, domain_state, domain_reason);
1240 #endif /* HAVE_DOM_REASON */
1242 static int get_memory_stats(virDomainPtr domain) {
1243 virDomainMemoryStatPtr minfo =
1244 calloc(VIR_DOMAIN_MEMORY_STAT_NR, sizeof(virDomainMemoryStatStruct));
1245 if (minfo == NULL) {
1246 ERROR("virt plugin: malloc failed.");
1251 virDomainMemoryStats(domain, minfo, VIR_DOMAIN_MEMORY_STAT_NR, 0);
1252 if (mem_stats < 0) {
1253 ERROR("virt plugin: virDomainMemoryStats failed with mem_stats %i.",
1259 for (int i = 0; i < mem_stats; i++)
1260 memory_stats_submit((gauge_t)minfo[i].val * 1024, domain, minfo[i].tag);
1266 #ifdef HAVE_DISK_ERR
1267 static void disk_err_submit(virDomainPtr domain,
1268 virDomainDiskErrorPtr disk_err) {
1269 submit(domain, "disk_error", disk_err->disk,
1270 &(value_t){.gauge = disk_err->error}, 1);
1273 static int get_disk_err(virDomainPtr domain) {
1274 /* Get preferred size of disk errors array */
1275 int disk_err_count = virDomainGetDiskErrors(domain, NULL, 0, 0);
1276 if (disk_err_count == -1) {
1278 " plugin: failed to get preferred size of disk errors array");
1283 " plugin: preferred size of disk errors array: %d for domain %s",
1284 disk_err_count, virDomainGetName(domain));
1285 virDomainDiskError disk_err[disk_err_count];
1287 disk_err_count = virDomainGetDiskErrors(domain, disk_err, disk_err_count, 0);
1288 if (disk_err_count == -1) {
1289 ERROR(PLUGIN_NAME " plugin: virDomainGetDiskErrors failed with status %d",
1294 DEBUG(PLUGIN_NAME " plugin: detected %d disk errors in domain %s",
1295 disk_err_count, virDomainGetName(domain));
1297 for (int i = 0; i < disk_err_count; ++i) {
1298 disk_err_submit(domain, &disk_err[i]);
1299 sfree(disk_err[i].disk);
1304 #endif /* HAVE_DISK_ERR */
1306 static int get_block_stats(struct block_device *block_dev) {
1309 ERROR(PLUGIN_NAME " plugin: get_block_stats NULL pointer");
1313 struct lv_block_info binfo;
1314 init_block_info(&binfo);
1316 if (lv_domain_block_info(block_dev->dom, block_dev->path, &binfo) < 0) {
1317 ERROR(PLUGIN_NAME " plugin: lv_domain_block_info failed");
1321 disk_submit(&binfo, block_dev->dom, block_dev->path);
1327 #define NM_ADD_ITEM(_fun, _name, _val) \
1329 ret = _fun(¬if, _name, _val); \
1331 ERROR(PLUGIN_NAME " plugin: failed to add notification metadata"); \
1336 #define NM_ADD_STR_ITEMS(_items, _size) \
1338 for (int _i = 0; _i < _size; ++_i) { \
1340 " plugin: Adding notification metadata name=%s value=%s", \
1341 _items[_i].name, _items[_i].value); \
1342 NM_ADD_ITEM(plugin_notification_meta_add_string, _items[_i].name, \
1343 _items[_i].value); \
1347 static int fs_info_notify(virDomainPtr domain, virDomainFSInfoPtr fs_info) {
1348 notification_t notif;
1351 /* Local struct, just for the purpose of this function. */
1352 typedef struct nm_str_item_s {
1357 nm_str_item_t fs_dev_alias[fs_info->ndevAlias];
1358 nm_str_item_t fs_str_items[] = {
1359 {.name = "mountpoint", .value = fs_info->mountpoint},
1360 {.name = "name", .value = fs_info->name},
1361 {.name = "fstype", .value = fs_info->fstype}};
1363 for (int i = 0; i < fs_info->ndevAlias; ++i) {
1364 fs_dev_alias[i].name = "devAlias";
1365 fs_dev_alias[i].value = fs_info->devAlias[i];
1368 init_notif(¬if, domain, NOTIF_OKAY, "File system information",
1369 "file_system", NULL);
1370 NM_ADD_STR_ITEMS(fs_str_items, STATIC_ARRAY_SIZE(fs_str_items));
1371 NM_ADD_ITEM(plugin_notification_meta_add_unsigned_int, "ndevAlias",
1372 fs_info->ndevAlias);
1373 NM_ADD_STR_ITEMS(fs_dev_alias, fs_info->ndevAlias);
1375 plugin_dispatch_notification(¬if);
1379 plugin_notification_meta_free(notif.meta);
1383 #undef RETURN_ON_ERR
1384 #undef NM_ADD_STR_ITEMS
1386 static int get_fs_info(virDomainPtr domain) {
1387 virDomainFSInfoPtr *fs_info = NULL;
1390 int mount_points_cnt = virDomainGetFSInfo(domain, &fs_info, 0);
1391 if (mount_points_cnt == -1) {
1392 ERROR(PLUGIN_NAME " plugin: virDomainGetFSInfo failed: %d",
1394 return mount_points_cnt;
1397 for (int i = 0; i < mount_points_cnt; ++i) {
1398 if (fs_info_notify(domain, fs_info[i]) != 0) {
1399 ERROR(PLUGIN_NAME " plugin: failed to send file system notification "
1400 "for mount point %s",
1401 fs_info[i]->mountpoint);
1404 virDomainFSInfoFree(fs_info[i]);
1411 #endif /* HAVE_FS_INFO */
1413 #ifdef HAVE_JOB_STATS
1414 static void job_stats_submit(virDomainPtr domain, virTypedParameterPtr param) {
1417 if (param->type == VIR_TYPED_PARAM_INT)
1418 vl.derive = param->value.i;
1419 else if (param->type == VIR_TYPED_PARAM_UINT)
1420 vl.derive = param->value.ui;
1421 else if (param->type == VIR_TYPED_PARAM_LLONG)
1422 vl.derive = param->value.l;
1423 else if (param->type == VIR_TYPED_PARAM_ULLONG)
1424 vl.derive = param->value.ul;
1425 else if (param->type == VIR_TYPED_PARAM_DOUBLE)
1426 vl.derive = param->value.d;
1427 else if (param->type == VIR_TYPED_PARAM_BOOLEAN)
1428 vl.derive = param->value.b;
1429 else if (param->type == VIR_TYPED_PARAM_STRING) {
1430 submit_notif(domain, NOTIF_OKAY, param->value.s, "job_stats", param->field);
1433 ERROR(PLUGIN_NAME " plugin: unrecognized virTypedParameterType");
1437 submit(domain, "job_stats", param->field, &vl, 1);
1440 static int get_job_stats(virDomainPtr domain) {
1444 virTypedParameterPtr params = NULL;
1445 int flags = (extra_stats & ex_stats_job_stats_completed)
1446 ? VIR_DOMAIN_JOB_STATS_COMPLETED
1449 ret = virDomainGetJobStats(domain, &job_type, ¶ms, &nparams, flags);
1451 ERROR(PLUGIN_NAME " plugin: virDomainGetJobStats failed: %d", ret);
1455 DEBUG(PLUGIN_NAME " plugin: job_type=%d nparams=%d", job_type, nparams);
1457 for (int i = 0; i < nparams; ++i) {
1458 DEBUG(PLUGIN_NAME " plugin: param[%d] field=%s type=%d", i, params[i].field,
1460 job_stats_submit(domain, ¶ms[i]);
1463 virTypedParamsFree(params, nparams);
1466 #endif /* HAVE_JOB_STATS */
1468 static int get_domain_metrics(domain_t *domain) {
1469 struct lv_info info;
1471 if (!domain || !domain->ptr) {
1472 ERROR(PLUGIN_NAME ": get_domain_metrics: NULL pointer");
1476 init_lv_info(&info);
1477 int status = lv_domain_info(domain->ptr, &info);
1479 ERROR(PLUGIN_NAME " plugin: virDomainGetInfo failed with status %i.",
1484 if (extra_stats & ex_stats_domain_state) {
1485 #ifdef HAVE_DOM_REASON
1486 /* At this point we already know domain's state from virDomainGetInfo call,
1487 * however it doesn't provide a reason for entering particular state.
1488 * We need to get it from virDomainGetState.
1490 GET_STATS(get_domain_state, "domain reason", domain->ptr);
1492 /* virDomainGetState is not available. Submit 0, which corresponds to
1493 * unknown reason. */
1494 domain_state_submit(domain->ptr, info.di.state, 0);
1498 /* Gather remaining stats only for running domains */
1499 if (info.di.state != VIR_DOMAIN_RUNNING)
1502 pcpu_submit(domain->ptr, &info);
1503 cpu_submit(domain, info.di.cpuTime);
1505 memory_submit(domain->ptr, (gauge_t)info.di.memory * 1024);
1507 GET_STATS(get_vcpu_stats, "vcpu stats", domain->ptr, info.di.nrVirtCpu);
1508 GET_STATS(get_memory_stats, "memory stats", domain->ptr);
1510 #ifdef HAVE_PERF_STATS
1511 if (extra_stats & ex_stats_perf)
1512 GET_STATS(get_perf_events, "performance monitoring events", domain->ptr);
1516 if (extra_stats & ex_stats_fs_info)
1517 GET_STATS(get_fs_info, "file system info", domain->ptr);
1520 #ifdef HAVE_DISK_ERR
1521 if (extra_stats & ex_stats_disk_err)
1522 GET_STATS(get_disk_err, "disk errors", domain->ptr);
1525 #ifdef HAVE_JOB_STATS
1527 (ex_stats_job_stats_completed | ex_stats_job_stats_background))
1528 GET_STATS(get_job_stats, "job stats", domain->ptr);
1531 /* Update cached virDomainInfo. It has to be done after cpu_submit */
1532 memcpy(&domain->info, &info.di, sizeof(domain->info));
1536 static int get_if_dev_stats(struct interface_device *if_dev) {
1537 virDomainInterfaceStatsStruct stats = {0};
1538 char *display_name = NULL;
1541 ERROR(PLUGIN_NAME " plugin: get_if_dev_stats: NULL pointer");
1545 switch (interface_format) {
1547 display_name = if_dev->address;
1550 display_name = if_dev->number;
1554 display_name = if_dev->path;
1557 if (virDomainInterfaceStats(if_dev->dom, if_dev->path, &stats,
1558 sizeof(stats)) != 0) {
1559 ERROR(PLUGIN_NAME " plugin: virDomainInterfaceStats failed");
1563 if ((stats.rx_bytes != -1) && (stats.tx_bytes != -1))
1564 submit_derive2("if_octets", (derive_t)stats.rx_bytes,
1565 (derive_t)stats.tx_bytes, if_dev->dom, display_name);
1567 if ((stats.rx_packets != -1) && (stats.tx_packets != -1))
1568 submit_derive2("if_packets", (derive_t)stats.rx_packets,
1569 (derive_t)stats.tx_packets, if_dev->dom, display_name);
1571 if ((stats.rx_errs != -1) && (stats.tx_errs != -1))
1572 submit_derive2("if_errors", (derive_t)stats.rx_errs,
1573 (derive_t)stats.tx_errs, if_dev->dom, display_name);
1575 if ((stats.rx_drop != -1) && (stats.tx_drop != -1))
1576 submit_derive2("if_dropped", (derive_t)stats.rx_drop,
1577 (derive_t)stats.tx_drop, if_dev->dom, display_name);
1581 static int lv_read(user_data_t *ud) {
1583 struct lv_read_instance *inst = NULL;
1584 struct lv_read_state *state = NULL;
1586 if (ud->data == NULL) {
1587 ERROR(PLUGIN_NAME " plugin: NULL userdata");
1592 state = &inst->read_state;
1594 if (inst->id == 0) {
1595 if (lv_connect() < 0)
1601 /* Need to refresh domain or device lists? */
1602 if ((last_refresh == (time_t)0) ||
1603 ((interval > 0) && ((last_refresh + interval) <= t))) {
1604 if (refresh_lists(inst) != 0) {
1613 for (int i = 0; i < nr_domains; ++i)
1614 fprintf (stderr, "domain %s\n", virDomainGetName (state->domains[i].ptr));
1615 for (int i = 0; i < nr_block_devices; ++i)
1616 fprintf (stderr, "block device %d %s:%s\n",
1617 i, virDomainGetName (block_devices[i].dom),
1618 block_devices[i].path);
1619 for (int i = 0; i < nr_interface_devices; ++i)
1620 fprintf (stderr, "interface device %d %s:%s\n",
1621 i, virDomainGetName (interface_devices[i].dom),
1622 interface_devices[i].path);
1625 /* Get domains' metrics */
1626 for (int i = 0; i < state->nr_domains; ++i) {
1627 int status = get_domain_metrics(&state->domains[i]);
1629 ERROR(PLUGIN_NAME " failed to get metrics for domain=%s",
1630 virDomainGetName(state->domains[i].ptr));
1633 /* Get block device stats for each domain. */
1634 for (int i = 0; i < state->nr_block_devices; ++i) {
1635 int status = get_block_stats(&state->block_devices[i]);
1638 " failed to get stats for block device (%s) in domain %s",
1639 state->block_devices[i].path,
1640 virDomainGetName(state->domains[i].ptr));
1643 /* Get interface stats for each domain. */
1644 for (int i = 0; i < state->nr_interface_devices; ++i) {
1645 int status = get_if_dev_stats(&state->interface_devices[i]);
1648 " failed to get interface stats for device (%s) in domain %s",
1649 state->interface_devices[i].path,
1650 virDomainGetName(state->interface_devices[i].dom));
1656 static int lv_init_instance(size_t i, plugin_read_cb callback) {
1657 struct lv_user_data *lv_ud = &(lv_read_user_data[i]);
1658 struct lv_read_instance *inst = &(lv_ud->inst);
1660 memset(lv_ud, 0, sizeof(*lv_ud));
1662 snprintf(inst->tag, sizeof(inst->tag), "%s-%" PRIsz, PLUGIN_NAME, i);
1665 user_data_t *ud = &(lv_ud->ud);
1667 ud->free_func = NULL;
1669 INFO(PLUGIN_NAME " plugin: reader %s initialized", inst->tag);
1670 return plugin_register_complex_read(NULL, inst->tag, callback, 0, ud);
1673 static void lv_clean_read_state(struct lv_read_state *state) {
1674 free_block_devices(state);
1675 free_interface_devices(state);
1676 free_domains(state);
1679 static void lv_fini_instance(size_t i) {
1680 struct lv_read_instance *inst = &(lv_read_user_data[i].inst);
1681 struct lv_read_state *state = &(inst->read_state);
1683 lv_clean_read_state(state);
1684 INFO(PLUGIN_NAME " plugin: reader %s finalized", inst->tag);
1687 static int lv_init(void) {
1688 if (virInitialize() != 0)
1691 if (lv_connect() != 0)
1694 DEBUG(PLUGIN_NAME " plugin: starting %i instances", nr_instances);
1696 for (int i = 0; i < nr_instances; ++i)
1697 lv_init_instance(i, lv_read);
1703 * returns 0 on success and <0 on error
1705 static int lv_domain_get_tag(xmlXPathContextPtr xpath_ctx, const char *dom_name,
1707 char xpath_str[BUFFER_MAX_LEN] = {'\0'};
1708 xmlXPathObjectPtr xpath_obj = NULL;
1709 xmlNodePtr xml_node = NULL;
1713 err = xmlXPathRegisterNs(xpath_ctx,
1714 (const xmlChar *)METADATA_VM_PARTITION_PREFIX,
1715 (const xmlChar *)METADATA_VM_PARTITION_URI);
1717 ERROR(PLUGIN_NAME " plugin: xmlXpathRegisterNs(%s, %s) failed on domain %s",
1718 METADATA_VM_PARTITION_PREFIX, METADATA_VM_PARTITION_URI, dom_name);
1722 snprintf(xpath_str, sizeof(xpath_str), "/domain/metadata/%s:%s/text()",
1723 METADATA_VM_PARTITION_PREFIX, METADATA_VM_PARTITION_ELEMENT);
1724 xpath_obj = xmlXPathEvalExpression((xmlChar *)xpath_str, xpath_ctx);
1725 if (xpath_obj == NULL) {
1726 ERROR(PLUGIN_NAME " plugin: xmlXPathEval(%s) failed on domain %s",
1727 xpath_str, dom_name);
1731 if (xpath_obj->type != XPATH_NODESET) {
1732 ERROR(PLUGIN_NAME " plugin: xmlXPathEval(%s) unexpected return type %d "
1733 "(wanted %d) on domain %s",
1734 xpath_str, xpath_obj->type, XPATH_NODESET, dom_name);
1739 * from now on there is no real error, it's ok if a domain
1740 * doesn't have the metadata partition tag.
1743 if (xpath_obj->nodesetval == NULL || xpath_obj->nodesetval->nodeNr != 1) {
1744 DEBUG(PLUGIN_NAME " plugin: xmlXPathEval(%s) return nodeset size=%i "
1745 "expected=1 on domain %s",
1747 (xpath_obj->nodesetval == NULL) ? 0 : xpath_obj->nodesetval->nodeNr,
1750 xml_node = xpath_obj->nodesetval->nodeTab[0];
1751 sstrncpy(dom_tag, (const char *)xml_node->content, PARTITION_TAG_MAX_LEN);
1755 /* deregister to clean up */
1756 err = xmlXPathRegisterNs(xpath_ctx,
1757 (const xmlChar *)METADATA_VM_PARTITION_PREFIX, NULL);
1759 /* we can't really recover here */
1761 " plugin: deregistration of namespace %s failed for domain %s",
1762 METADATA_VM_PARTITION_PREFIX, dom_name);
1765 xmlXPathFreeObject(xpath_obj);
1770 static int is_known_tag(const char *dom_tag) {
1771 for (int i = 0; i < nr_instances; ++i)
1772 if (!strcmp(dom_tag, lv_read_user_data[i].inst.tag))
1777 static int lv_instance_include_domain(struct lv_read_instance *inst,
1778 const char *dom_name,
1779 const char *dom_tag) {
1780 if ((dom_tag[0] != '\0') && (strcmp(dom_tag, inst->tag) == 0))
1783 /* instance#0 will always be there, so it is in charge of extra duties */
1784 if (inst->id == 0) {
1785 if (dom_tag[0] == '\0' || !is_known_tag(dom_tag)) {
1786 DEBUG(PLUGIN_NAME " plugin#%s: refreshing domain %s "
1787 "with unknown tag '%s'",
1788 inst->tag, dom_name, dom_tag);
1797 virConnectListAllDomains() appeared in 0.10.2
1798 Note that LIBVIR_CHECK_VERSION appeared a year later, so
1799 in some systems which actually have virConnectListAllDomains()
1800 we can't detect this.
1802 #ifdef LIBVIR_CHECK_VERSION
1803 #if LIBVIR_CHECK_VERSION(0, 10, 2)
1804 #define HAVE_LIST_ALL_DOMAINS 1
1808 static int refresh_lists(struct lv_read_instance *inst) {
1809 struct lv_read_state *state = &inst->read_state;
1812 n = virConnectNumOfDomains(conn);
1814 VIRT_ERROR(conn, "reading number of domains");
1818 lv_clean_read_state(state);
1821 #ifdef HAVE_LIST_ALL_DOMAINS
1822 virDomainPtr *domains;
1823 n = virConnectListAllDomains(conn, &domains,
1824 VIR_CONNECT_LIST_DOMAINS_ACTIVE);
1828 /* Get list of domains. */
1829 domids = malloc(sizeof(*domids) * n);
1830 if (domids == NULL) {
1831 ERROR(PLUGIN_NAME " plugin: malloc failed.");
1835 n = virConnectListDomains(conn, domids, n);
1839 VIRT_ERROR(conn, "reading list of domains");
1840 #ifndef HAVE_LIST_ALL_DOMAINS
1846 /* Fetch each domain and add it to the list, unless ignore. */
1847 for (int i = 0; i < n; ++i) {
1850 xmlDocPtr xml_doc = NULL;
1851 xmlXPathContextPtr xpath_ctx = NULL;
1852 xmlXPathObjectPtr xpath_obj = NULL;
1853 char tag[PARTITION_TAG_MAX_LEN] = {'\0'};
1857 #ifdef HAVE_LIST_ALL_DOMAINS
1858 virDomainPtr dom = domains[i];
1860 virDomainPtr dom = NULL;
1861 dom = virDomainLookupByID(conn, domids[i]);
1863 VIRT_ERROR(conn, "virDomainLookupByID");
1864 /* Could be that the domain went away -- ignore it anyway. */
1869 name = virDomainGetName(dom);
1871 VIRT_ERROR(conn, "virDomainGetName");
1875 status = virDomainGetInfo(dom, &info);
1877 ERROR(PLUGIN_NAME " plugin: virDomainGetInfo failed with status %i.",
1882 if (info.state != VIR_DOMAIN_RUNNING) {
1883 DEBUG(PLUGIN_NAME " plugin: skipping inactive domain %s", name);
1887 if (il_domains && ignorelist_match(il_domains, name) != 0)
1890 /* Get a list of devices for this domain. */
1891 xml = virDomainGetXMLDesc(dom, 0);
1893 VIRT_ERROR(conn, "virDomainGetXMLDesc");
1897 /* Yuck, XML. Parse out the devices. */
1898 xml_doc = xmlReadDoc((xmlChar *)xml, NULL, NULL, XML_PARSE_NONET);
1899 if (xml_doc == NULL) {
1900 VIRT_ERROR(conn, "xmlReadDoc");
1904 xpath_ctx = xmlXPathNewContext(xml_doc);
1906 if (lv_domain_get_tag(xpath_ctx, name, tag) < 0) {
1907 ERROR(PLUGIN_NAME " plugin: lv_domain_get_tag failed.");
1911 if (!lv_instance_include_domain(inst, name, tag))
1914 if (add_domain(state, dom) < 0) {
1915 ERROR(PLUGIN_NAME " plugin: malloc failed.");
1919 /* Block devices. */
1920 const char *bd_xmlpath = "/domain/devices/disk/target[@dev]";
1921 if (blockdevice_format == source)
1922 bd_xmlpath = "/domain/devices/disk/source[@dev]";
1923 xpath_obj = xmlXPathEval((const xmlChar *)bd_xmlpath, xpath_ctx);
1925 if (xpath_obj == NULL || xpath_obj->type != XPATH_NODESET ||
1926 xpath_obj->nodesetval == NULL)
1929 for (int j = 0; j < xpath_obj->nodesetval->nodeNr; ++j) {
1933 node = xpath_obj->nodesetval->nodeTab[j];
1936 path = (char *)xmlGetProp(node, (xmlChar *)"dev");
1940 if (il_block_devices &&
1941 ignore_device_match(il_block_devices, name, path) != 0)
1944 add_block_device(state, dom, path);
1949 xmlXPathFreeObject(xpath_obj);
1951 /* Network interfaces. */
1952 xpath_obj = xmlXPathEval(
1953 (xmlChar *)"/domain/devices/interface[target[@dev]]", xpath_ctx);
1954 if (xpath_obj == NULL || xpath_obj->type != XPATH_NODESET ||
1955 xpath_obj->nodesetval == NULL)
1958 xmlNodeSetPtr xml_interfaces = xpath_obj->nodesetval;
1960 for (int j = 0; j < xml_interfaces->nodeNr; ++j) {
1962 char *address = NULL;
1963 xmlNodePtr xml_interface;
1965 xml_interface = xml_interfaces->nodeTab[j];
1969 for (xmlNodePtr child = xml_interface->children; child;
1970 child = child->next) {
1971 if (child->type != XML_ELEMENT_NODE)
1974 if (xmlStrEqual(child->name, (const xmlChar *)"target")) {
1975 path = (char *)xmlGetProp(child, (const xmlChar *)"dev");
1978 } else if (xmlStrEqual(child->name, (const xmlChar *)"mac")) {
1979 address = (char *)xmlGetProp(child, (const xmlChar *)"address");
1985 if (il_interface_devices &&
1986 (ignore_device_match(il_interface_devices, name, path) != 0 ||
1987 ignore_device_match(il_interface_devices, name, address) != 0))
1990 add_interface_device(state, dom, path, address, j + 1);
2000 xmlXPathFreeObject(xpath_obj);
2002 xmlXPathFreeContext(xpath_ctx);
2004 xmlFreeDoc(xml_doc);
2008 #ifdef HAVE_LIST_ALL_DOMAINS
2015 DEBUG(PLUGIN_NAME " plugin#%s: refreshing"
2016 " domains=%i block_devices=%i iface_devices=%i",
2017 inst->tag, state->nr_domains, state->nr_block_devices,
2018 state->nr_interface_devices);
2023 static void free_domains(struct lv_read_state *state) {
2024 if (state->domains) {
2025 for (int i = 0; i < state->nr_domains; ++i)
2026 virDomainFree(state->domains[i].ptr);
2027 sfree(state->domains);
2029 state->domains = NULL;
2030 state->nr_domains = 0;
2033 static int add_domain(struct lv_read_state *state, virDomainPtr dom) {
2035 int new_size = sizeof(state->domains[0]) * (state->nr_domains + 1);
2038 new_ptr = realloc(state->domains, new_size);
2040 new_ptr = malloc(new_size);
2042 if (new_ptr == NULL)
2045 state->domains = new_ptr;
2046 state->domains[state->nr_domains].ptr = dom;
2047 memset(&state->domains[state->nr_domains].info, 0,
2048 sizeof(state->domains[state->nr_domains].info));
2050 return state->nr_domains++;
2053 static void free_block_devices(struct lv_read_state *state) {
2054 if (state->block_devices) {
2055 for (int i = 0; i < state->nr_block_devices; ++i)
2056 sfree(state->block_devices[i].path);
2057 sfree(state->block_devices);
2059 state->block_devices = NULL;
2060 state->nr_block_devices = 0;
2063 static int add_block_device(struct lv_read_state *state, virDomainPtr dom,
2065 struct block_device *new_ptr;
2067 sizeof(state->block_devices[0]) * (state->nr_block_devices + 1);
2070 path_copy = strdup(path);
2074 if (state->block_devices)
2075 new_ptr = realloc(state->block_devices, new_size);
2077 new_ptr = malloc(new_size);
2079 if (new_ptr == NULL) {
2083 state->block_devices = new_ptr;
2084 state->block_devices[state->nr_block_devices].dom = dom;
2085 state->block_devices[state->nr_block_devices].path = path_copy;
2086 return state->nr_block_devices++;
2089 static void free_interface_devices(struct lv_read_state *state) {
2090 if (state->interface_devices) {
2091 for (int i = 0; i < state->nr_interface_devices; ++i) {
2092 sfree(state->interface_devices[i].path);
2093 sfree(state->interface_devices[i].address);
2094 sfree(state->interface_devices[i].number);
2096 sfree(state->interface_devices);
2098 state->interface_devices = NULL;
2099 state->nr_interface_devices = 0;
2102 static int add_interface_device(struct lv_read_state *state, virDomainPtr dom,
2103 const char *path, const char *address,
2104 unsigned int number) {
2105 struct interface_device *new_ptr;
2107 sizeof(state->interface_devices[0]) * (state->nr_interface_devices + 1);
2108 char *path_copy, *address_copy, number_string[15];
2110 if ((path == NULL) || (address == NULL))
2113 path_copy = strdup(path);
2117 address_copy = strdup(address);
2118 if (!address_copy) {
2123 snprintf(number_string, sizeof(number_string), "interface-%u", number);
2125 if (state->interface_devices)
2126 new_ptr = realloc(state->interface_devices, new_size);
2128 new_ptr = malloc(new_size);
2130 if (new_ptr == NULL) {
2132 sfree(address_copy);
2135 state->interface_devices = new_ptr;
2136 state->interface_devices[state->nr_interface_devices].dom = dom;
2137 state->interface_devices[state->nr_interface_devices].path = path_copy;
2138 state->interface_devices[state->nr_interface_devices].address = address_copy;
2139 state->interface_devices[state->nr_interface_devices].number =
2140 strdup(number_string);
2141 return state->nr_interface_devices++;
2144 static int ignore_device_match(ignorelist_t *il, const char *domname,
2145 const char *devpath) {
2149 if ((domname == NULL) || (devpath == NULL))
2152 n = strlen(domname) + strlen(devpath) + 2;
2155 ERROR(PLUGIN_NAME " plugin: malloc failed.");
2158 snprintf(name, n, "%s:%s", domname, devpath);
2159 r = ignorelist_match(il, name);
2164 static int lv_shutdown(void) {
2165 for (int i = 0; i < nr_instances; ++i) {
2166 lv_fini_instance(i);
2171 ignorelist_free(il_domains);
2173 ignorelist_free(il_block_devices);
2174 il_block_devices = NULL;
2175 ignorelist_free(il_interface_devices);
2176 il_interface_devices = NULL;
2181 void module_register(void) {
2182 plugin_register_config(PLUGIN_NAME, lv_config, config_keys, NR_CONFIG_KEYS);
2183 plugin_register_init(PLUGIN_NAME, lv_init);
2184 plugin_register_shutdown(PLUGIN_NAME, lv_shutdown);