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 #ifndef STATSD_DEFAULT_NODE
38 # define STATSD_DEFAULT_NODE NULL
41 #ifndef STATSD_DEFAULT_SERVICE
42 # define STATSD_DEFAULT_SERVICE "8125"
52 typedef enum metric_type_e metric_type_t;
54 struct statsd_metric_s
58 latency_counter_t *latency;
60 unsigned long updates_num;
62 typedef struct statsd_metric_s statsd_metric_t;
64 static c_avl_tree_t *metrics_tree = NULL;
65 static pthread_mutex_t metrics_lock = PTHREAD_MUTEX_INITIALIZER;
67 static pthread_t network_thread;
68 static _Bool network_thread_running = 0;
69 static _Bool network_thread_shutdown = 0;
71 static char *conf_node = NULL;
72 static char *conf_service = NULL;
74 static _Bool conf_delete_counters = 0;
75 static _Bool conf_delete_timers = 0;
76 static _Bool conf_delete_gauges = 0;
77 static _Bool conf_delete_sets = 0;
79 static double *conf_timer_percentile = NULL;
80 static size_t conf_timer_percentile_num = 0;
82 static _Bool conf_timer_lower = 0;
83 static _Bool conf_timer_upper = 0;
84 static _Bool conf_timer_sum = 0;
85 static _Bool conf_timer_count = 0;
87 /* Must hold metrics_lock when calling this function. */
88 static statsd_metric_t *statsd_metric_lookup_unsafe (char const *name, /* {{{ */
91 char key[DATA_MAX_NAME_LEN + 2];
93 statsd_metric_t *metric;
98 case STATSD_COUNTER: key[0] = 'c'; break;
99 case STATSD_TIMER: key[0] = 't'; break;
100 case STATSD_GAUGE: key[0] = 'g'; break;
101 case STATSD_SET: key[0] = 's'; break;
102 default: return (NULL);
106 sstrncpy (&key[2], name, sizeof (key) - 2);
108 status = c_avl_get (metrics_tree, key, (void *) &metric);
112 key_copy = strdup (key);
113 if (key_copy == NULL)
115 ERROR ("statsd plugin: strdup failed.");
119 metric = malloc (sizeof (*metric));
122 ERROR ("statsd plugin: malloc failed.");
126 memset (metric, 0, sizeof (*metric));
129 metric->latency = NULL;
132 status = c_avl_insert (metrics_tree, key_copy, metric);
135 ERROR ("statsd plugin: c_avl_insert failed.");
142 } /* }}} statsd_metric_lookup_unsafe */
144 static int statsd_metric_set (char const *name, double value, /* {{{ */
147 statsd_metric_t *metric;
149 pthread_mutex_lock (&metrics_lock);
151 metric = statsd_metric_lookup_unsafe (name, type);
154 pthread_mutex_unlock (&metrics_lock);
158 metric->value = value;
159 metric->updates_num++;
161 pthread_mutex_unlock (&metrics_lock);
164 } /* }}} int statsd_metric_set */
166 static int statsd_metric_add (char const *name, double delta, /* {{{ */
169 statsd_metric_t *metric;
171 pthread_mutex_lock (&metrics_lock);
173 metric = statsd_metric_lookup_unsafe (name, type);
176 pthread_mutex_unlock (&metrics_lock);
180 metric->value += delta;
181 metric->updates_num++;
183 pthread_mutex_unlock (&metrics_lock);
186 } /* }}} int statsd_metric_add */
188 static int statsd_parse_value (char const *str, value_t *ret_value) /* {{{ */
192 ret_value->gauge = (gauge_t) strtod (str, &endptr);
193 if ((str == endptr) || ((endptr != NULL) && (*endptr != 0)))
197 } /* }}} int statsd_parse_value */
199 static int statsd_handle_counter (char const *name, /* {{{ */
200 char const *value_str,
207 if ((extra != NULL) && (extra[0] != '@'))
213 status = statsd_parse_value (extra + 1, &scale);
217 if (!isfinite (scale.gauge) || (scale.gauge <= 0.0) || (scale.gauge > 1.0))
222 status = statsd_parse_value (value_str, &value);
226 return (statsd_metric_add (name, (double) (value.gauge / scale.gauge),
228 } /* }}} int statsd_handle_counter */
230 static int statsd_handle_gauge (char const *name, /* {{{ */
231 char const *value_str)
237 status = statsd_parse_value (value_str, &value);
241 if ((value_str[0] == '+') || (value_str[0] == '-'))
242 return (statsd_metric_add (name, (double) value.gauge, STATSD_GAUGE));
244 return (statsd_metric_set (name, (double) value.gauge, STATSD_GAUGE));
245 } /* }}} int statsd_handle_gauge */
247 static int statsd_handle_timer (char const *name, /* {{{ */
248 char const *value_str)
250 statsd_metric_t *metric;
256 status = statsd_parse_value (value_str, &value_ms);
260 value = MS_TO_CDTIME_T (value_ms.gauge);
262 pthread_mutex_lock (&metrics_lock);
264 metric = statsd_metric_lookup_unsafe (name, STATSD_TIMER);
267 pthread_mutex_unlock (&metrics_lock);
271 if (metric->latency == NULL)
272 metric->latency = latency_counter_create ();
273 if (metric->latency == NULL)
275 pthread_mutex_unlock (&metrics_lock);
279 latency_counter_add (metric->latency, value);
280 metric->updates_num++;
282 pthread_mutex_unlock (&metrics_lock);
284 } /* }}} int statsd_handle_timer */
286 static int statsd_handle_set (char const *name, /* {{{ */
287 char const *set_key_orig)
289 statsd_metric_t *metric = NULL;
293 pthread_mutex_lock (&metrics_lock);
295 metric = statsd_metric_lookup_unsafe (name, STATSD_SET);
298 pthread_mutex_unlock (&metrics_lock);
302 /* Make sure metric->set exists. */
303 if (metric->set == NULL)
304 metric->set = c_avl_create ((void *) strcmp);
306 if (metric->set == NULL)
308 pthread_mutex_unlock (&metrics_lock);
309 ERROR ("statsd plugin: c_avl_create failed.");
313 set_key = strdup (set_key_orig);
316 pthread_mutex_unlock (&metrics_lock);
317 ERROR ("statsd plugin: strdup failed.");
321 status = c_avl_insert (metric->set, set_key, /* value = */ NULL);
324 pthread_mutex_unlock (&metrics_lock);
326 ERROR ("statsd plugin: c_avl_insert (\"%s\") failed with status %i.",
331 else if (status > 0) /* key already exists */
336 metric->updates_num++;
338 pthread_mutex_unlock (&metrics_lock);
340 } /* }}} int statsd_handle_set */
342 static int statsd_parse_line (char *buffer) /* {{{ */
349 type = strchr (name, '|');
355 value = strrchr (name, ':');
361 extra = strchr (type, '|');
368 if (strcmp ("c", type) == 0)
369 return (statsd_handle_counter (name, value, extra));
371 /* extra is only valid for counters */
375 if (strcmp ("g", type) == 0)
376 return (statsd_handle_gauge (name, value));
377 else if (strcmp ("ms", type) == 0)
378 return (statsd_handle_timer (name, value));
379 else if (strcmp ("s", type) == 0)
380 return (statsd_handle_set (name, value));
383 } /* }}} void statsd_parse_line */
385 static void statsd_parse_buffer (char *buffer) /* {{{ */
387 while (buffer != NULL)
393 next = strchr (buffer, '\n');
406 sstrncpy (orig, buffer, sizeof (orig));
408 status = statsd_parse_line (buffer);
410 ERROR ("statsd plugin: Unable to parse line: \"%s\"", orig);
414 } /* }}} void statsd_parse_buffer */
416 static void statsd_network_read (int fd) /* {{{ */
422 status = recv (fd, buffer, sizeof (buffer), /* flags = */ MSG_DONTWAIT);
427 if ((errno == EAGAIN) || (errno == EWOULDBLOCK))
430 ERROR ("statsd plugin: recv(2) failed: %s",
431 sstrerror (errno, errbuf, sizeof (errbuf)));
435 buffer_size = (size_t) status;
436 if (buffer_size >= sizeof (buffer))
437 buffer_size = sizeof (buffer) - 1;
438 buffer[buffer_size] = 0;
440 statsd_parse_buffer (buffer);
441 } /* }}} void statsd_network_read */
443 static int statsd_network_init (struct pollfd **ret_fds, /* {{{ */
446 struct pollfd *fds = NULL;
449 struct addrinfo ai_hints;
450 struct addrinfo *ai_list = NULL;
451 struct addrinfo *ai_ptr;
454 char const *node = (conf_node != NULL) ? conf_node : STATSD_DEFAULT_NODE;
455 char const *service = (conf_service != NULL)
456 ? conf_service : STATSD_DEFAULT_SERVICE;
458 memset (&ai_hints, 0, sizeof (ai_hints));
459 ai_hints.ai_flags = AI_PASSIVE;
461 ai_hints.ai_flags |= AI_ADDRCONFIG;
463 ai_hints.ai_family = AF_UNSPEC;
464 ai_hints.ai_socktype = SOCK_DGRAM;
466 status = getaddrinfo (node, service, &ai_hints, &ai_list);
469 ERROR ("statsd plugin: getaddrinfo (\"%s\", \"%s\") failed: %s",
470 node, service, gai_strerror (status));
474 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
479 char dbg_node[NI_MAXHOST];
480 char dbg_service[NI_MAXSERV];
482 fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype, ai_ptr->ai_protocol);
486 ERROR ("statsd plugin: socket(2) failed: %s",
487 sstrerror (errno, errbuf, sizeof (errbuf)));
491 getnameinfo (ai_ptr->ai_addr, ai_ptr->ai_addrlen,
492 dbg_node, sizeof (dbg_node), dbg_service, sizeof (dbg_service),
493 NI_DGRAM | NI_NUMERICHOST | NI_NUMERICSERV);
494 DEBUG ("statsd plugin: Trying to bind to [%s]:%s ...", dbg_node, dbg_service);
496 status = bind (fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
500 ERROR ("statsd plugin: bind(2) failed: %s",
501 sstrerror (errno, errbuf, sizeof (errbuf)));
506 tmp = realloc (fds, sizeof (*fds) * (fds_num + 1));
509 ERROR ("statsd plugin: realloc failed.");
516 memset (tmp, 0, sizeof (*tmp));
518 tmp->events = POLLIN | POLLPRI;
521 freeaddrinfo (ai_list);
525 ERROR ("statsd plugin: Unable to create listening socket for [%s]:%s.",
526 (node != NULL) ? node : "::", service);
531 *ret_fds_num = fds_num;
533 } /* }}} int statsd_network_init */
535 static void *statsd_network_thread (void *args) /* {{{ */
537 struct pollfd *fds = NULL;
542 status = statsd_network_init (&fds, &fds_num);
545 ERROR ("statsd plugin: Unable to open listening sockets.");
546 pthread_exit ((void *) 0);
549 while (!network_thread_shutdown)
551 status = poll (fds, (nfds_t) fds_num, /* timeout = */ -1);
556 if ((errno == EINTR) || (errno == EAGAIN))
559 ERROR ("statsd plugin: poll(2) failed: %s",
560 sstrerror (errno, errbuf, sizeof (errbuf)));
564 for (i = 0; i < fds_num; i++)
566 if ((fds[i].revents & (POLLIN | POLLPRI)) == 0)
569 statsd_network_read (fds[i].fd);
572 } /* while (!network_thread_shutdown) */
575 for (i = 0; i < fds_num; i++)
580 } /* }}} void *statsd_network_thread */
582 static int statsd_config_timer_percentile (oconfig_item_t *ci) /* {{{ */
584 double percent = NAN;
588 status = cf_util_get_double (ci, &percent);
592 if ((percent <= 0.0) || (percent >= 100))
594 ERROR ("statsd plugin: The value for \"%s\" must be between 0 and 100, "
595 "exclusively.", ci->key);
599 tmp = realloc (conf_timer_percentile,
600 sizeof (*conf_timer_percentile) * (conf_timer_percentile_num + 1));
603 ERROR ("statsd plugin: realloc failed.");
606 conf_timer_percentile = tmp;
607 conf_timer_percentile[conf_timer_percentile_num] = percent;
608 conf_timer_percentile_num++;
611 } /* }}} int statsd_config_timer_percentile */
613 static int statsd_config (oconfig_item_t *ci) /* {{{ */
617 for (i = 0; i < ci->children_num; i++)
619 oconfig_item_t *child = ci->children + i;
621 if (strcasecmp ("Host", child->key) == 0)
622 cf_util_get_string (child, &conf_node);
623 else if (strcasecmp ("Port", child->key) == 0)
624 cf_util_get_service (child, &conf_service);
625 else if (strcasecmp ("DeleteCounters", child->key) == 0)
626 cf_util_get_boolean (child, &conf_delete_counters);
627 else if (strcasecmp ("DeleteTimers", child->key) == 0)
628 cf_util_get_boolean (child, &conf_delete_timers);
629 else if (strcasecmp ("DeleteGauges", child->key) == 0)
630 cf_util_get_boolean (child, &conf_delete_gauges);
631 else if (strcasecmp ("DeleteSets", child->key) == 0)
632 cf_util_get_boolean (child, &conf_delete_sets);
633 else if (strcasecmp ("TimerLower", child->key) == 0)
634 cf_util_get_boolean (child, &conf_timer_lower);
635 else if (strcasecmp ("TimerUpper", child->key) == 0)
636 cf_util_get_boolean (child, &conf_timer_upper);
637 else if (strcasecmp ("TimerSum", child->key) == 0)
638 cf_util_get_boolean (child, &conf_timer_sum);
639 else if (strcasecmp ("TimerCount", child->key) == 0)
640 cf_util_get_boolean (child, &conf_timer_count);
641 else if (strcasecmp ("TimerPercentile", child->key) == 0)
642 statsd_config_timer_percentile (child);
644 ERROR ("statsd plugin: The \"%s\" config option is not valid.",
649 } /* }}} int statsd_config */
651 static int statsd_init (void) /* {{{ */
653 pthread_mutex_lock (&metrics_lock);
654 if (metrics_tree == NULL)
655 metrics_tree = c_avl_create ((void *) strcmp);
657 if (!network_thread_running)
661 status = pthread_create (&network_thread,
663 statsd_network_thread,
668 pthread_mutex_unlock (&metrics_lock);
669 ERROR ("statsd plugin: pthread_create failed: %s",
670 sstrerror (errno, errbuf, sizeof (errbuf)));
674 network_thread_running = 1;
676 pthread_mutex_unlock (&metrics_lock);
679 } /* }}} int statsd_init */
681 /* Must hold metrics_lock when calling this function. */
682 static int statsd_metric_clear_set_unsafe (statsd_metric_t *metric) /* {{{ */
687 if ((metric == NULL) || (metric->type != STATSD_SET))
690 if (metric->set == NULL)
693 while (c_avl_pick (metric->set, &key, &value) == 0)
700 } /* }}} int statsd_metric_clear_set_unsafe */
702 /* Must hold metrics_lock when calling this function. */
703 static int statsd_metric_submit_unsafe (char const *name, /* {{{ */
704 statsd_metric_t const *metric)
707 value_list_t vl = VALUE_LIST_INIT;
711 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
712 sstrncpy (vl.plugin, "statsd", sizeof (vl.plugin));
714 if (metric->type == STATSD_GAUGE)
715 sstrncpy (vl.type, "gauge", sizeof (vl.type));
716 else if (metric->type == STATSD_TIMER)
717 sstrncpy (vl.type, "latency", sizeof (vl.type));
718 else if (metric->type == STATSD_SET)
719 sstrncpy (vl.type, "objects", sizeof (vl.type));
720 else /* if (metric->type == STATSD_COUNTER) */
721 sstrncpy (vl.type, "derive", sizeof (vl.type));
723 sstrncpy (vl.type_instance, name, sizeof (vl.type_instance));
725 if (metric->type == STATSD_GAUGE)
726 values[0].gauge = (gauge_t) metric->value;
727 else if (metric->type == STATSD_TIMER)
731 if (metric->updates_num == 0)
736 ssnprintf (vl.type_instance, sizeof (vl.type_instance),
738 values[0].gauge = CDTIME_T_TO_DOUBLE (
739 latency_counter_get_average (metric->latency));
740 plugin_dispatch_values (&vl);
742 if (conf_timer_lower) {
743 ssnprintf (vl.type_instance, sizeof (vl.type_instance),
745 values[0].gauge = CDTIME_T_TO_DOUBLE (
746 latency_counter_get_min (metric->latency));
747 plugin_dispatch_values (&vl);
750 if (conf_timer_upper) {
751 ssnprintf (vl.type_instance, sizeof (vl.type_instance),
753 values[0].gauge = CDTIME_T_TO_DOUBLE (
754 latency_counter_get_max (metric->latency));
755 plugin_dispatch_values (&vl);
758 if (conf_timer_sum) {
759 ssnprintf (vl.type_instance, sizeof (vl.type_instance),
761 values[0].gauge = CDTIME_T_TO_DOUBLE (
762 latency_counter_get_sum (metric->latency));
763 plugin_dispatch_values (&vl);
766 for (i = 0; i < conf_timer_percentile_num; i++)
768 ssnprintf (vl.type_instance, sizeof (vl.type_instance),
769 "%s-percentile-%.0f", name, conf_timer_percentile[i]);
770 values[0].gauge = CDTIME_T_TO_DOUBLE (
771 latency_counter_get_percentile (
772 metric->latency, conf_timer_percentile[i]));
773 plugin_dispatch_values (&vl);
776 /* Keep this at the end, since vl.type is set to "gauge" here. The
777 * vl.type's above are implicitly set to "latency". */
778 if (conf_timer_count) {
779 sstrncpy (vl.type, "gauge", sizeof (vl.type));
780 ssnprintf (vl.type_instance, sizeof (vl.type_instance),
782 values[0].gauge = latency_counter_get_num (metric->latency);
783 plugin_dispatch_values (&vl);
786 latency_counter_reset (metric->latency);
789 else if (metric->type == STATSD_SET)
791 if (metric->set == NULL)
792 values[0].gauge = 0.0;
794 values[0].gauge = (gauge_t) c_avl_size (metric->set);
797 values[0].derive = (derive_t) metric->value;
799 return (plugin_dispatch_values (&vl));
800 } /* }}} int statsd_metric_submit_unsafe */
802 static int statsd_read (void) /* {{{ */
804 c_avl_iterator_t *iter;
806 statsd_metric_t *metric;
808 char **to_be_deleted = NULL;
809 size_t to_be_deleted_num = 0;
812 pthread_mutex_lock (&metrics_lock);
814 if (metrics_tree == NULL)
816 pthread_mutex_unlock (&metrics_lock);
820 iter = c_avl_get_iterator (metrics_tree);
821 while (c_avl_iterator_next (iter, (void *) &name, (void *) &metric) == 0)
823 if ((metric->updates_num == 0)
824 && ((conf_delete_counters && (metric->type == STATSD_COUNTER))
825 || (conf_delete_timers && (metric->type == STATSD_TIMER))
826 || (conf_delete_gauges && (metric->type == STATSD_GAUGE))
827 || (conf_delete_sets && (metric->type == STATSD_SET))))
829 DEBUG ("statsd plugin: Deleting metric \"%s\".", name);
830 strarray_add (&to_be_deleted, &to_be_deleted_num, name);
834 /* Names have a prefix, e.g. "c:", which determines the (statsd) type.
835 * Remove this here. */
836 statsd_metric_submit_unsafe (name + 2, metric);
838 /* Reset the metric. */
839 metric->updates_num = 0;
840 if (metric->type == STATSD_SET)
841 statsd_metric_clear_set_unsafe (metric);
843 c_avl_iterator_destroy (iter);
845 for (i = 0; i < to_be_deleted_num; i++)
849 status = c_avl_remove (metrics_tree, to_be_deleted[i],
850 (void *) &name, (void *) &metric);
853 ERROR ("stats plugin: c_avl_remove (\"%s\") failed with status %i.",
854 to_be_deleted[i], status);
862 pthread_mutex_unlock (&metrics_lock);
864 strarray_free (to_be_deleted, to_be_deleted_num);
867 } /* }}} int statsd_read */
869 static int statsd_shutdown (void) /* {{{ */
874 pthread_mutex_lock (&metrics_lock);
876 if (network_thread_running)
878 network_thread_shutdown = 1;
879 pthread_kill (network_thread, SIGTERM);
880 pthread_join (network_thread, /* retval = */ NULL);
882 network_thread_running = 0;
884 while (c_avl_pick (metrics_tree, &key, &value) == 0)
889 c_avl_destroy (metrics_tree);
893 sfree (conf_service);
895 pthread_mutex_unlock (&metrics_lock);
898 } /* }}} int statsd_shutdown */
900 void module_register (void)
902 plugin_register_complex_config ("statsd", statsd_config);
903 plugin_register_init ("statsd", statsd_init);
904 plugin_register_read ("statsd", statsd_read);
905 plugin_register_shutdown ("statsd", statsd_shutdown);
908 /* vim: set sw=2 sts=2 et fdm=marker : */