2 * collectd - src/libvirt.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>
25 #include "configfile.h"
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>
35 static const char *config_keys[] = {
50 #define NR_CONFIG_KEYS ((sizeof config_keys / sizeof config_keys[0]) - 1)
53 static virConnectPtr conn = 0;
54 static char *conn_string = NULL;
55 static c_complain_t conn_complain = C_COMPLAIN_INIT_STATIC;
57 /* Seconds between list refreshes, 0 disables completely. */
58 static int interval = 60;
60 /* List of domains, if specified. */
61 static ignorelist_t *il_domains = NULL;
62 /* List of block devices, if specified. */
63 static ignorelist_t *il_block_devices = NULL;
64 /* List of network interface devices, if specified. */
65 static ignorelist_t *il_interface_devices = NULL;
67 static int ignore_device_match (ignorelist_t *,
68 const char *domname, const char *devpath);
70 /* Actual list of domains found on last refresh. */
71 static virDomainPtr *domains = NULL;
72 static int nr_domains = 0;
74 static void free_domains (void);
75 static int add_domain (virDomainPtr dom);
77 /* Actual list of block devices found on last refresh. */
79 virDomainPtr dom; /* domain */
80 char *path; /* name of block device */
83 static struct block_device *block_devices = NULL;
84 static int nr_block_devices = 0;
86 static void free_block_devices (void);
87 static int add_block_device (virDomainPtr dom, const char *path);
89 /* Actual list of network interfaces found on last refresh. */
90 struct interface_device {
91 virDomainPtr dom; /* domain */
92 char *path; /* name of interface device */
93 char *address; /* mac address of interface device */
94 char *number; /* interface device number */
97 static struct interface_device *interface_devices = NULL;
98 static int nr_interface_devices = 0;
100 static void free_interface_devices (void);
101 static int add_interface_device (virDomainPtr dom, const char *path, const char *address, unsigned int number);
103 /* HostnameFormat. */
104 #define HF_MAX_FIELDS 3
113 static enum hf_field hostname_format[HF_MAX_FIELDS] =
116 /* InterfaceFormat. */
123 static enum if_field interface_format = if_name;
125 /* Time that we last refreshed. */
126 static time_t last_refresh = (time_t) 0;
128 static int refresh_lists (void);
130 /* ERROR(...) macro for virterrors. */
131 #define VIRT_ERROR(conn,s) do { \
133 err = (conn) ? virConnGetLastError ((conn)) : virGetLastError (); \
134 if (err) ERROR ("%s: %s", (s), err->message); \
138 init_value_list (value_list_t *vl, virDomainPtr dom)
142 char uuid[VIR_UUID_STRING_BUFLEN];
144 sstrncpy (vl->plugin, "libvirt", sizeof (vl->plugin));
148 /* Construct the hostname field according to HostnameFormat. */
149 for (i = 0; i < HF_MAX_FIELDS; ++i) {
150 if (hostname_format[i] == hf_none)
153 n = DATA_MAX_NAME_LEN - strlen (vl->host) - 2;
155 if (i > 0 && n >= 1) {
156 strncat (vl->host, ":", 1);
160 switch (hostname_format[i]) {
163 strncat (vl->host, hostname_g, n);
166 name = virDomainGetName (dom);
168 strncat (vl->host, name, n);
171 if (virDomainGetUUIDString (dom, uuid) == 0)
172 strncat (vl->host, uuid, n);
177 vl->host[sizeof (vl->host) - 1] = '\0';
178 } /* void init_value_list */
181 memory_submit (gauge_t memory, virDomainPtr dom)
184 value_list_t vl = VALUE_LIST_INIT;
186 init_value_list (&vl, dom);
188 values[0].gauge = memory;
193 sstrncpy (vl.type, "memory", sizeof (vl.type));
194 sstrncpy (vl.type_instance, "total", sizeof (vl.type_instance));
196 plugin_dispatch_values (&vl);
200 cpu_submit (unsigned long long cpu_time,
201 virDomainPtr dom, const char *type)
204 value_list_t vl = VALUE_LIST_INIT;
206 init_value_list (&vl, dom);
208 values[0].derive = cpu_time;
213 sstrncpy (vl.type, type, sizeof (vl.type));
215 plugin_dispatch_values (&vl);
219 vcpu_submit (derive_t cpu_time,
220 virDomainPtr dom, int vcpu_nr, const char *type)
223 value_list_t vl = VALUE_LIST_INIT;
225 init_value_list (&vl, dom);
227 values[0].derive = cpu_time;
231 sstrncpy (vl.type, type, sizeof (vl.type));
232 ssnprintf (vl.type_instance, sizeof (vl.type_instance), "%d", vcpu_nr);
234 plugin_dispatch_values (&vl);
238 submit_derive2 (const char *type, derive_t v0, derive_t v1,
239 virDomainPtr dom, const char *devname)
242 value_list_t vl = VALUE_LIST_INIT;
244 init_value_list (&vl, dom);
246 values[0].derive = v0;
247 values[1].derive = v1;
251 sstrncpy (vl.type, type, sizeof (vl.type));
252 sstrncpy (vl.type_instance, devname, sizeof (vl.type_instance));
254 plugin_dispatch_values (&vl);
255 } /* void submit_derive2 */
260 if (virInitialize () != 0)
267 lv_config (const char *key, const char *value)
269 if (virInitialize () != 0)
272 if (il_domains == NULL)
273 il_domains = ignorelist_create (1);
274 if (il_block_devices == NULL)
275 il_block_devices = ignorelist_create (1);
276 if (il_interface_devices == NULL)
277 il_interface_devices = ignorelist_create (1);
279 if (strcasecmp (key, "Connection") == 0) {
280 char *tmp = strdup (value);
282 ERROR ("libvirt plugin: Connection strdup failed.");
290 if (strcasecmp (key, "RefreshInterval") == 0) {
292 interval = strtol (value, &eptr, 10);
293 if (eptr == NULL || *eptr != '\0') return 1;
297 if (strcasecmp (key, "Domain") == 0) {
298 if (ignorelist_add (il_domains, value)) return 1;
301 if (strcasecmp (key, "BlockDevice") == 0) {
302 if (ignorelist_add (il_block_devices, value)) return 1;
305 if (strcasecmp (key, "InterfaceDevice") == 0) {
306 if (ignorelist_add (il_interface_devices, value)) return 1;
310 if (strcasecmp (key, "IgnoreSelected") == 0) {
313 ignorelist_set_invert (il_domains, 0);
314 ignorelist_set_invert (il_block_devices, 0);
315 ignorelist_set_invert (il_interface_devices, 0);
319 ignorelist_set_invert (il_domains, 1);
320 ignorelist_set_invert (il_block_devices, 1);
321 ignorelist_set_invert (il_interface_devices, 1);
326 if (strcasecmp (key, "HostnameFormat") == 0) {
328 char *fields[HF_MAX_FIELDS];
331 value_copy = strdup (value);
332 if (value_copy == NULL) {
333 ERROR ("libvirt plugin: strdup failed.");
337 n = strsplit (value_copy, fields, HF_MAX_FIELDS);
340 ERROR ("HostnameFormat: no fields");
344 for (i = 0; i < n; ++i) {
345 if (strcasecmp (fields[i], "hostname") == 0)
346 hostname_format[i] = hf_hostname;
347 else if (strcasecmp (fields[i], "name") == 0)
348 hostname_format[i] = hf_name;
349 else if (strcasecmp (fields[i], "uuid") == 0)
350 hostname_format[i] = hf_uuid;
353 ERROR ("unknown HostnameFormat field: %s", fields[i]);
359 for (i = n; i < HF_MAX_FIELDS; ++i)
360 hostname_format[i] = hf_none;
365 if (strcasecmp (key, "InterfaceFormat") == 0) {
366 if (strcasecmp (value, "name") == 0)
367 interface_format = if_name;
368 else if (strcasecmp (value, "address") == 0)
369 interface_format = if_address;
370 else if (strcasecmp (value, "number") == 0)
371 interface_format = if_number;
373 ERROR ("unknown InterfaceFormat: %s", value);
379 /* Unrecognised option. */
390 /* `conn_string == NULL' is acceptable. */
391 conn = virConnectOpenReadOnly (conn_string);
393 c_complain (LOG_ERR, &conn_complain,
394 "libvirt plugin: Unable to connect: "
395 "virConnectOpenReadOnly failed.");
399 c_release (LOG_NOTICE, &conn_complain,
400 "libvirt plugin: Connection established.");
404 /* Need to refresh domain or device lists? */
405 if ((last_refresh == (time_t) 0) ||
406 ((interval > 0) && ((last_refresh + interval) <= t))) {
407 if (refresh_lists () != 0) {
409 virConnectClose (conn);
417 for (i = 0; i < nr_domains; ++i)
418 fprintf (stderr, "domain %s\n", virDomainGetName (domains[i]));
419 for (i = 0; i < nr_block_devices; ++i)
420 fprintf (stderr, "block device %d %s:%s\n",
421 i, virDomainGetName (block_devices[i].dom),
422 block_devices[i].path);
423 for (i = 0; i < nr_interface_devices; ++i)
424 fprintf (stderr, "interface device %d %s:%s\n",
425 i, virDomainGetName (interface_devices[i].dom),
426 interface_devices[i].path);
429 /* Get CPU usage, memory, VCPU usage for each domain. */
430 for (i = 0; i < nr_domains; ++i) {
432 virVcpuInfoPtr vinfo = NULL;
436 status = virDomainGetInfo (domains[i], &info);
439 ERROR ("libvirt plugin: virDomainGetInfo failed with status %i.",
444 if (info.state != VIR_DOMAIN_RUNNING)
446 /* only gather stats for running domains */
450 cpu_submit (info.cpuTime, domains[i], "virt_cpu_total");
451 memory_submit ((gauge_t) info.memory * 1024, domains[i]);
453 vinfo = malloc (info.nrVirtCpu * sizeof (vinfo[0]));
455 ERROR ("libvirt plugin: malloc failed.");
459 status = virDomainGetVcpus (domains[i], vinfo, info.nrVirtCpu,
460 /* cpu map = */ NULL, /* cpu map length = */ 0);
463 ERROR ("libvirt plugin: virDomainGetVcpus failed with status %i.",
469 for (j = 0; j < info.nrVirtCpu; ++j)
470 vcpu_submit (vinfo[j].cpuTime,
471 domains[i], vinfo[j].number, "virt_vcpu");
476 /* Get block device stats for each domain. */
477 for (i = 0; i < nr_block_devices; ++i) {
478 struct _virDomainBlockStats stats;
480 if (virDomainBlockStats (block_devices[i].dom, block_devices[i].path,
481 &stats, sizeof stats) != 0)
484 if ((stats.rd_req != -1) && (stats.wr_req != -1))
485 submit_derive2 ("disk_ops",
486 (derive_t) stats.rd_req, (derive_t) stats.wr_req,
487 block_devices[i].dom, block_devices[i].path);
489 if ((stats.rd_bytes != -1) && (stats.wr_bytes != -1))
490 submit_derive2 ("disk_octets",
491 (derive_t) stats.rd_bytes, (derive_t) stats.wr_bytes,
492 block_devices[i].dom, block_devices[i].path);
493 } /* for (nr_block_devices) */
495 /* Get interface stats for each domain. */
496 for (i = 0; i < nr_interface_devices; ++i) {
497 struct _virDomainInterfaceStats stats;
498 char *display_name = NULL;
501 switch (interface_format) {
503 display_name = interface_devices[i].address;
506 display_name = interface_devices[i].number;
510 display_name = interface_devices[i].path;
513 if (virDomainInterfaceStats (interface_devices[i].dom,
514 interface_devices[i].path,
515 &stats, sizeof stats) != 0)
518 if ((stats.rx_bytes != -1) && (stats.tx_bytes != -1))
519 submit_derive2 ("if_octets",
520 (derive_t) stats.rx_bytes, (derive_t) stats.tx_bytes,
521 interface_devices[i].dom, display_name);
523 if ((stats.rx_packets != -1) && (stats.tx_packets != -1))
524 submit_derive2 ("if_packets",
525 (derive_t) stats.rx_packets, (derive_t) stats.tx_packets,
526 interface_devices[i].dom, display_name);
528 if ((stats.rx_errs != -1) && (stats.tx_errs != -1))
529 submit_derive2 ("if_errors",
530 (derive_t) stats.rx_errs, (derive_t) stats.tx_errs,
531 interface_devices[i].dom, display_name);
533 if ((stats.rx_drop != -1) && (stats.tx_drop != -1))
534 submit_derive2 ("if_dropped",
535 (derive_t) stats.rx_drop, (derive_t) stats.tx_drop,
536 interface_devices[i].dom, display_name);
537 } /* for (nr_interface_devices) */
547 n = virConnectNumOfDomains (conn);
549 VIRT_ERROR (conn, "reading number of domains");
557 /* Get list of domains. */
558 domids = malloc (sizeof (int) * n);
560 ERROR ("libvirt plugin: malloc failed.");
564 n = virConnectListDomains (conn, domids, n);
566 VIRT_ERROR (conn, "reading list of domains");
571 free_block_devices ();
572 free_interface_devices ();
575 /* Fetch each domain and add it to the list, unless ignore. */
576 for (i = 0; i < n; ++i) {
577 virDomainPtr dom = NULL;
580 xmlDocPtr xml_doc = NULL;
581 xmlXPathContextPtr xpath_ctx = NULL;
582 xmlXPathObjectPtr xpath_obj = NULL;
585 dom = virDomainLookupByID (conn, domids[i]);
587 VIRT_ERROR (conn, "virDomainLookupByID");
588 /* Could be that the domain went away -- ignore it anyway. */
592 name = virDomainGetName (dom);
594 VIRT_ERROR (conn, "virDomainGetName");
598 if (il_domains && ignorelist_match (il_domains, name) != 0)
601 if (add_domain (dom) < 0) {
602 ERROR ("libvirt plugin: malloc failed.");
606 /* Get a list of devices for this domain. */
607 xml = virDomainGetXMLDesc (dom, 0);
609 VIRT_ERROR (conn, "virDomainGetXMLDesc");
613 /* Yuck, XML. Parse out the devices. */
614 xml_doc = xmlReadDoc ((xmlChar *) xml, NULL, NULL, XML_PARSE_NONET);
615 if (xml_doc == NULL) {
616 VIRT_ERROR (conn, "xmlReadDoc");
620 xpath_ctx = xmlXPathNewContext (xml_doc);
623 xpath_obj = xmlXPathEval
624 ((xmlChar *) "/domain/devices/disk/target[@dev]",
626 if (xpath_obj == NULL || xpath_obj->type != XPATH_NODESET ||
627 xpath_obj->nodesetval == NULL)
630 for (j = 0; j < xpath_obj->nodesetval->nodeNr; ++j) {
634 node = xpath_obj->nodesetval->nodeTab[j];
636 path = (char *) xmlGetProp (node, (xmlChar *) "dev");
639 if (il_block_devices &&
640 ignore_device_match (il_block_devices, name, path) != 0)
643 add_block_device (dom, path);
645 if (path) xmlFree (path);
647 xmlXPathFreeObject (xpath_obj);
649 /* Network interfaces. */
650 xpath_obj = xmlXPathEval
651 ((xmlChar *) "/domain/devices/interface[target[@dev]]",
653 if (xpath_obj == NULL || xpath_obj->type != XPATH_NODESET ||
654 xpath_obj->nodesetval == NULL)
657 xmlNodeSetPtr xml_interfaces = xpath_obj->nodesetval;
659 for (j = 0; j < xml_interfaces->nodeNr; ++j) {
661 char *address = NULL;
662 xmlNodePtr xml_interface;
664 xml_interface = xml_interfaces->nodeTab[j];
665 if (!xml_interface) continue;
666 xmlNodePtr child = NULL;
668 for (child = xml_interface->children; child; child = child->next) {
669 if (child->type != XML_ELEMENT_NODE) continue;
671 if (xmlStrEqual(child->name, (const xmlChar *) "target")) {
672 path = (char *) xmlGetProp (child, (const xmlChar *) "dev");
674 } else if (xmlStrEqual(child->name, (const xmlChar *) "mac")) {
675 address = (char *) xmlGetProp (child, (const xmlChar *) "address");
676 if (!address) continue;
680 if (il_interface_devices &&
681 (ignore_device_match (il_interface_devices, name, path) != 0 ||
682 ignore_device_match (il_interface_devices, name, address) != 0))
685 add_interface_device (dom, path, address, j+1);
687 if (path) xmlFree (path);
688 if (address) xmlFree (address);
692 if (xpath_obj) xmlXPathFreeObject (xpath_obj);
693 if (xpath_ctx) xmlXPathFreeContext (xpath_ctx);
694 if (xml_doc) xmlFreeDoc (xml_doc);
710 for (i = 0; i < nr_domains; ++i)
711 virDomainFree (domains[i]);
719 add_domain (virDomainPtr dom)
721 virDomainPtr *new_ptr;
722 int new_size = sizeof (domains[0]) * (nr_domains+1);
725 new_ptr = realloc (domains, new_size);
727 new_ptr = malloc (new_size);
733 domains[nr_domains] = dom;
738 free_block_devices ()
743 for (i = 0; i < nr_block_devices; ++i)
744 sfree (block_devices[i].path);
745 sfree (block_devices);
747 block_devices = NULL;
748 nr_block_devices = 0;
752 add_block_device (virDomainPtr dom, const char *path)
754 struct block_device *new_ptr;
755 int new_size = sizeof (block_devices[0]) * (nr_block_devices+1);
758 path_copy = strdup (path);
763 new_ptr = realloc (block_devices, new_size);
765 new_ptr = malloc (new_size);
767 if (new_ptr == NULL) {
771 block_devices = new_ptr;
772 block_devices[nr_block_devices].dom = dom;
773 block_devices[nr_block_devices].path = path_copy;
774 return nr_block_devices++;
778 free_interface_devices ()
782 if (interface_devices) {
783 for (i = 0; i < nr_interface_devices; ++i) {
784 sfree (interface_devices[i].path);
785 sfree (interface_devices[i].address);
786 sfree (interface_devices[i].number);
788 sfree (interface_devices);
790 interface_devices = NULL;
791 nr_interface_devices = 0;
795 add_interface_device (virDomainPtr dom, const char *path, const char *address, unsigned int number)
797 struct interface_device *new_ptr;
798 int new_size = sizeof (interface_devices[0]) * (nr_interface_devices+1);
799 char *path_copy, *address_copy, number_string[15];
801 path_copy = strdup (path);
802 if (!path_copy) return -1;
804 address_copy = strdup (address);
810 snprintf(number_string, sizeof (number_string), "interface-%u", number);
812 if (interface_devices)
813 new_ptr = realloc (interface_devices, new_size);
815 new_ptr = malloc (new_size);
817 if (new_ptr == NULL) {
819 sfree (address_copy);
822 interface_devices = new_ptr;
823 interface_devices[nr_interface_devices].dom = dom;
824 interface_devices[nr_interface_devices].path = path_copy;
825 interface_devices[nr_interface_devices].address = address_copy;
826 interface_devices[nr_interface_devices].number = strdup(number_string);
827 return nr_interface_devices++;
831 ignore_device_match (ignorelist_t *il, const char *domname, const char *devpath)
836 n = sizeof (char) * (strlen (domname) + strlen (devpath) + 2);
839 ERROR ("libvirt plugin: malloc failed.");
842 ssnprintf (name, n, "%s:%s", domname, devpath);
843 r = ignorelist_match (il, name);
851 free_block_devices ();
852 free_interface_devices ();
856 virConnectClose (conn);
859 ignorelist_free (il_domains);
861 ignorelist_free (il_block_devices);
862 il_block_devices = NULL;
863 ignorelist_free (il_interface_devices);
864 il_interface_devices = NULL;
870 module_register (void)
872 plugin_register_config ("libvirt",
874 config_keys, NR_CONFIG_KEYS);
875 plugin_register_init ("libvirt", lv_init);
876 plugin_register_read ("libvirt", lv_read);
877 plugin_register_shutdown ("libvirt", lv_shutdown);
881 * vim: shiftwidth=4 tabstop=8 softtabstop=4 expandtab fdm=marker