2 * collectd - src/statsd.c
3 * Copyright (C) 2013 Florian octo Forster
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
24 * Florian octo Forster <octo at collectd.org>
31 #include "utils_avltree.h"
32 #include "utils_latency.h"
34 #include <sys/types.h>
38 /* AIX doesn't have MSG_DONTWAIT */
40 # define MSG_DONTWAIT MSG_NONBLOCK
43 #ifndef STATSD_DEFAULT_NODE
44 # define STATSD_DEFAULT_NODE NULL
47 #ifndef STATSD_DEFAULT_SERVICE
48 # define STATSD_DEFAULT_SERVICE "8125"
58 typedef enum metric_type_e metric_type_t;
60 struct statsd_metric_s
65 latency_counter_t *latency;
67 unsigned long updates_num;
69 typedef struct statsd_metric_s statsd_metric_t;
71 static c_avl_tree_t *metrics_tree = NULL;
72 static pthread_mutex_t metrics_lock = PTHREAD_MUTEX_INITIALIZER;
74 static pthread_t network_thread;
75 static _Bool network_thread_running = 0;
76 static _Bool network_thread_shutdown = 0;
78 static char *conf_node = NULL;
79 static char *conf_service = NULL;
81 static _Bool conf_delete_counters = 0;
82 static _Bool conf_delete_timers = 0;
83 static _Bool conf_delete_gauges = 0;
84 static _Bool conf_delete_sets = 0;
86 static double *conf_timer_percentile = NULL;
87 static size_t conf_timer_percentile_num = 0;
89 static _Bool conf_counter_sum = 0;
90 static _Bool conf_timer_lower = 0;
91 static _Bool conf_timer_upper = 0;
92 static _Bool conf_timer_sum = 0;
93 static _Bool conf_timer_count = 0;
95 /* Must hold metrics_lock when calling this function. */
96 static statsd_metric_t *statsd_metric_lookup_unsafe (char const *name, /* {{{ */
99 char key[DATA_MAX_NAME_LEN + 2];
101 statsd_metric_t *metric;
106 case STATSD_COUNTER: key[0] = 'c'; break;
107 case STATSD_TIMER: key[0] = 't'; break;
108 case STATSD_GAUGE: key[0] = 'g'; break;
109 case STATSD_SET: key[0] = 's'; break;
110 default: return (NULL);
114 sstrncpy (&key[2], name, sizeof (key) - 2);
116 status = c_avl_get (metrics_tree, key, (void *) &metric);
120 key_copy = strdup (key);
121 if (key_copy == NULL)
123 ERROR ("statsd plugin: strdup failed.");
127 metric = calloc (1, sizeof (*metric));
130 ERROR ("statsd plugin: calloc failed.");
136 metric->latency = NULL;
139 status = c_avl_insert (metrics_tree, key_copy, metric);
142 ERROR ("statsd plugin: c_avl_insert failed.");
149 } /* }}} statsd_metric_lookup_unsafe */
151 static int statsd_metric_set (char const *name, double value, /* {{{ */
154 statsd_metric_t *metric;
156 pthread_mutex_lock (&metrics_lock);
158 metric = statsd_metric_lookup_unsafe (name, type);
161 pthread_mutex_unlock (&metrics_lock);
165 metric->value = value;
166 metric->updates_num++;
168 pthread_mutex_unlock (&metrics_lock);
171 } /* }}} int statsd_metric_set */
173 static int statsd_metric_add (char const *name, double delta, /* {{{ */
176 statsd_metric_t *metric;
178 pthread_mutex_lock (&metrics_lock);
180 metric = statsd_metric_lookup_unsafe (name, type);
183 pthread_mutex_unlock (&metrics_lock);
187 metric->value += delta;
188 metric->updates_num++;
190 pthread_mutex_unlock (&metrics_lock);
193 } /* }}} int statsd_metric_add */
195 static void statsd_metric_free (statsd_metric_t *metric) /* {{{ */
200 if (metric->latency != NULL)
202 latency_counter_destroy (metric->latency);
203 metric->latency = NULL;
206 if (metric->set != NULL)
211 while (c_avl_pick (metric->set, &key, &value) == 0)
214 assert (value == NULL);
217 c_avl_destroy (metric->set);
222 } /* }}} void statsd_metric_free */
224 static int statsd_parse_value (char const *str, value_t *ret_value) /* {{{ */
228 ret_value->gauge = (gauge_t) strtod (str, &endptr);
229 if ((str == endptr) || ((endptr != NULL) && (*endptr != 0)))
233 } /* }}} int statsd_parse_value */
235 static int statsd_handle_counter (char const *name, /* {{{ */
236 char const *value_str,
243 if ((extra != NULL) && (extra[0] != '@'))
249 status = statsd_parse_value (extra + 1, &scale);
253 if (!isfinite (scale.gauge) || (scale.gauge <= 0.0) || (scale.gauge > 1.0))
258 status = statsd_parse_value (value_str, &value);
262 /* Changes to the counter are added to (statsd_metric_t*)->value. ->counter is
263 * only updated in statsd_metric_submit_unsafe(). */
264 return (statsd_metric_add (name, (double) (value.gauge / scale.gauge),
266 } /* }}} int statsd_handle_counter */
268 static int statsd_handle_gauge (char const *name, /* {{{ */
269 char const *value_str)
275 status = statsd_parse_value (value_str, &value);
279 if ((value_str[0] == '+') || (value_str[0] == '-'))
280 return (statsd_metric_add (name, (double) value.gauge, STATSD_GAUGE));
282 return (statsd_metric_set (name, (double) value.gauge, STATSD_GAUGE));
283 } /* }}} int statsd_handle_gauge */
285 static int statsd_handle_timer (char const *name, /* {{{ */
286 char const *value_str,
289 statsd_metric_t *metric;
295 if ((extra != NULL) && (extra[0] != '@'))
301 status = statsd_parse_value (extra + 1, &scale);
305 if (!isfinite (scale.gauge) || (scale.gauge <= 0.0) || (scale.gauge > 1.0))
310 status = statsd_parse_value (value_str, &value_ms);
314 value = MS_TO_CDTIME_T (value_ms.gauge / scale.gauge);
316 pthread_mutex_lock (&metrics_lock);
318 metric = statsd_metric_lookup_unsafe (name, STATSD_TIMER);
321 pthread_mutex_unlock (&metrics_lock);
325 if (metric->latency == NULL)
326 metric->latency = latency_counter_create ();
327 if (metric->latency == NULL)
329 pthread_mutex_unlock (&metrics_lock);
333 latency_counter_add (metric->latency, value);
334 metric->updates_num++;
336 pthread_mutex_unlock (&metrics_lock);
338 } /* }}} int statsd_handle_timer */
340 static int statsd_handle_set (char const *name, /* {{{ */
341 char const *set_key_orig)
343 statsd_metric_t *metric = NULL;
347 pthread_mutex_lock (&metrics_lock);
349 metric = statsd_metric_lookup_unsafe (name, STATSD_SET);
352 pthread_mutex_unlock (&metrics_lock);
356 /* Make sure metric->set exists. */
357 if (metric->set == NULL)
358 metric->set = c_avl_create ((int (*) (const void *, const void *)) strcmp);
360 if (metric->set == NULL)
362 pthread_mutex_unlock (&metrics_lock);
363 ERROR ("statsd plugin: c_avl_create failed.");
367 set_key = strdup (set_key_orig);
370 pthread_mutex_unlock (&metrics_lock);
371 ERROR ("statsd plugin: strdup failed.");
375 status = c_avl_insert (metric->set, set_key, /* value = */ NULL);
378 pthread_mutex_unlock (&metrics_lock);
380 ERROR ("statsd plugin: c_avl_insert (\"%s\") failed with status %i.",
385 else if (status > 0) /* key already exists */
390 metric->updates_num++;
392 pthread_mutex_unlock (&metrics_lock);
394 } /* }}} int statsd_handle_set */
396 static int statsd_parse_line (char *buffer) /* {{{ */
403 type = strchr (name, '|');
409 value = strrchr (name, ':');
415 extra = strchr (type, '|');
422 if (strcmp ("c", type) == 0)
423 return (statsd_handle_counter (name, value, extra));
424 else if (strcmp ("ms", type) == 0)
425 return (statsd_handle_timer (name, value, extra));
427 /* extra is only valid for counters and timers */
431 if (strcmp ("g", type) == 0)
432 return (statsd_handle_gauge (name, value));
433 else if (strcmp ("s", type) == 0)
434 return (statsd_handle_set (name, value));
437 } /* }}} void statsd_parse_line */
439 static void statsd_parse_buffer (char *buffer) /* {{{ */
441 while (buffer != NULL)
447 next = strchr (buffer, '\n');
460 sstrncpy (orig, buffer, sizeof (orig));
462 status = statsd_parse_line (buffer);
464 ERROR ("statsd plugin: Unable to parse line: \"%s\"", orig);
468 } /* }}} void statsd_parse_buffer */
470 static void statsd_network_read (int fd) /* {{{ */
476 status = recv (fd, buffer, sizeof (buffer), /* flags = */ MSG_DONTWAIT);
481 if ((errno == EAGAIN) || (errno == EWOULDBLOCK))
484 ERROR ("statsd plugin: recv(2) failed: %s",
485 sstrerror (errno, errbuf, sizeof (errbuf)));
489 buffer_size = (size_t) status;
490 if (buffer_size >= sizeof (buffer))
491 buffer_size = sizeof (buffer) - 1;
492 buffer[buffer_size] = 0;
494 statsd_parse_buffer (buffer);
495 } /* }}} void statsd_network_read */
497 static int statsd_network_init (struct pollfd **ret_fds, /* {{{ */
500 struct pollfd *fds = NULL;
503 struct addrinfo *ai_list;
506 char const *node = (conf_node != NULL) ? conf_node : STATSD_DEFAULT_NODE;
507 char const *service = (conf_service != NULL)
508 ? conf_service : STATSD_DEFAULT_SERVICE;
510 struct addrinfo ai_hints = {
511 .ai_family = AF_UNSPEC,
512 .ai_flags = AI_PASSIVE | AI_ADDRCONFIG,
513 .ai_socktype = SOCK_DGRAM
516 status = getaddrinfo (node, service, &ai_hints, &ai_list);
519 ERROR ("statsd plugin: getaddrinfo (\"%s\", \"%s\") failed: %s",
520 node, service, gai_strerror (status));
524 for (struct addrinfo *ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
529 char dbg_node[NI_MAXHOST];
530 char dbg_service[NI_MAXSERV];
532 fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype, ai_ptr->ai_protocol);
536 ERROR ("statsd plugin: socket(2) failed: %s",
537 sstrerror (errno, errbuf, sizeof (errbuf)));
541 getnameinfo (ai_ptr->ai_addr, ai_ptr->ai_addrlen,
542 dbg_node, sizeof (dbg_node), dbg_service, sizeof (dbg_service),
543 NI_DGRAM | NI_NUMERICHOST | NI_NUMERICSERV);
544 DEBUG ("statsd plugin: Trying to bind to [%s]:%s ...", dbg_node, dbg_service);
546 status = bind (fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
550 ERROR ("statsd plugin: bind(2) failed: %s",
551 sstrerror (errno, errbuf, sizeof (errbuf)));
556 tmp = realloc (fds, sizeof (*fds) * (fds_num + 1));
559 ERROR ("statsd plugin: realloc failed.");
567 memset (tmp, 0, sizeof (*tmp));
569 tmp->events = POLLIN | POLLPRI;
572 freeaddrinfo (ai_list);
576 ERROR ("statsd plugin: Unable to create listening socket for [%s]:%s.",
577 (node != NULL) ? node : "::", service);
582 *ret_fds_num = fds_num;
584 } /* }}} int statsd_network_init */
586 static void *statsd_network_thread (void *args) /* {{{ */
588 struct pollfd *fds = NULL;
592 status = statsd_network_init (&fds, &fds_num);
595 ERROR ("statsd plugin: Unable to open listening sockets.");
596 pthread_exit ((void *) 0);
599 while (!network_thread_shutdown)
601 status = poll (fds, (nfds_t) fds_num, /* timeout = */ -1);
606 if ((errno == EINTR) || (errno == EAGAIN))
609 ERROR ("statsd plugin: poll(2) failed: %s",
610 sstrerror (errno, errbuf, sizeof (errbuf)));
614 for (size_t i = 0; i < fds_num; i++)
616 if ((fds[i].revents & (POLLIN | POLLPRI)) == 0)
619 statsd_network_read (fds[i].fd);
622 } /* while (!network_thread_shutdown) */
625 for (size_t i = 0; i < fds_num; i++)
630 } /* }}} void *statsd_network_thread */
632 static int statsd_config_timer_percentile (oconfig_item_t *ci) /* {{{ */
634 double percent = NAN;
638 status = cf_util_get_double (ci, &percent);
642 if ((percent <= 0.0) || (percent >= 100))
644 ERROR ("statsd plugin: The value for \"%s\" must be between 0 and 100, "
645 "exclusively.", ci->key);
649 tmp = realloc (conf_timer_percentile,
650 sizeof (*conf_timer_percentile) * (conf_timer_percentile_num + 1));
653 ERROR ("statsd plugin: realloc failed.");
656 conf_timer_percentile = tmp;
657 conf_timer_percentile[conf_timer_percentile_num] = percent;
658 conf_timer_percentile_num++;
661 } /* }}} int statsd_config_timer_percentile */
663 static int statsd_config (oconfig_item_t *ci) /* {{{ */
665 for (int i = 0; i < ci->children_num; i++)
667 oconfig_item_t *child = ci->children + i;
669 if (strcasecmp ("Host", child->key) == 0)
670 cf_util_get_string (child, &conf_node);
671 else if (strcasecmp ("Port", child->key) == 0)
672 cf_util_get_service (child, &conf_service);
673 else if (strcasecmp ("DeleteCounters", child->key) == 0)
674 cf_util_get_boolean (child, &conf_delete_counters);
675 else if (strcasecmp ("DeleteTimers", child->key) == 0)
676 cf_util_get_boolean (child, &conf_delete_timers);
677 else if (strcasecmp ("DeleteGauges", child->key) == 0)
678 cf_util_get_boolean (child, &conf_delete_gauges);
679 else if (strcasecmp ("DeleteSets", child->key) == 0)
680 cf_util_get_boolean (child, &conf_delete_sets);
681 else if (strcasecmp ("CounterSum", child->key) == 0)
682 cf_util_get_boolean (child, &conf_counter_sum);
683 else if (strcasecmp ("TimerLower", child->key) == 0)
684 cf_util_get_boolean (child, &conf_timer_lower);
685 else if (strcasecmp ("TimerUpper", child->key) == 0)
686 cf_util_get_boolean (child, &conf_timer_upper);
687 else if (strcasecmp ("TimerSum", child->key) == 0)
688 cf_util_get_boolean (child, &conf_timer_sum);
689 else if (strcasecmp ("TimerCount", child->key) == 0)
690 cf_util_get_boolean (child, &conf_timer_count);
691 else if (strcasecmp ("TimerPercentile", child->key) == 0)
692 statsd_config_timer_percentile (child);
694 ERROR ("statsd plugin: The \"%s\" config option is not valid.",
699 } /* }}} int statsd_config */
701 static int statsd_init (void) /* {{{ */
703 pthread_mutex_lock (&metrics_lock);
704 if (metrics_tree == NULL)
705 metrics_tree = c_avl_create ((int (*) (const void *, const void *)) strcmp);
707 if (!network_thread_running)
711 status = pthread_create (&network_thread,
713 statsd_network_thread,
718 pthread_mutex_unlock (&metrics_lock);
719 ERROR ("statsd plugin: pthread_create failed: %s",
720 sstrerror (errno, errbuf, sizeof (errbuf)));
724 network_thread_running = 1;
726 pthread_mutex_unlock (&metrics_lock);
729 } /* }}} int statsd_init */
731 /* Must hold metrics_lock when calling this function. */
732 static int statsd_metric_clear_set_unsafe (statsd_metric_t *metric) /* {{{ */
737 if ((metric == NULL) || (metric->type != STATSD_SET))
740 if (metric->set == NULL)
743 while (c_avl_pick (metric->set, &key, &value) == 0)
750 } /* }}} int statsd_metric_clear_set_unsafe */
752 /* Must hold metrics_lock when calling this function. */
753 static int statsd_metric_submit_unsafe (char const *name, statsd_metric_t *metric) /* {{{ */
756 value_list_t vl = VALUE_LIST_INIT;
760 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
761 sstrncpy (vl.plugin, "statsd", sizeof (vl.plugin));
763 if (metric->type == STATSD_GAUGE)
764 sstrncpy (vl.type, "gauge", sizeof (vl.type));
765 else if (metric->type == STATSD_TIMER)
766 sstrncpy (vl.type, "latency", sizeof (vl.type));
767 else if (metric->type == STATSD_SET)
768 sstrncpy (vl.type, "objects", sizeof (vl.type));
769 else /* if (metric->type == STATSD_COUNTER) */
770 sstrncpy (vl.type, "derive", sizeof (vl.type));
772 sstrncpy (vl.type_instance, name, sizeof (vl.type_instance));
774 if (metric->type == STATSD_GAUGE)
775 values[0].gauge = (gauge_t) metric->value;
776 else if (metric->type == STATSD_TIMER)
778 _Bool have_events = (metric->updates_num > 0);
780 /* Make sure all timer metrics share the *same* timestamp. */
783 ssnprintf (vl.type_instance, sizeof (vl.type_instance),
785 values[0].gauge = have_events
786 ? CDTIME_T_TO_DOUBLE (latency_counter_get_average (metric->latency))
788 plugin_dispatch_values (&vl);
790 if (conf_timer_lower) {
791 ssnprintf (vl.type_instance, sizeof (vl.type_instance),
793 values[0].gauge = have_events
794 ? CDTIME_T_TO_DOUBLE (latency_counter_get_min (metric->latency))
796 plugin_dispatch_values (&vl);
799 if (conf_timer_upper) {
800 ssnprintf (vl.type_instance, sizeof (vl.type_instance),
802 values[0].gauge = have_events
803 ? CDTIME_T_TO_DOUBLE (latency_counter_get_max (metric->latency))
805 plugin_dispatch_values (&vl);
808 if (conf_timer_sum) {
809 ssnprintf (vl.type_instance, sizeof (vl.type_instance),
811 values[0].gauge = have_events
812 ? CDTIME_T_TO_DOUBLE (latency_counter_get_sum (metric->latency))
814 plugin_dispatch_values (&vl);
817 for (size_t i = 0; i < conf_timer_percentile_num; i++)
819 ssnprintf (vl.type_instance, sizeof (vl.type_instance),
820 "%s-percentile-%.0f", name, conf_timer_percentile[i]);
821 values[0].gauge = have_events
822 ? CDTIME_T_TO_DOUBLE (latency_counter_get_percentile (metric->latency, conf_timer_percentile[i]))
824 plugin_dispatch_values (&vl);
827 /* Keep this at the end, since vl.type is set to "gauge" here. The
828 * vl.type's above are implicitly set to "latency". */
829 if (conf_timer_count) {
830 sstrncpy (vl.type, "gauge", sizeof (vl.type));
831 ssnprintf (vl.type_instance, sizeof (vl.type_instance),
833 values[0].gauge = latency_counter_get_num (metric->latency);
834 plugin_dispatch_values (&vl);
837 latency_counter_reset (metric->latency);
840 else if (metric->type == STATSD_SET)
842 if (metric->set == NULL)
843 values[0].gauge = 0.0;
845 values[0].gauge = (gauge_t) c_avl_size (metric->set);
847 else { /* STATSD_COUNTER */
848 gauge_t delta = nearbyint (metric->value);
850 /* Etsy's statsd writes counters as two metrics: a rate and the change since
851 * the last write. Since collectd does not reset its DERIVE metrics to zero,
852 * this makes little sense, but we're dispatching a "count" metric here
853 * anyway - if requested by the user - for compatibility reasons. */
854 if (conf_counter_sum)
856 sstrncpy (vl.type, "count", sizeof (vl.type));
857 values[0].gauge = delta;
858 plugin_dispatch_values (&vl);
860 /* restore vl.type */
861 sstrncpy (vl.type, "derive", sizeof (vl.type));
864 /* Rather than resetting value to zero, subtract delta so we correctly keep
865 * track of residuals. */
866 metric->value -= delta;
867 metric->counter += (derive_t) delta;
869 values[0].derive = metric->counter;
872 return (plugin_dispatch_values (&vl));
873 } /* }}} int statsd_metric_submit_unsafe */
875 static int statsd_read (void) /* {{{ */
877 c_avl_iterator_t *iter;
879 statsd_metric_t *metric;
881 char **to_be_deleted = NULL;
882 size_t to_be_deleted_num = 0;
884 pthread_mutex_lock (&metrics_lock);
886 if (metrics_tree == NULL)
888 pthread_mutex_unlock (&metrics_lock);
892 iter = c_avl_get_iterator (metrics_tree);
893 while (c_avl_iterator_next (iter, (void *) &name, (void *) &metric) == 0)
895 if ((metric->updates_num == 0)
896 && ((conf_delete_counters && (metric->type == STATSD_COUNTER))
897 || (conf_delete_timers && (metric->type == STATSD_TIMER))
898 || (conf_delete_gauges && (metric->type == STATSD_GAUGE))
899 || (conf_delete_sets && (metric->type == STATSD_SET))))
901 DEBUG ("statsd plugin: Deleting metric \"%s\".", name);
902 strarray_add (&to_be_deleted, &to_be_deleted_num, name);
906 /* Names have a prefix, e.g. "c:", which determines the (statsd) type.
907 * Remove this here. */
908 statsd_metric_submit_unsafe (name + 2, metric);
910 /* Reset the metric. */
911 metric->updates_num = 0;
912 if (metric->type == STATSD_SET)
913 statsd_metric_clear_set_unsafe (metric);
915 c_avl_iterator_destroy (iter);
917 for (size_t i = 0; i < to_be_deleted_num; i++)
921 status = c_avl_remove (metrics_tree, to_be_deleted[i],
922 (void *) &name, (void *) &metric);
925 ERROR ("stats plugin: c_avl_remove (\"%s\") failed with status %i.",
926 to_be_deleted[i], status);
931 statsd_metric_free (metric);
934 pthread_mutex_unlock (&metrics_lock);
936 strarray_free (to_be_deleted, to_be_deleted_num);
939 } /* }}} int statsd_read */
941 static int statsd_shutdown (void) /* {{{ */
946 if (network_thread_running)
948 network_thread_shutdown = 1;
949 pthread_kill (network_thread, SIGTERM);
950 pthread_join (network_thread, /* retval = */ NULL);
952 network_thread_running = 0;
954 pthread_mutex_lock (&metrics_lock);
956 while (c_avl_pick (metrics_tree, &key, &value) == 0)
959 statsd_metric_free (value);
961 c_avl_destroy (metrics_tree);
965 sfree (conf_service);
967 pthread_mutex_unlock (&metrics_lock);
970 } /* }}} int statsd_shutdown */
972 void module_register (void)
974 plugin_register_complex_config ("statsd", statsd_config);
975 plugin_register_init ("statsd", statsd_init);
976 plugin_register_read ("statsd", statsd_read);
977 plugin_register_shutdown ("statsd", statsd_shutdown);
980 /* vim: set sw=2 sts=2 et fdm=marker : */