2 * collectd - src/gmond.c
3 * Copyright (C) 2005-2009 Florian octo Forster
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 * Florian octo Forster <octo at verplant.org>
25 #include "configfile.h"
26 #include "utils_avltree.h"
34 # include <sys/socket.h>
40 # include <netinet/in.h>
43 # include <arpa/inet.h>
49 #include <gm_protocol.h>
51 #ifndef IPV6_ADD_MEMBERSHIP
52 # ifdef IPV6_JOIN_GROUP
53 # define IPV6_ADD_MEMBERSHIP IPV6_JOIN_GROUP
55 # error "Neither IP_ADD_MEMBERSHIP nor IPV6_JOIN_GROUP is defined"
57 #endif /* !IP_ADD_MEMBERSHIP */
59 #ifdef GANGLIA_MAX_MESSAGE_LEN
60 # define BUFF_SIZE GANGLIA_MAX_MESSAGE_LEN
62 # define BUFF_SIZE 1400
68 struct sockaddr_storage addr;
71 typedef struct socket_entry_s socket_entry_t;
73 struct staging_entry_s
75 char key[2 * DATA_MAX_NAME_LEN];
79 typedef struct staging_entry_s staging_entry_t;
83 const char *ganglia_name;
85 const char *type_instance;
89 typedef struct metric_map_s metric_map_t;
91 static struct pollfd *mc_receive_sockets = NULL;
92 static size_t mc_receive_sockets_num = 0;
94 static socket_entry_t *mc_send_sockets = NULL;
95 static size_t mc_send_sockets_num = 0;
96 static pthread_mutex_t mc_send_sockets_lock = PTHREAD_MUTEX_INITIALIZER;
98 static int mc_receive_thread_loop = 0;
99 static int mc_receive_thread_running = 0;
100 static pthread_t mc_receive_thread_id;
102 static metric_map_t metric_map[] =
104 { "load_one", "load", "", DS_TYPE_GAUGE, 0 },
105 { "load_five", "load", "", DS_TYPE_GAUGE, 1 },
106 { "load_fifteen", "load", "", DS_TYPE_GAUGE, 2 },
107 { "cpu_user", "cpu", "user", DS_TYPE_COUNTER, 0 },
108 { "cpu_system", "cpu", "system", DS_TYPE_COUNTER, 0 },
109 { "cpu_idle", "cpu", "idle", DS_TYPE_COUNTER, 0 },
110 { "cpu_nice", "cpu", "nice", DS_TYPE_COUNTER, 0 },
111 { "cpu_wio", "cpu", "wait", DS_TYPE_COUNTER, 0 },
112 { "mem_free", "memory", "free", DS_TYPE_GAUGE, 0 },
113 { "mem_shared", "memory", "shared", DS_TYPE_GAUGE, 0 },
114 { "mem_buffers", "memory", "buffered", DS_TYPE_GAUGE, 0 },
115 { "mem_cached", "memory", "cached", DS_TYPE_GAUGE, 0 },
116 { "mem_total", "memory", "total", DS_TYPE_GAUGE, 0 },
117 { "bytes_in", "if_octets", "", DS_TYPE_COUNTER, 0 },
118 { "bytes_out", "if_octets", "", DS_TYPE_COUNTER, 1 },
119 { "pkts_in", "if_packets", "", DS_TYPE_COUNTER, 0 },
120 { "pkts_out", "if_packets", "", DS_TYPE_COUNTER, 1 }
122 static size_t metric_map_len = STATIC_ARRAY_SIZE (metric_map);
124 static c_avl_tree_t *staging_tree;
125 static pthread_mutex_t staging_lock = PTHREAD_MUTEX_INITIALIZER;
127 static int create_sockets (socket_entry_t **ret_sockets, /* {{{ */
128 size_t *ret_sockets_num,
129 const char *node, const char *service, int listen)
131 struct addrinfo ai_hints;
132 struct addrinfo *ai_list;
133 struct addrinfo *ai_ptr;
136 socket_entry_t *sockets;
141 sockets = *ret_sockets;
142 sockets_num = *ret_sockets_num;
144 memset (&ai_hints, 0, sizeof (ai_hints));
145 ai_hints.ai_flags = 0;
147 ai_hints.ai_flags |= AI_PASSIVE;
150 ai_hints.ai_flags |= AI_ADDRCONFIG;
152 ai_hints.ai_family = AF_UNSPEC;
153 ai_hints.ai_socktype = SOCK_DGRAM;
154 ai_hints.ai_protocol = IPPROTO_UDP;
156 ai_return = getaddrinfo (node, service, &ai_hints, &ai_list);
160 ERROR ("gmond plugin: getaddrinfo (%s, %s) failed: %s",
161 (node == NULL) ? "(null)" : node,
162 (service == NULL) ? "(null)" : service,
163 (ai_return == EAI_SYSTEM)
164 ? sstrerror (errno, errbuf, sizeof (errbuf))
165 : gai_strerror (ai_return));
169 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next) /* {{{ */
173 tmp = realloc (sockets, (sockets_num + 1) * sizeof (*sockets));
176 ERROR ("gmond plugin: realloc failed.");
181 sockets[sockets_num].fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype,
182 ai_ptr->ai_protocol);
183 if (sockets[sockets_num].fd < 0)
186 ERROR ("gmond plugin: socket failed: %s",
187 sstrerror (errno, errbuf, sizeof (errbuf)));
191 assert (sizeof (sockets[sockets_num].addr) >= ai_ptr->ai_addrlen);
192 memcpy (&sockets[sockets_num].addr, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
193 sockets[sockets_num].addrlen = ai_ptr->ai_addrlen;
195 /* Sending socket: Open only one socket and don't bind it. */
205 setsockopt (sockets[sockets_num].fd, SOL_SOCKET, SO_REUSEADDR,
206 (void *) &yes, sizeof (yes));
209 status = bind (sockets[sockets_num].fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
213 ERROR ("gmond plugin: bind failed: %s",
214 sstrerror (errno, errbuf, sizeof (errbuf)));
215 close (sockets[sockets_num].fd);
219 if (ai_ptr->ai_family == AF_INET)
221 struct sockaddr_in *addr;
225 addr = (struct sockaddr_in *) ai_ptr->ai_addr;
227 if (!IN_MULTICAST (ntohl (addr->sin_addr.s_addr)))
234 setsockopt (sockets[sockets_num].fd, IPPROTO_IP, IP_MULTICAST_LOOP,
235 (void *) &loop, sizeof (loop));
237 memset (&mreq, 0, sizeof (mreq));
238 mreq.imr_multiaddr.s_addr = addr->sin_addr.s_addr;
239 mreq.imr_interface.s_addr = htonl (INADDR_ANY);
240 setsockopt (sockets[sockets_num].fd, IPPROTO_IP, IP_ADD_MEMBERSHIP,
241 (void *) &mreq, sizeof (mreq));
242 } /* if (ai_ptr->ai_family == AF_INET) */
243 else if (ai_ptr->ai_family == AF_INET6)
245 struct sockaddr_in6 *addr;
246 struct ipv6_mreq mreq;
249 addr = (struct sockaddr_in6 *) ai_ptr->ai_addr;
251 if (!IN6_IS_ADDR_MULTICAST (&addr->sin6_addr))
258 setsockopt (sockets[sockets_num].fd, IPPROTO_IPV6, IPV6_MULTICAST_LOOP,
259 (void *) &loop, sizeof (loop));
261 memset (&mreq, 0, sizeof (mreq));
262 memcpy (&mreq.ipv6mr_multiaddr,
263 &addr->sin6_addr, sizeof (addr->sin6_addr));
264 mreq.ipv6mr_interface = 0; /* any */
265 setsockopt (sockets[sockets_num].fd, IPPROTO_IPV6, IPV6_ADD_MEMBERSHIP,
266 (void *) &mreq, sizeof (mreq));
267 } /* if (ai_ptr->ai_family == AF_INET6) */
270 } /* }}} for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next) */
272 freeaddrinfo (ai_list);
274 if ((*ret_sockets_num) >= sockets_num)
277 *ret_sockets = sockets;
278 *ret_sockets_num = sockets_num;
280 } /* }}} int create_sockets */
282 static int request_meta_data (const char *host, const char *name) /* {{{ */
284 Ganglia_metadata_msg msg;
285 char buffer[BUFF_SIZE];
286 unsigned int buffer_size;
290 memset (&msg, 0, sizeof (msg));
292 msg.id = gmetadata_request;
293 msg.Ganglia_metadata_msg_u.grequest.metric_id.host = strdup (host);
294 msg.Ganglia_metadata_msg_u.grequest.metric_id.name = strdup (name);
296 if ((msg.Ganglia_metadata_msg_u.grequest.metric_id.host == NULL)
297 || (msg.Ganglia_metadata_msg_u.grequest.metric_id.name == NULL))
299 sfree (msg.Ganglia_metadata_msg_u.grequest.metric_id.host);
300 sfree (msg.Ganglia_metadata_msg_u.grequest.metric_id.name);
304 memset (buffer, 0, sizeof (buffer));
305 xdrmem_create (&xdr, buffer, sizeof (buffer), XDR_ENCODE);
307 if (!xdr_Ganglia_metadata_msg (&xdr, &msg))
309 sfree (msg.Ganglia_metadata_msg_u.grequest.metric_id.host);
310 sfree (msg.Ganglia_metadata_msg_u.grequest.metric_id.name);
314 buffer_size = xdr_getpos (&xdr);
316 DEBUG ("gmond plugin: Requesting meta data for %s/%s.",
319 pthread_mutex_lock (&mc_send_sockets_lock);
320 for (i = 0; i < mc_send_sockets_num; i++)
321 sendto (mc_send_sockets[i].fd, buffer, (size_t) buffer_size,
323 (struct sockaddr *) &mc_send_sockets[i].addr,
324 mc_send_sockets[i].addrlen);
325 pthread_mutex_unlock (&mc_send_sockets_lock);
327 sfree (msg.Ganglia_metadata_msg_u.grequest.metric_id.host);
328 sfree (msg.Ganglia_metadata_msg_u.grequest.metric_id.name);
330 } /* }}} int request_meta_data */
332 static staging_entry_t *staging_entry_get (const char *host, /* {{{ */
334 const char *type, const char *type_instance,
337 char key[2 * DATA_MAX_NAME_LEN];
341 if (staging_tree == NULL)
344 ssnprintf (key, sizeof (key), "%s/%s/%s", host, type, type_instance);
347 status = c_avl_get (staging_tree, key, (void *) &se);
351 /* insert new entry */
352 se = (staging_entry_t *) malloc (sizeof (*se));
355 memset (se, 0, sizeof (*se));
357 sstrncpy (se->key, key, sizeof (se->key));
360 se->vl.values = (value_t *) calloc (values_len, sizeof (*se->vl.values));
361 if (se->vl.values == NULL)
366 se->vl.values_len = values_len;
370 sstrncpy (se->vl.host, host, sizeof (se->vl.host));
371 sstrncpy (se->vl.plugin, "gmond", sizeof (se->vl.plugin));
372 sstrncpy (se->vl.type, type, sizeof (se->vl.type));
373 if (type_instance != NULL)
374 sstrncpy (se->vl.type_instance, type_instance,
375 sizeof (se->vl.type_instance));
377 status = c_avl_insert (staging_tree, se->key, se);
380 ERROR ("gmond plugin: c_avl_insert failed.");
381 sfree (se->vl.values);
387 } /* }}} staging_entry_t *staging_entry_get */
389 static int staging_entry_submit (const char *host, const char *name, /* {{{ */
393 value_t values[se->vl.values_len];
395 if (se->vl.interval == 0)
397 /* No meta data has been received for this metric yet. */
399 pthread_mutex_unlock (&staging_lock);
400 request_meta_data (host, name);
406 memcpy (values, se->vl.values, sizeof (values));
407 memcpy (&vl, &se->vl, sizeof (vl));
409 /* Unlock before calling `plugin_dispatch_values'.. */
410 pthread_mutex_unlock (&staging_lock);
414 plugin_dispatch_values (&vl);
417 } /* }}} int staging_entry_submit */
419 static int staging_entry_update (const char *host, const char *name, /* {{{ */
420 const char *type, const char *type_instance,
421 int value_index, int ds_type, value_t value)
423 const data_set_t *ds;
426 ds = plugin_get_ds (type);
429 ERROR ("gmond plugin: Looking up type %s failed.", type);
433 if (ds->ds_num <= value_index)
435 ERROR ("gmond plugin: Invalid index %i: %s has only %i data source(s).",
436 value_index, ds->type, ds->ds_num);
440 pthread_mutex_lock (&staging_lock);
442 se = staging_entry_get (host, name, type, type_instance, ds->ds_num);
445 pthread_mutex_unlock (&staging_lock);
446 ERROR ("gmond plugin: staging_entry_get failed.");
449 if (se->vl.values_len != ds->ds_num)
451 pthread_mutex_unlock (&staging_lock);
455 if (ds_type == DS_TYPE_COUNTER)
456 se->vl.values[value_index].counter += value.counter;
457 else if (ds_type == DS_TYPE_GAUGE)
458 se->vl.values[value_index].gauge = value.gauge;
459 se->flags |= (0x01 << value_index);
461 DEBUG ("gmond plugin: key = %s; flags = %i;",
464 /* Check if all values have been set and submit if so. */
465 if (se->flags == ((0x01 << se->vl.values_len) - 1))
467 /* `staging_lock' is unlocked in `staging_entry_submit'. */
468 staging_entry_submit (host, name, se);
472 pthread_mutex_unlock (&staging_lock);
476 } /* }}} int staging_entry_update */
478 static int mc_handle_value_msg (Ganglia_value_msg *msg) /* {{{ */
483 value_t value_counter;
488 /* Fill in `host', `name', `value_counter', and `value_gauge' according to
489 * the value type, or return with an error. */
490 switch (msg->id) /* {{{ */
494 Ganglia_gmetric_uint msg_uint;
496 msg_uint = msg->Ganglia_value_msg_u.gu_int;
498 host = msg_uint.metric_id.host;
499 name = msg_uint.metric_id.name;
500 value_counter.counter = (counter_t) msg_uint.ui;
501 value_gauge.gauge = (gauge_t) msg_uint.ui;
507 Ganglia_gmetric_string msg_string;
510 msg_string = msg->Ganglia_value_msg_u.gstr;
512 host = msg_string.metric_id.host;
513 name = msg_string.metric_id.name;
517 value_counter.counter = (counter_t) strtoll (msg_string.str,
518 &endptr, /* base = */ 0);
519 if ((endptr == msg_string.str) || (errno != 0))
520 value_counter.counter = -1;
524 value_gauge.gauge = (gauge_t) strtod (msg_string.str, &endptr);
525 if ((endptr == msg_string.str) || (errno != 0))
526 value_gauge.gauge = NAN;
533 Ganglia_gmetric_float msg_float;
535 msg_float = msg->Ganglia_value_msg_u.gf;
537 host = msg_float.metric_id.host;
538 name = msg_float.metric_id.name;
539 value_counter.counter = (counter_t) msg_float.f;
540 value_gauge.gauge = (gauge_t) msg_float.f;
546 Ganglia_gmetric_double msg_double;
548 msg_double = msg->Ganglia_value_msg_u.gd;
550 host = msg_double.metric_id.host;
551 name = msg_double.metric_id.name;
552 value_counter.counter = (counter_t) msg_double.d;
553 value_gauge.gauge = (gauge_t) msg_double.d;
557 DEBUG ("gmond plugin: Value type not handled: %i", msg->id);
559 } /* }}} switch (msg->id) */
561 assert (host != NULL);
562 assert (name != NULL);
564 for (i = 0; i < metric_map_len; i++)
566 if (strcmp (name, metric_map[i].ganglia_name) != 0)
569 return (staging_entry_update (host, name,
570 metric_map[i].type, metric_map[i].type_instance,
571 metric_map[i].value_index, metric_map[i].ds_type,
572 (metric_map[i].ds_type == DS_TYPE_COUNTER)
577 DEBUG ("gmond plugin: Cannot find a translation for %s.", name);
580 } /* }}} int mc_handle_value_msg */
582 static int mc_handle_metadata_msg (Ganglia_metadata_msg *msg) /* {{{ */
588 Ganglia_metadatadef msg_meta;
590 const data_set_t *ds;
593 msg_meta = msg->Ganglia_metadata_msg_u.gfull;
595 if (msg_meta.metric.tmax <= 0)
598 for (i = 0; i < metric_map_len; i++)
600 if (strcmp (msg_meta.metric_id.name, metric_map[i].ganglia_name) == 0)
604 if (i >= metric_map_len)
606 DEBUG ("gmond plugin: Not handling meta data %s.",
607 msg_meta.metric_id.name);
611 ds = plugin_get_ds (metric_map[i].type);
614 WARNING ("gmond plugin: Could not find data set %s.",
619 DEBUG ("gmond plugin: Received meta data for %s/%s.",
620 msg_meta.metric_id.host, msg_meta.metric_id.name);
622 pthread_mutex_lock (&staging_lock);
623 se = staging_entry_get (msg_meta.metric_id.host,
624 msg_meta.metric_id.name,
625 metric_map[i].type, metric_map[i].type_instance,
628 se->vl.interval = (int) msg_meta.metric.tmax;
629 pthread_mutex_unlock (&staging_lock);
633 ERROR ("gmond plugin: staging_entry_get failed.");
647 } /* }}} int mc_handle_metadata_msg */
649 static int mc_handle_metric (void *buffer, size_t buffer_size) /* {{{ */
652 Ganglia_msg_formats format;
654 xdrmem_create (&xdr, buffer, buffer_size, XDR_DECODE);
656 xdr_Ganglia_msg_formats (&xdr, &format);
657 xdr_setpos (&xdr, 0);
669 Ganglia_value_msg msg;
671 memset (&msg, 0, sizeof (msg));
672 if (xdr_Ganglia_value_msg (&xdr, &msg))
673 mc_handle_value_msg (&msg);
678 case gmetadata_request:
680 Ganglia_metadata_msg msg;
681 memset (&msg, 0, sizeof (msg));
682 if (xdr_Ganglia_metadata_msg (&xdr, &msg))
683 mc_handle_metadata_msg (&msg);
688 DEBUG ("gmond plugin: Unknown format: %i", format);
690 } /* switch (format) */
694 } /* }}} int mc_handle_metric */
696 static int mc_handle_socket (struct pollfd *p) /* {{{ */
698 char buffer[BUFF_SIZE];
701 if ((p->revents & (POLLIN | POLLPRI)) == 0)
707 buffer_size = recv (p->fd, buffer, sizeof (buffer), /* flags = */ 0);
708 if (buffer_size <= 0)
711 ERROR ("gmond plugin: recv failed: %s",
712 sstrerror (errno, errbuf, sizeof (errbuf)));
717 mc_handle_metric (buffer, (size_t) buffer_size);
719 } /* }}} int mc_handle_socket */
721 static void *mc_receive_thread (void *arg) /* {{{ */
723 socket_entry_t *mc_receive_socket_entries;
727 mc_receive_socket_entries = NULL;
728 status = create_sockets (&mc_receive_socket_entries, &mc_receive_sockets_num,
729 "239.2.11.71", "8649", /* listen = */ 1);
732 ERROR ("gmond plugin: create_sockets failed.");
733 return ((void *) -1);
736 mc_receive_sockets = (struct pollfd *) calloc (mc_receive_sockets_num,
737 sizeof (*mc_receive_sockets));
738 if (mc_receive_sockets == NULL)
740 ERROR ("gmond plugin: calloc failed.");
741 for (i = 0; i < mc_receive_sockets_num; i++)
742 close (mc_receive_socket_entries[i].fd);
743 free (mc_receive_socket_entries);
744 mc_receive_socket_entries = NULL;
745 mc_receive_sockets_num = 0;
746 return ((void *) -1);
749 for (i = 0; i < mc_receive_sockets_num; i++)
751 mc_receive_sockets[i].fd = mc_receive_socket_entries[i].fd;
752 mc_receive_sockets[i].events = POLLIN | POLLPRI;
753 mc_receive_sockets[i].revents = 0;
756 while (mc_receive_thread_loop != 0)
758 status = poll (mc_receive_sockets, mc_receive_sockets_num, -1);
764 ERROR ("gmond plugin: poll failed: %s",
765 sstrerror (errno, errbuf, sizeof (errbuf)));
769 for (i = 0; i < mc_receive_sockets_num; i++)
771 if (mc_receive_sockets[i].revents != 0)
772 mc_handle_socket (mc_receive_sockets + i);
774 } /* while (mc_receive_thread_loop != 0) */
777 } /* }}} void *mc_receive_thread */
779 static int mc_receive_thread_start (void) /* {{{ */
783 if (mc_receive_thread_running != 0)
786 mc_receive_thread_loop = 1;
788 status = pthread_create (&mc_receive_thread_id, /* attr = */ NULL,
789 mc_receive_thread, /* args = */ NULL);
792 ERROR ("gmond plugin: Starting receive thread failed.");
793 mc_receive_thread_loop = 0;
797 mc_receive_thread_running = 1;
799 } /* }}} int start_receive_thread */
801 static int mc_receive_thread_stop (void) /* {{{ */
803 if (mc_receive_thread_running == 0)
806 mc_receive_thread_loop = 0;
808 INFO ("gmond plugin: Stopping receive thread.");
809 pthread_kill (mc_receive_thread_id, SIGTERM);
810 pthread_join (mc_receive_thread_id, /* return value = */ NULL);
811 memset (&mc_receive_thread_id, 0, sizeof (mc_receive_thread_id));
813 mc_receive_thread_running = 0;
816 } /* }}} int mc_receive_thread_stop */
822 * MCReceiveFrom "239.2.11.71" "8649"
823 * MCSendTo "239.2.11.71" "8649"
824 * <Metric "load_one">
826 * [TypeInstance "foo"]
832 static int gmond_init (void)
834 create_sockets (&mc_send_sockets, &mc_send_sockets_num,
835 "239.2.11.71", "8649", /* listen = */ 0);
837 staging_tree = c_avl_create ((void *) strcmp);
838 if (staging_tree == NULL)
840 ERROR ("gmond plugin: c_avl_create failed.");
844 mc_receive_thread_start ();
847 } /* int gmond_init */
849 static int gmond_shutdown (void)
853 mc_receive_thread_stop ();
855 pthread_mutex_lock (&mc_send_sockets_lock);
856 for (i = 0; i < mc_send_sockets_num; i++)
858 close (mc_send_sockets[i].fd);
859 mc_send_sockets[i].fd = -1;
861 sfree (mc_send_sockets);
862 mc_send_sockets_num = 0;
863 pthread_mutex_unlock (&mc_send_sockets_lock);
867 } /* int gmond_shutdown */
869 void module_register (void)
871 plugin_register_init ("gmond", gmond_init);
872 plugin_register_shutdown ("gmond", gmond_shutdown);
875 /* vim: set sw=2 sts=2 et fdm=marker : */