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>
26 #include "utils_ignorelist.h"
27 #include "utils_complain.h"
29 #include <libvirt/libvirt.h>
30 #include <libvirt/virterror.h>
31 #include <libxml/parser.h>
32 #include <libxml/tree.h>
33 #include <libxml/xpath.h>
36 #define PLUGIN_NAME "virt"
38 static const char *config_keys[] = {
51 "PluginInstanceFormat",
55 #define NR_CONFIG_KEYS ((sizeof config_keys / sizeof config_keys[0]) - 1)
58 static virConnectPtr conn = 0;
59 static char *conn_string = NULL;
60 static c_complain_t conn_complain = C_COMPLAIN_INIT_STATIC;
62 /* Seconds between list refreshes, 0 disables completely. */
63 static int interval = 60;
65 /* List of domains, if specified. */
66 static ignorelist_t *il_domains = NULL;
67 /* List of block devices, if specified. */
68 static ignorelist_t *il_block_devices = NULL;
69 /* List of network interface devices, if specified. */
70 static ignorelist_t *il_interface_devices = NULL;
72 static int ignore_device_match (ignorelist_t *,
73 const char *domname, const char *devpath);
75 /* Actual list of domains found on last refresh. */
76 static virDomainPtr *domains = NULL;
77 static int nr_domains = 0;
79 static void free_domains (void);
80 static int add_domain (virDomainPtr dom);
82 /* Actual list of block devices found on last refresh. */
84 virDomainPtr dom; /* domain */
85 char *path; /* name of block device */
88 static struct block_device *block_devices = NULL;
89 static int nr_block_devices = 0;
91 static void free_block_devices (void);
92 static int add_block_device (virDomainPtr dom, const char *path);
94 /* Actual list of network interfaces found on last refresh. */
95 struct interface_device {
96 virDomainPtr dom; /* domain */
97 char *path; /* name of interface device */
98 char *address; /* mac address of interface device */
99 char *number; /* interface device number */
102 static struct interface_device *interface_devices = NULL;
103 static int nr_interface_devices = 0;
105 static void free_interface_devices (void);
106 static int add_interface_device (virDomainPtr dom, const char *path, const char *address, unsigned int number);
108 /* HostnameFormat. */
109 #define HF_MAX_FIELDS 3
118 static enum hf_field hostname_format[HF_MAX_FIELDS] =
121 /* PluginInstanceFormat */
122 #define PLGINST_MAX_FIELDS 2
130 static enum plginst_field plugin_instance_format[PLGINST_MAX_FIELDS] =
133 /* InterfaceFormat. */
140 static enum if_field interface_format = if_name;
142 /* Time that we last refreshed. */
143 static time_t last_refresh = (time_t) 0;
145 static int refresh_lists (void);
147 /* ERROR(...) macro for virterrors. */
148 #define VIRT_ERROR(conn,s) do { \
150 err = (conn) ? virConnGetLastError ((conn)) : virGetLastError (); \
151 if (err) ERROR ("%s: %s", (s), err->message); \
155 init_value_list (value_list_t *vl, virDomainPtr dom)
159 char uuid[VIR_UUID_STRING_BUFLEN];
161 sstrncpy (vl->plugin, PLUGIN_NAME, sizeof (vl->plugin));
165 /* Construct the hostname field according to HostnameFormat. */
166 for (int i = 0; i < HF_MAX_FIELDS; ++i) {
167 if (hostname_format[i] == hf_none)
170 n = DATA_MAX_NAME_LEN - strlen (vl->host) - 2;
172 if (i > 0 && n >= 1) {
173 strncat (vl->host, ":", 1);
177 switch (hostname_format[i]) {
180 strncat (vl->host, hostname_g, n);
183 name = virDomainGetName (dom);
185 strncat (vl->host, name, n);
188 if (virDomainGetUUIDString (dom, uuid) == 0)
189 strncat (vl->host, uuid, n);
194 vl->host[sizeof (vl->host) - 1] = '\0';
196 /* Construct the plugin instance field according to PluginInstanceFormat. */
197 for (int i = 0; i < PLGINST_MAX_FIELDS; ++i) {
198 if (plugin_instance_format[i] == plginst_none)
201 n = sizeof(vl->plugin_instance) - strlen (vl->plugin_instance) - 2;
203 if (i > 0 && n >= 1) {
204 strncat (vl->plugin_instance, ":", 1);
208 switch (plugin_instance_format[i]) {
209 case plginst_none: break;
211 name = virDomainGetName (dom);
213 strncat (vl->plugin_instance, name, n);
216 if (virDomainGetUUIDString (dom, uuid) == 0)
217 strncat (vl->plugin_instance, uuid, n);
222 vl->plugin_instance[sizeof (vl->plugin_instance) - 1] = '\0';
224 } /* void init_value_list */
226 static void submit (virDomainPtr dom,
227 char const *type, char const *type_instance,
228 value_t *values, size_t values_len)
230 value_list_t vl = VALUE_LIST_INIT;
231 init_value_list (&vl, dom);
234 vl.values_len = values_len;
236 sstrncpy (vl.type, type, sizeof (vl.type));
237 if (type_instance != NULL)
238 sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
240 plugin_dispatch_values (&vl);
244 memory_submit (gauge_t value, virDomainPtr dom)
246 submit (dom, "memory", "total", &(value_t) { .gauge = value }, 1);
250 memory_stats_submit (gauge_t value, virDomainPtr dom, int tag_index)
252 static const char *tags[] = { "swap_in", "swap_out", "major_fault", "minor_fault",
253 "unused", "available", "actual_balloon", "rss"};
255 if ((tag_index < 0) || (tag_index >= STATIC_ARRAY_SIZE (tags))) {
256 ERROR ("virt plugin: Array index out of bounds: tag_index = %d", tag_index);
260 submit (dom, "memory", tags[tag_index], &(value_t) { .gauge = value }, 1);
264 cpu_submit (unsigned long long value,
265 virDomainPtr dom, const char *type)
267 submit (dom, type, NULL, &(value_t) { .derive = (derive_t) value }, 1);
271 vcpu_submit (derive_t value,
272 virDomainPtr dom, int vcpu_nr, const char *type)
274 char type_instance[DATA_MAX_NAME_LEN];
276 ssnprintf (type_instance, sizeof (type_instance), "%d", vcpu_nr);
278 submit (dom, type, type_instance, &(value_t) { .derive = value }, 1);
282 submit_derive2 (const char *type, derive_t v0, derive_t v1,
283 virDomainPtr dom, const char *devname)
290 submit (dom, type, devname, values, STATIC_ARRAY_SIZE (values));
291 } /* void submit_derive2 */
296 if (virInitialize () != 0)
303 lv_config (const char *key, const char *value)
305 if (virInitialize () != 0)
308 if (il_domains == NULL)
309 il_domains = ignorelist_create (1);
310 if (il_block_devices == NULL)
311 il_block_devices = ignorelist_create (1);
312 if (il_interface_devices == NULL)
313 il_interface_devices = ignorelist_create (1);
315 if (strcasecmp (key, "Connection") == 0) {
316 char *tmp = strdup (value);
318 ERROR (PLUGIN_NAME " plugin: Connection strdup failed.");
326 if (strcasecmp (key, "RefreshInterval") == 0) {
328 interval = strtol (value, &eptr, 10);
329 if (eptr == NULL || *eptr != '\0') return 1;
333 if (strcasecmp (key, "Domain") == 0) {
334 if (ignorelist_add (il_domains, value)) return 1;
337 if (strcasecmp (key, "BlockDevice") == 0) {
338 if (ignorelist_add (il_block_devices, value)) return 1;
341 if (strcasecmp (key, "InterfaceDevice") == 0) {
342 if (ignorelist_add (il_interface_devices, value)) return 1;
346 if (strcasecmp (key, "IgnoreSelected") == 0) {
349 ignorelist_set_invert (il_domains, 0);
350 ignorelist_set_invert (il_block_devices, 0);
351 ignorelist_set_invert (il_interface_devices, 0);
355 ignorelist_set_invert (il_domains, 1);
356 ignorelist_set_invert (il_block_devices, 1);
357 ignorelist_set_invert (il_interface_devices, 1);
362 if (strcasecmp (key, "HostnameFormat") == 0) {
364 char *fields[HF_MAX_FIELDS];
367 value_copy = strdup (value);
368 if (value_copy == NULL) {
369 ERROR (PLUGIN_NAME " plugin: strdup failed.");
373 n = strsplit (value_copy, fields, HF_MAX_FIELDS);
376 ERROR (PLUGIN_NAME " plugin: HostnameFormat: no fields");
380 for (int i = 0; i < n; ++i) {
381 if (strcasecmp (fields[i], "hostname") == 0)
382 hostname_format[i] = hf_hostname;
383 else if (strcasecmp (fields[i], "name") == 0)
384 hostname_format[i] = hf_name;
385 else if (strcasecmp (fields[i], "uuid") == 0)
386 hostname_format[i] = hf_uuid;
388 ERROR (PLUGIN_NAME " plugin: unknown HostnameFormat field: %s", fields[i]);
395 for (int i = n; i < HF_MAX_FIELDS; ++i)
396 hostname_format[i] = hf_none;
401 if (strcasecmp (key, "PluginInstanceFormat") == 0) {
403 char *fields[PLGINST_MAX_FIELDS];
406 value_copy = strdup (value);
407 if (value_copy == NULL) {
408 ERROR (PLUGIN_NAME " plugin: strdup failed.");
412 n = strsplit (value_copy, fields, PLGINST_MAX_FIELDS);
415 ERROR (PLUGIN_NAME " plugin: PluginInstanceFormat: no fields");
419 for (int i = 0; i < n; ++i) {
420 if (strcasecmp (fields[i], "none") == 0) {
421 plugin_instance_format[i] = plginst_none;
423 } else if (strcasecmp (fields[i], "name") == 0)
424 plugin_instance_format[i] = plginst_name;
425 else if (strcasecmp (fields[i], "uuid") == 0)
426 plugin_instance_format[i] = plginst_uuid;
428 ERROR (PLUGIN_NAME " plugin: unknown PluginInstanceFormat field: %s", fields[i]);
435 for (int i = n; i < PLGINST_MAX_FIELDS; ++i)
436 plugin_instance_format[i] = plginst_none;
441 if (strcasecmp (key, "InterfaceFormat") == 0) {
442 if (strcasecmp (value, "name") == 0)
443 interface_format = if_name;
444 else if (strcasecmp (value, "address") == 0)
445 interface_format = if_address;
446 else if (strcasecmp (value, "number") == 0)
447 interface_format = if_number;
449 ERROR (PLUGIN_NAME " plugin: unknown InterfaceFormat: %s", value);
455 /* Unrecognised option. */
465 /* `conn_string == NULL' is acceptable. */
466 conn = virConnectOpenReadOnly (conn_string);
468 c_complain (LOG_ERR, &conn_complain,
469 PLUGIN_NAME " plugin: Unable to connect: "
470 "virConnectOpenReadOnly failed.");
474 c_release (LOG_NOTICE, &conn_complain,
475 PLUGIN_NAME " plugin: Connection established.");
479 /* Need to refresh domain or device lists? */
480 if ((last_refresh == (time_t) 0) ||
481 ((interval > 0) && ((last_refresh + interval) <= t))) {
482 if (refresh_lists () != 0) {
484 virConnectClose (conn);
492 for (int i = 0; i < nr_domains; ++i)
493 fprintf (stderr, "domain %s\n", virDomainGetName (domains[i]));
494 for (int i = 0; i < nr_block_devices; ++i)
495 fprintf (stderr, "block device %d %s:%s\n",
496 i, virDomainGetName (block_devices[i].dom),
497 block_devices[i].path);
498 for (int i = 0; i < nr_interface_devices; ++i)
499 fprintf (stderr, "interface device %d %s:%s\n",
500 i, virDomainGetName (interface_devices[i].dom),
501 interface_devices[i].path);
504 /* Get CPU usage, memory, VCPU usage for each domain. */
505 for (int i = 0; i < nr_domains; ++i) {
507 virVcpuInfoPtr vinfo = NULL;
508 virDomainMemoryStatPtr minfo = NULL;
511 status = virDomainGetInfo (domains[i], &info);
514 ERROR (PLUGIN_NAME " plugin: virDomainGetInfo failed with status %i.",
519 if (info.state != VIR_DOMAIN_RUNNING)
521 /* only gather stats for running domains */
525 cpu_submit (info.cpuTime, domains[i], "virt_cpu_total");
526 memory_submit ((gauge_t) info.memory * 1024, domains[i]);
528 vinfo = malloc (info.nrVirtCpu * sizeof (vinfo[0]));
530 ERROR (PLUGIN_NAME " plugin: malloc failed.");
534 status = virDomainGetVcpus (domains[i], vinfo, info.nrVirtCpu,
535 /* cpu map = */ NULL, /* cpu map length = */ 0);
538 ERROR (PLUGIN_NAME " plugin: virDomainGetVcpus failed with status %i.",
544 for (int j = 0; j < info.nrVirtCpu; ++j)
545 vcpu_submit (vinfo[j].cpuTime,
546 domains[i], vinfo[j].number, "virt_vcpu");
550 minfo = malloc (VIR_DOMAIN_MEMORY_STAT_NR * sizeof (virDomainMemoryStatStruct));
552 ERROR ("virt plugin: malloc failed.");
556 status = virDomainMemoryStats (domains[i], minfo, VIR_DOMAIN_MEMORY_STAT_NR, 0);
559 ERROR ("virt plugin: virDomainMemoryStats failed with status %i.",
565 for (int j = 0; j < status; j++) {
566 memory_stats_submit ((gauge_t) minfo[j].val * 1024, domains[i], minfo[j].tag);
573 /* Get block device stats for each domain. */
574 for (int i = 0; i < nr_block_devices; ++i) {
575 struct _virDomainBlockStats stats;
577 if (virDomainBlockStats (block_devices[i].dom, block_devices[i].path,
578 &stats, sizeof stats) != 0)
581 if ((stats.rd_req != -1) && (stats.wr_req != -1))
582 submit_derive2 ("disk_ops",
583 (derive_t) stats.rd_req, (derive_t) stats.wr_req,
584 block_devices[i].dom, block_devices[i].path);
586 if ((stats.rd_bytes != -1) && (stats.wr_bytes != -1))
587 submit_derive2 ("disk_octets",
588 (derive_t) stats.rd_bytes, (derive_t) stats.wr_bytes,
589 block_devices[i].dom, block_devices[i].path);
590 } /* for (nr_block_devices) */
592 /* Get interface stats for each domain. */
593 for (int i = 0; i < nr_interface_devices; ++i) {
594 struct _virDomainInterfaceStats stats;
595 char *display_name = NULL;
598 switch (interface_format) {
600 display_name = interface_devices[i].address;
603 display_name = interface_devices[i].number;
607 display_name = interface_devices[i].path;
610 if (virDomainInterfaceStats (interface_devices[i].dom,
611 interface_devices[i].path,
612 &stats, sizeof stats) != 0)
615 if ((stats.rx_bytes != -1) && (stats.tx_bytes != -1))
616 submit_derive2 ("if_octets",
617 (derive_t) stats.rx_bytes, (derive_t) stats.tx_bytes,
618 interface_devices[i].dom, display_name);
620 if ((stats.rx_packets != -1) && (stats.tx_packets != -1))
621 submit_derive2 ("if_packets",
622 (derive_t) stats.rx_packets, (derive_t) stats.tx_packets,
623 interface_devices[i].dom, display_name);
625 if ((stats.rx_errs != -1) && (stats.tx_errs != -1))
626 submit_derive2 ("if_errors",
627 (derive_t) stats.rx_errs, (derive_t) stats.tx_errs,
628 interface_devices[i].dom, display_name);
630 if ((stats.rx_drop != -1) && (stats.tx_drop != -1))
631 submit_derive2 ("if_dropped",
632 (derive_t) stats.rx_drop, (derive_t) stats.tx_drop,
633 interface_devices[i].dom, display_name);
634 } /* for (nr_interface_devices) */
644 n = virConnectNumOfDomains (conn);
646 VIRT_ERROR (conn, "reading number of domains");
653 /* Get list of domains. */
654 domids = malloc (sizeof (*domids) * n);
655 if (domids == NULL) {
656 ERROR (PLUGIN_NAME " plugin: malloc failed.");
660 n = virConnectListDomains (conn, domids, n);
662 VIRT_ERROR (conn, "reading list of domains");
667 free_block_devices ();
668 free_interface_devices ();
671 /* Fetch each domain and add it to the list, unless ignore. */
672 for (int i = 0; i < n; ++i) {
673 virDomainPtr dom = NULL;
676 xmlDocPtr xml_doc = NULL;
677 xmlXPathContextPtr xpath_ctx = NULL;
678 xmlXPathObjectPtr xpath_obj = NULL;
680 dom = virDomainLookupByID (conn, domids[i]);
682 VIRT_ERROR (conn, "virDomainLookupByID");
683 /* Could be that the domain went away -- ignore it anyway. */
687 name = virDomainGetName (dom);
689 VIRT_ERROR (conn, "virDomainGetName");
693 if (il_domains && ignorelist_match (il_domains, name) != 0)
696 if (add_domain (dom) < 0) {
697 ERROR (PLUGIN_NAME " plugin: malloc failed.");
701 /* Get a list of devices for this domain. */
702 xml = virDomainGetXMLDesc (dom, 0);
704 VIRT_ERROR (conn, "virDomainGetXMLDesc");
708 /* Yuck, XML. Parse out the devices. */
709 xml_doc = xmlReadDoc ((xmlChar *) xml, NULL, NULL, XML_PARSE_NONET);
710 if (xml_doc == NULL) {
711 VIRT_ERROR (conn, "xmlReadDoc");
715 xpath_ctx = xmlXPathNewContext (xml_doc);
718 xpath_obj = xmlXPathEval
719 ((xmlChar *) "/domain/devices/disk/target[@dev]",
721 if (xpath_obj == NULL || xpath_obj->type != XPATH_NODESET ||
722 xpath_obj->nodesetval == NULL)
725 for (int j = 0; j < xpath_obj->nodesetval->nodeNr; ++j) {
729 node = xpath_obj->nodesetval->nodeTab[j];
731 path = (char *) xmlGetProp (node, (xmlChar *) "dev");
734 if (il_block_devices &&
735 ignore_device_match (il_block_devices, name, path) != 0)
738 add_block_device (dom, path);
740 if (path) xmlFree (path);
742 xmlXPathFreeObject (xpath_obj);
744 /* Network interfaces. */
745 xpath_obj = xmlXPathEval
746 ((xmlChar *) "/domain/devices/interface[target[@dev]]",
748 if (xpath_obj == NULL || xpath_obj->type != XPATH_NODESET ||
749 xpath_obj->nodesetval == NULL)
752 xmlNodeSetPtr xml_interfaces = xpath_obj->nodesetval;
754 for (int j = 0; j < xml_interfaces->nodeNr; ++j) {
756 char *address = NULL;
757 xmlNodePtr xml_interface;
759 xml_interface = xml_interfaces->nodeTab[j];
760 if (!xml_interface) continue;
762 for (xmlNodePtr child = xml_interface->children; child; child = child->next) {
763 if (child->type != XML_ELEMENT_NODE) continue;
765 if (xmlStrEqual(child->name, (const xmlChar *) "target")) {
766 path = (char *) xmlGetProp (child, (const xmlChar *) "dev");
768 } else if (xmlStrEqual(child->name, (const xmlChar *) "mac")) {
769 address = (char *) xmlGetProp (child, (const xmlChar *) "address");
770 if (!address) continue;
774 if (il_interface_devices &&
775 (ignore_device_match (il_interface_devices, name, path) != 0 ||
776 ignore_device_match (il_interface_devices, name, address) != 0))
779 add_interface_device (dom, path, address, j+1);
781 if (path) xmlFree (path);
782 if (address) xmlFree (address);
786 if (xpath_obj) xmlXPathFreeObject (xpath_obj);
787 if (xpath_ctx) xmlXPathFreeContext (xpath_ctx);
788 if (xml_doc) xmlFreeDoc (xml_doc);
802 for (int i = 0; i < nr_domains; ++i)
803 virDomainFree (domains[i]);
811 add_domain (virDomainPtr dom)
813 virDomainPtr *new_ptr;
814 int new_size = sizeof (domains[0]) * (nr_domains+1);
817 new_ptr = realloc (domains, new_size);
819 new_ptr = malloc (new_size);
825 domains[nr_domains] = dom;
830 free_block_devices (void)
833 for (int i = 0; i < nr_block_devices; ++i)
834 sfree (block_devices[i].path);
835 sfree (block_devices);
837 block_devices = NULL;
838 nr_block_devices = 0;
842 add_block_device (virDomainPtr dom, const char *path)
844 struct block_device *new_ptr;
845 int new_size = sizeof (block_devices[0]) * (nr_block_devices+1);
848 path_copy = strdup (path);
853 new_ptr = realloc (block_devices, new_size);
855 new_ptr = malloc (new_size);
857 if (new_ptr == NULL) {
861 block_devices = new_ptr;
862 block_devices[nr_block_devices].dom = dom;
863 block_devices[nr_block_devices].path = path_copy;
864 return nr_block_devices++;
868 free_interface_devices (void)
870 if (interface_devices) {
871 for (int i = 0; i < nr_interface_devices; ++i) {
872 sfree (interface_devices[i].path);
873 sfree (interface_devices[i].address);
874 sfree (interface_devices[i].number);
876 sfree (interface_devices);
878 interface_devices = NULL;
879 nr_interface_devices = 0;
883 add_interface_device (virDomainPtr dom, const char *path, const char *address, unsigned int number)
885 struct interface_device *new_ptr;
886 int new_size = sizeof (interface_devices[0]) * (nr_interface_devices+1);
887 char *path_copy, *address_copy, number_string[15];
889 if ((path == NULL) || (address == NULL))
892 path_copy = strdup (path);
893 if (!path_copy) return -1;
895 address_copy = strdup (address);
901 snprintf(number_string, sizeof (number_string), "interface-%u", number);
903 if (interface_devices)
904 new_ptr = realloc (interface_devices, new_size);
906 new_ptr = malloc (new_size);
908 if (new_ptr == NULL) {
910 sfree (address_copy);
913 interface_devices = new_ptr;
914 interface_devices[nr_interface_devices].dom = dom;
915 interface_devices[nr_interface_devices].path = path_copy;
916 interface_devices[nr_interface_devices].address = address_copy;
917 interface_devices[nr_interface_devices].number = strdup(number_string);
918 return nr_interface_devices++;
922 ignore_device_match (ignorelist_t *il, const char *domname, const char *devpath)
927 if ((domname == NULL) || (devpath == NULL))
930 n = sizeof (char) * (strlen (domname) + strlen (devpath) + 2);
933 ERROR (PLUGIN_NAME " plugin: malloc failed.");
936 ssnprintf (name, n, "%s:%s", domname, devpath);
937 r = ignorelist_match (il, name);
945 free_block_devices ();
946 free_interface_devices ();
950 virConnectClose (conn);
953 ignorelist_free (il_domains);
955 ignorelist_free (il_block_devices);
956 il_block_devices = NULL;
957 ignorelist_free (il_interface_devices);
958 il_interface_devices = NULL;
964 module_register (void)
966 plugin_register_config (PLUGIN_NAME,
968 config_keys, NR_CONFIG_KEYS);
969 plugin_register_init (PLUGIN_NAME, lv_init);
970 plugin_register_read (PLUGIN_NAME, lv_read);
971 plugin_register_shutdown (PLUGIN_NAME, lv_shutdown);
975 * vim: shiftwidth=4 tabstop=8 softtabstop=4 expandtab fdm=marker