2 * collectd - src/statsd.c
4 * Copyright (C) 2013 Florian octo Forster
6 * Permission to use, copy, modify, and distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 * WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
15 * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
16 * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
19 * Florian octo Forster <octo at collectd.org>
25 #include "configfile.h"
26 #include "utils_avltree.h"
27 #include "utils_complain.h"
28 #include "utils_latency.h"
32 #include <sys/types.h>
33 #include <sys/socket.h>
37 /* AIX doesn't have MSG_DONTWAIT */
39 # define MSG_DONTWAIT MSG_NONBLOCK
42 #ifndef STATSD_DEFAULT_NODE
43 # define STATSD_DEFAULT_NODE NULL
46 #ifndef STATSD_DEFAULT_SERVICE
47 # define STATSD_DEFAULT_SERVICE "8125"
57 typedef enum metric_type_e metric_type_t;
59 struct statsd_metric_s
63 latency_counter_t *latency;
65 unsigned long updates_num;
67 typedef struct statsd_metric_s statsd_metric_t;
69 static c_avl_tree_t *metrics_tree = NULL;
70 static pthread_mutex_t metrics_lock = PTHREAD_MUTEX_INITIALIZER;
72 static pthread_t network_thread;
73 static _Bool network_thread_running = 0;
74 static _Bool network_thread_shutdown = 0;
76 static char *conf_node = NULL;
77 static char *conf_service = NULL;
79 static _Bool conf_delete_counters = 0;
80 static _Bool conf_delete_timers = 0;
81 static _Bool conf_delete_gauges = 0;
82 static _Bool conf_delete_sets = 0;
84 static double *conf_timer_percentile = NULL;
85 static size_t conf_timer_percentile_num = 0;
87 static _Bool conf_timer_lower = 0;
88 static _Bool conf_timer_upper = 0;
89 static _Bool conf_timer_sum = 0;
90 static _Bool conf_timer_count = 0;
92 /* Must hold metrics_lock when calling this function. */
93 static statsd_metric_t *statsd_metric_lookup_unsafe (char const *name, /* {{{ */
96 char key[DATA_MAX_NAME_LEN + 2];
98 statsd_metric_t *metric;
103 case STATSD_COUNTER: key[0] = 'c'; break;
104 case STATSD_TIMER: key[0] = 't'; break;
105 case STATSD_GAUGE: key[0] = 'g'; break;
106 case STATSD_SET: key[0] = 's'; break;
107 default: return (NULL);
111 sstrncpy (&key[2], name, sizeof (key) - 2);
113 status = c_avl_get (metrics_tree, key, (void *) &metric);
117 key_copy = strdup (key);
118 if (key_copy == NULL)
120 ERROR ("statsd plugin: strdup failed.");
124 metric = malloc (sizeof (*metric));
127 ERROR ("statsd plugin: malloc failed.");
131 memset (metric, 0, sizeof (*metric));
134 metric->latency = NULL;
137 status = c_avl_insert (metrics_tree, key_copy, metric);
140 ERROR ("statsd plugin: c_avl_insert failed.");
147 } /* }}} statsd_metric_lookup_unsafe */
149 static int statsd_metric_set (char const *name, double value, /* {{{ */
152 statsd_metric_t *metric;
154 pthread_mutex_lock (&metrics_lock);
156 metric = statsd_metric_lookup_unsafe (name, type);
159 pthread_mutex_unlock (&metrics_lock);
163 metric->value = value;
164 metric->updates_num++;
166 pthread_mutex_unlock (&metrics_lock);
169 } /* }}} int statsd_metric_set */
171 static int statsd_metric_add (char const *name, double delta, /* {{{ */
174 statsd_metric_t *metric;
176 pthread_mutex_lock (&metrics_lock);
178 metric = statsd_metric_lookup_unsafe (name, type);
181 pthread_mutex_unlock (&metrics_lock);
185 metric->value += delta;
186 metric->updates_num++;
188 pthread_mutex_unlock (&metrics_lock);
191 } /* }}} int statsd_metric_add */
193 static int statsd_parse_value (char const *str, value_t *ret_value) /* {{{ */
197 ret_value->gauge = (gauge_t) strtod (str, &endptr);
198 if ((str == endptr) || ((endptr != NULL) && (*endptr != 0)))
202 } /* }}} int statsd_parse_value */
204 static int statsd_handle_counter (char const *name, /* {{{ */
205 char const *value_str,
212 if ((extra != NULL) && (extra[0] != '@'))
218 status = statsd_parse_value (extra + 1, &scale);
222 if (!isfinite (scale.gauge) || (scale.gauge <= 0.0) || (scale.gauge > 1.0))
227 status = statsd_parse_value (value_str, &value);
231 return (statsd_metric_add (name, (double) (value.gauge / scale.gauge),
233 } /* }}} int statsd_handle_counter */
235 static int statsd_handle_gauge (char const *name, /* {{{ */
236 char const *value_str)
242 status = statsd_parse_value (value_str, &value);
246 if ((value_str[0] == '+') || (value_str[0] == '-'))
247 return (statsd_metric_add (name, (double) value.gauge, STATSD_GAUGE));
249 return (statsd_metric_set (name, (double) value.gauge, STATSD_GAUGE));
250 } /* }}} int statsd_handle_gauge */
252 static int statsd_handle_timer (char const *name, /* {{{ */
253 char const *value_str)
255 statsd_metric_t *metric;
261 status = statsd_parse_value (value_str, &value_ms);
265 value = MS_TO_CDTIME_T (value_ms.gauge);
267 pthread_mutex_lock (&metrics_lock);
269 metric = statsd_metric_lookup_unsafe (name, STATSD_TIMER);
272 pthread_mutex_unlock (&metrics_lock);
276 if (metric->latency == NULL)
277 metric->latency = latency_counter_create ();
278 if (metric->latency == NULL)
280 pthread_mutex_unlock (&metrics_lock);
284 latency_counter_add (metric->latency, value);
285 metric->updates_num++;
287 pthread_mutex_unlock (&metrics_lock);
289 } /* }}} int statsd_handle_timer */
291 static int statsd_handle_set (char const *name, /* {{{ */
292 char const *set_key_orig)
294 statsd_metric_t *metric = NULL;
298 pthread_mutex_lock (&metrics_lock);
300 metric = statsd_metric_lookup_unsafe (name, STATSD_SET);
303 pthread_mutex_unlock (&metrics_lock);
307 /* Make sure metric->set exists. */
308 if (metric->set == NULL)
309 metric->set = c_avl_create ((void *) strcmp);
311 if (metric->set == NULL)
313 pthread_mutex_unlock (&metrics_lock);
314 ERROR ("statsd plugin: c_avl_create failed.");
318 set_key = strdup (set_key_orig);
321 pthread_mutex_unlock (&metrics_lock);
322 ERROR ("statsd plugin: strdup failed.");
326 status = c_avl_insert (metric->set, set_key, /* value = */ NULL);
329 pthread_mutex_unlock (&metrics_lock);
331 ERROR ("statsd plugin: c_avl_insert (\"%s\") failed with status %i.",
336 else if (status > 0) /* key already exists */
341 metric->updates_num++;
343 pthread_mutex_unlock (&metrics_lock);
345 } /* }}} int statsd_handle_set */
347 static int statsd_parse_line (char *buffer) /* {{{ */
354 type = strchr (name, '|');
360 value = strrchr (name, ':');
366 extra = strchr (type, '|');
373 if (strcmp ("c", type) == 0)
374 return (statsd_handle_counter (name, value, extra));
376 /* extra is only valid for counters */
380 if (strcmp ("g", type) == 0)
381 return (statsd_handle_gauge (name, value));
382 else if (strcmp ("ms", type) == 0)
383 return (statsd_handle_timer (name, value));
384 else if (strcmp ("s", type) == 0)
385 return (statsd_handle_set (name, value));
388 } /* }}} void statsd_parse_line */
390 static void statsd_parse_buffer (char *buffer) /* {{{ */
392 while (buffer != NULL)
398 next = strchr (buffer, '\n');
411 sstrncpy (orig, buffer, sizeof (orig));
413 status = statsd_parse_line (buffer);
415 ERROR ("statsd plugin: Unable to parse line: \"%s\"", orig);
419 } /* }}} void statsd_parse_buffer */
421 static void statsd_network_read (int fd) /* {{{ */
427 status = recv (fd, buffer, sizeof (buffer), /* flags = */ MSG_DONTWAIT);
432 if ((errno == EAGAIN) || (errno == EWOULDBLOCK))
435 ERROR ("statsd plugin: recv(2) failed: %s",
436 sstrerror (errno, errbuf, sizeof (errbuf)));
440 buffer_size = (size_t) status;
441 if (buffer_size >= sizeof (buffer))
442 buffer_size = sizeof (buffer) - 1;
443 buffer[buffer_size] = 0;
445 statsd_parse_buffer (buffer);
446 } /* }}} void statsd_network_read */
448 static int statsd_network_init (struct pollfd **ret_fds, /* {{{ */
451 struct pollfd *fds = NULL;
454 struct addrinfo ai_hints;
455 struct addrinfo *ai_list = NULL;
456 struct addrinfo *ai_ptr;
459 char const *node = (conf_node != NULL) ? conf_node : STATSD_DEFAULT_NODE;
460 char const *service = (conf_service != NULL)
461 ? conf_service : STATSD_DEFAULT_SERVICE;
463 memset (&ai_hints, 0, sizeof (ai_hints));
464 ai_hints.ai_flags = AI_PASSIVE;
466 ai_hints.ai_flags |= AI_ADDRCONFIG;
468 ai_hints.ai_family = AF_UNSPEC;
469 ai_hints.ai_socktype = SOCK_DGRAM;
471 status = getaddrinfo (node, service, &ai_hints, &ai_list);
474 ERROR ("statsd plugin: getaddrinfo (\"%s\", \"%s\") failed: %s",
475 node, service, gai_strerror (status));
479 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
484 char dbg_node[NI_MAXHOST];
485 char dbg_service[NI_MAXSERV];
487 fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype, ai_ptr->ai_protocol);
491 ERROR ("statsd plugin: socket(2) failed: %s",
492 sstrerror (errno, errbuf, sizeof (errbuf)));
496 getnameinfo (ai_ptr->ai_addr, ai_ptr->ai_addrlen,
497 dbg_node, sizeof (dbg_node), dbg_service, sizeof (dbg_service),
498 NI_DGRAM | NI_NUMERICHOST | NI_NUMERICSERV);
499 DEBUG ("statsd plugin: Trying to bind to [%s]:%s ...", dbg_node, dbg_service);
501 status = bind (fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
505 ERROR ("statsd plugin: bind(2) failed: %s",
506 sstrerror (errno, errbuf, sizeof (errbuf)));
511 tmp = realloc (fds, sizeof (*fds) * (fds_num + 1));
514 ERROR ("statsd plugin: realloc failed.");
521 memset (tmp, 0, sizeof (*tmp));
523 tmp->events = POLLIN | POLLPRI;
526 freeaddrinfo (ai_list);
530 ERROR ("statsd plugin: Unable to create listening socket for [%s]:%s.",
531 (node != NULL) ? node : "::", service);
536 *ret_fds_num = fds_num;
538 } /* }}} int statsd_network_init */
540 static void *statsd_network_thread (void *args) /* {{{ */
542 struct pollfd *fds = NULL;
547 status = statsd_network_init (&fds, &fds_num);
550 ERROR ("statsd plugin: Unable to open listening sockets.");
551 pthread_exit ((void *) 0);
554 while (!network_thread_shutdown)
556 status = poll (fds, (nfds_t) fds_num, /* timeout = */ -1);
561 if ((errno == EINTR) || (errno == EAGAIN))
564 ERROR ("statsd plugin: poll(2) failed: %s",
565 sstrerror (errno, errbuf, sizeof (errbuf)));
569 for (i = 0; i < fds_num; i++)
571 if ((fds[i].revents & (POLLIN | POLLPRI)) == 0)
574 statsd_network_read (fds[i].fd);
577 } /* while (!network_thread_shutdown) */
580 for (i = 0; i < fds_num; i++)
585 } /* }}} void *statsd_network_thread */
587 static int statsd_config_timer_percentile (oconfig_item_t *ci) /* {{{ */
589 double percent = NAN;
593 status = cf_util_get_double (ci, &percent);
597 if ((percent <= 0.0) || (percent >= 100))
599 ERROR ("statsd plugin: The value for \"%s\" must be between 0 and 100, "
600 "exclusively.", ci->key);
604 tmp = realloc (conf_timer_percentile,
605 sizeof (*conf_timer_percentile) * (conf_timer_percentile_num + 1));
608 ERROR ("statsd plugin: realloc failed.");
611 conf_timer_percentile = tmp;
612 conf_timer_percentile[conf_timer_percentile_num] = percent;
613 conf_timer_percentile_num++;
616 } /* }}} int statsd_config_timer_percentile */
618 static int statsd_config (oconfig_item_t *ci) /* {{{ */
622 for (i = 0; i < ci->children_num; i++)
624 oconfig_item_t *child = ci->children + i;
626 if (strcasecmp ("Host", child->key) == 0)
627 cf_util_get_string (child, &conf_node);
628 else if (strcasecmp ("Port", child->key) == 0)
629 cf_util_get_service (child, &conf_service);
630 else if (strcasecmp ("DeleteCounters", child->key) == 0)
631 cf_util_get_boolean (child, &conf_delete_counters);
632 else if (strcasecmp ("DeleteTimers", child->key) == 0)
633 cf_util_get_boolean (child, &conf_delete_timers);
634 else if (strcasecmp ("DeleteGauges", child->key) == 0)
635 cf_util_get_boolean (child, &conf_delete_gauges);
636 else if (strcasecmp ("DeleteSets", child->key) == 0)
637 cf_util_get_boolean (child, &conf_delete_sets);
638 else if (strcasecmp ("TimerLower", child->key) == 0)
639 cf_util_get_boolean (child, &conf_timer_lower);
640 else if (strcasecmp ("TimerUpper", child->key) == 0)
641 cf_util_get_boolean (child, &conf_timer_upper);
642 else if (strcasecmp ("TimerSum", child->key) == 0)
643 cf_util_get_boolean (child, &conf_timer_sum);
644 else if (strcasecmp ("TimerCount", child->key) == 0)
645 cf_util_get_boolean (child, &conf_timer_count);
646 else if (strcasecmp ("TimerPercentile", child->key) == 0)
647 statsd_config_timer_percentile (child);
649 ERROR ("statsd plugin: The \"%s\" config option is not valid.",
654 } /* }}} int statsd_config */
656 static int statsd_init (void) /* {{{ */
658 pthread_mutex_lock (&metrics_lock);
659 if (metrics_tree == NULL)
660 metrics_tree = c_avl_create ((void *) strcmp);
662 if (!network_thread_running)
666 status = pthread_create (&network_thread,
668 statsd_network_thread,
673 pthread_mutex_unlock (&metrics_lock);
674 ERROR ("statsd plugin: pthread_create failed: %s",
675 sstrerror (errno, errbuf, sizeof (errbuf)));
679 network_thread_running = 1;
681 pthread_mutex_unlock (&metrics_lock);
684 } /* }}} int statsd_init */
686 /* Must hold metrics_lock when calling this function. */
687 static int statsd_metric_clear_set_unsafe (statsd_metric_t *metric) /* {{{ */
692 if ((metric == NULL) || (metric->type != STATSD_SET))
695 if (metric->set == NULL)
698 while (c_avl_pick (metric->set, &key, &value) == 0)
705 } /* }}} int statsd_metric_clear_set_unsafe */
707 /* Must hold metrics_lock when calling this function. */
708 static int statsd_metric_submit_unsafe (char const *name, /* {{{ */
709 statsd_metric_t const *metric)
712 value_list_t vl = VALUE_LIST_INIT;
716 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
717 sstrncpy (vl.plugin, "statsd", sizeof (vl.plugin));
719 if (metric->type == STATSD_GAUGE)
720 sstrncpy (vl.type, "gauge", sizeof (vl.type));
721 else if (metric->type == STATSD_TIMER)
722 sstrncpy (vl.type, "latency", sizeof (vl.type));
723 else if (metric->type == STATSD_SET)
724 sstrncpy (vl.type, "objects", sizeof (vl.type));
725 else /* if (metric->type == STATSD_COUNTER) */
726 sstrncpy (vl.type, "derive", sizeof (vl.type));
728 sstrncpy (vl.type_instance, name, sizeof (vl.type_instance));
730 if (metric->type == STATSD_GAUGE)
731 values[0].gauge = (gauge_t) metric->value;
732 else if (metric->type == STATSD_TIMER)
736 if (metric->updates_num == 0)
741 ssnprintf (vl.type_instance, sizeof (vl.type_instance),
743 values[0].gauge = CDTIME_T_TO_DOUBLE (
744 latency_counter_get_average (metric->latency));
745 plugin_dispatch_values (&vl);
747 if (conf_timer_lower) {
748 ssnprintf (vl.type_instance, sizeof (vl.type_instance),
750 values[0].gauge = CDTIME_T_TO_DOUBLE (
751 latency_counter_get_min (metric->latency));
752 plugin_dispatch_values (&vl);
755 if (conf_timer_upper) {
756 ssnprintf (vl.type_instance, sizeof (vl.type_instance),
758 values[0].gauge = CDTIME_T_TO_DOUBLE (
759 latency_counter_get_max (metric->latency));
760 plugin_dispatch_values (&vl);
763 if (conf_timer_sum) {
764 ssnprintf (vl.type_instance, sizeof (vl.type_instance),
766 values[0].gauge = CDTIME_T_TO_DOUBLE (
767 latency_counter_get_sum (metric->latency));
768 plugin_dispatch_values (&vl);
771 for (i = 0; i < conf_timer_percentile_num; i++)
773 ssnprintf (vl.type_instance, sizeof (vl.type_instance),
774 "%s-percentile-%.0f", name, conf_timer_percentile[i]);
775 values[0].gauge = CDTIME_T_TO_DOUBLE (
776 latency_counter_get_percentile (
777 metric->latency, conf_timer_percentile[i]));
778 plugin_dispatch_values (&vl);
781 /* Keep this at the end, since vl.type is set to "gauge" here. The
782 * vl.type's above are implicitly set to "latency". */
783 if (conf_timer_count) {
784 sstrncpy (vl.type, "gauge", sizeof (vl.type));
785 ssnprintf (vl.type_instance, sizeof (vl.type_instance),
787 values[0].gauge = latency_counter_get_num (metric->latency);
788 plugin_dispatch_values (&vl);
791 latency_counter_reset (metric->latency);
794 else if (metric->type == STATSD_SET)
796 if (metric->set == NULL)
797 values[0].gauge = 0.0;
799 values[0].gauge = (gauge_t) c_avl_size (metric->set);
802 values[0].derive = (derive_t) metric->value;
804 return (plugin_dispatch_values (&vl));
805 } /* }}} int statsd_metric_submit_unsafe */
807 static int statsd_read (void) /* {{{ */
809 c_avl_iterator_t *iter;
811 statsd_metric_t *metric;
813 char **to_be_deleted = NULL;
814 size_t to_be_deleted_num = 0;
817 pthread_mutex_lock (&metrics_lock);
819 if (metrics_tree == NULL)
821 pthread_mutex_unlock (&metrics_lock);
825 iter = c_avl_get_iterator (metrics_tree);
826 while (c_avl_iterator_next (iter, (void *) &name, (void *) &metric) == 0)
828 if ((metric->updates_num == 0)
829 && ((conf_delete_counters && (metric->type == STATSD_COUNTER))
830 || (conf_delete_timers && (metric->type == STATSD_TIMER))
831 || (conf_delete_gauges && (metric->type == STATSD_GAUGE))
832 || (conf_delete_sets && (metric->type == STATSD_SET))))
834 DEBUG ("statsd plugin: Deleting metric \"%s\".", name);
835 strarray_add (&to_be_deleted, &to_be_deleted_num, name);
839 /* Names have a prefix, e.g. "c:", which determines the (statsd) type.
840 * Remove this here. */
841 statsd_metric_submit_unsafe (name + 2, metric);
843 /* Reset the metric. */
844 metric->updates_num = 0;
845 if (metric->type == STATSD_SET)
846 statsd_metric_clear_set_unsafe (metric);
848 c_avl_iterator_destroy (iter);
850 for (i = 0; i < to_be_deleted_num; i++)
854 status = c_avl_remove (metrics_tree, to_be_deleted[i],
855 (void *) &name, (void *) &metric);
858 ERROR ("stats plugin: c_avl_remove (\"%s\") failed with status %i.",
859 to_be_deleted[i], status);
867 pthread_mutex_unlock (&metrics_lock);
869 strarray_free (to_be_deleted, to_be_deleted_num);
872 } /* }}} int statsd_read */
874 static int statsd_shutdown (void) /* {{{ */
879 pthread_mutex_lock (&metrics_lock);
881 if (network_thread_running)
883 network_thread_shutdown = 1;
884 pthread_kill (network_thread, SIGTERM);
885 pthread_join (network_thread, /* retval = */ NULL);
887 network_thread_running = 0;
889 while (c_avl_pick (metrics_tree, &key, &value) == 0)
894 c_avl_destroy (metrics_tree);
898 sfree (conf_service);
900 pthread_mutex_unlock (&metrics_lock);
903 } /* }}} int statsd_shutdown */
905 void module_register (void)
907 plugin_register_complex_config ("statsd", statsd_config);
908 plugin_register_init ("statsd", statsd_init);
909 plugin_register_read ("statsd", statsd_read);
910 plugin_register_shutdown ("statsd", statsd_shutdown);
913 /* vim: set sw=2 sts=2 et fdm=marker : */