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;
86 /* Must hold metrics_lock when calling this function. */
87 static statsd_metric_t *statsd_metric_lookup_unsafe (char const *name, /* {{{ */
90 char key[DATA_MAX_NAME_LEN + 2];
92 statsd_metric_t *metric;
97 case STATSD_COUNTER: key[0] = 'c'; break;
98 case STATSD_TIMER: key[0] = 't'; break;
99 case STATSD_GAUGE: key[0] = 'g'; break;
100 case STATSD_SET: key[0] = 's'; break;
101 default: return (NULL);
105 sstrncpy (&key[2], name, sizeof (key) - 2);
107 status = c_avl_get (metrics_tree, key, (void *) &metric);
111 key_copy = strdup (key);
112 if (key_copy == NULL)
114 ERROR ("statsd plugin: strdup failed.");
118 metric = malloc (sizeof (*metric));
121 ERROR ("statsd plugin: malloc failed.");
125 memset (metric, 0, sizeof (*metric));
128 metric->latency = NULL;
131 status = c_avl_insert (metrics_tree, key_copy, metric);
134 ERROR ("statsd plugin: c_avl_insert failed.");
141 } /* }}} statsd_metric_lookup_unsafe */
143 static int statsd_metric_set (char const *name, double value, /* {{{ */
146 statsd_metric_t *metric;
148 pthread_mutex_lock (&metrics_lock);
150 metric = statsd_metric_lookup_unsafe (name, type);
153 pthread_mutex_unlock (&metrics_lock);
157 metric->value = value;
158 metric->updates_num++;
160 pthread_mutex_unlock (&metrics_lock);
163 } /* }}} int statsd_metric_set */
165 static int statsd_metric_add (char const *name, double delta, /* {{{ */
168 statsd_metric_t *metric;
170 pthread_mutex_lock (&metrics_lock);
172 metric = statsd_metric_lookup_unsafe (name, type);
175 pthread_mutex_unlock (&metrics_lock);
179 metric->value += delta;
180 metric->updates_num++;
182 pthread_mutex_unlock (&metrics_lock);
185 } /* }}} int statsd_metric_add */
187 static int statsd_parse_value (char const *str, value_t *ret_value) /* {{{ */
191 ret_value->gauge = (gauge_t) strtod (str, &endptr);
192 if ((str == endptr) || ((endptr != NULL) && (*endptr != 0)))
196 } /* }}} int statsd_parse_value */
198 static int statsd_handle_counter (char const *name, /* {{{ */
199 char const *value_str,
206 if ((extra != NULL) && (extra[0] != '@'))
212 status = statsd_parse_value (extra + 1, &scale);
216 if (!isfinite (scale.gauge) || (scale.gauge <= 0.0) || (scale.gauge > 1.0))
221 status = statsd_parse_value (value_str, &value);
225 return (statsd_metric_add (name, (double) (value.gauge / scale.gauge),
227 } /* }}} int statsd_handle_counter */
229 static int statsd_handle_gauge (char const *name, /* {{{ */
230 char const *value_str)
236 status = statsd_parse_value (value_str, &value);
240 if ((value_str[0] == '+') || (value_str[0] == '-'))
241 return (statsd_metric_add (name, (double) value.gauge, STATSD_GAUGE));
243 return (statsd_metric_set (name, (double) value.gauge, STATSD_GAUGE));
244 } /* }}} int statsd_handle_gauge */
246 static int statsd_handle_timer (char const *name, /* {{{ */
247 char const *value_str)
249 statsd_metric_t *metric;
255 status = statsd_parse_value (value_str, &value_ms);
259 value = MS_TO_CDTIME_T (value_ms.gauge);
261 pthread_mutex_lock (&metrics_lock);
263 metric = statsd_metric_lookup_unsafe (name, STATSD_TIMER);
266 pthread_mutex_unlock (&metrics_lock);
270 if (metric->latency == NULL)
271 metric->latency = latency_counter_create ();
272 if (metric->latency == NULL)
274 pthread_mutex_unlock (&metrics_lock);
278 latency_counter_add (metric->latency, value);
279 metric->updates_num++;
281 pthread_mutex_unlock (&metrics_lock);
283 } /* }}} int statsd_handle_timer */
285 static int statsd_handle_set (char const *name, /* {{{ */
286 char const *set_key_orig)
288 statsd_metric_t *metric = NULL;
292 pthread_mutex_lock (&metrics_lock);
294 metric = statsd_metric_lookup_unsafe (name, STATSD_SET);
297 pthread_mutex_unlock (&metrics_lock);
301 /* Make sure metric->set exists. */
302 if (metric->set == NULL)
303 metric->set = c_avl_create ((void *) strcmp);
305 if (metric->set == NULL)
307 pthread_mutex_unlock (&metrics_lock);
308 ERROR ("statsd plugin: c_avl_create failed.");
312 set_key = strdup (set_key_orig);
315 pthread_mutex_unlock (&metrics_lock);
316 ERROR ("statsd plugin: strdup failed.");
320 status = c_avl_insert (metric->set, set_key, /* value = */ NULL);
323 pthread_mutex_unlock (&metrics_lock);
325 ERROR ("statsd plugin: c_avl_insert (\"%s\") failed with status %i.",
330 else if (status > 0) /* key already exists */
335 metric->updates_num++;
337 pthread_mutex_unlock (&metrics_lock);
339 } /* }}} int statsd_handle_set */
341 static int statsd_parse_line (char *buffer) /* {{{ */
348 type = strchr (name, '|');
354 value = strrchr (name, ':');
360 extra = strchr (type, '|');
367 if (strcmp ("c", type) == 0)
368 return (statsd_handle_counter (name, value, extra));
370 /* extra is only valid for counters */
374 if (strcmp ("g", type) == 0)
375 return (statsd_handle_gauge (name, value));
376 else if (strcmp ("ms", type) == 0)
377 return (statsd_handle_timer (name, value));
378 else if (strcmp ("s", type) == 0)
379 return (statsd_handle_set (name, value));
382 } /* }}} void statsd_parse_line */
384 static void statsd_parse_buffer (char *buffer) /* {{{ */
386 while (buffer != NULL)
392 next = strchr (buffer, '\n');
405 sstrncpy (orig, buffer, sizeof (orig));
407 status = statsd_parse_line (buffer);
409 ERROR ("statsd plugin: Unable to parse line: \"%s\"", orig);
413 } /* }}} void statsd_parse_buffer */
415 static void statsd_network_read (int fd) /* {{{ */
421 status = recv (fd, buffer, sizeof (buffer), /* flags = */ MSG_DONTWAIT);
426 if ((errno == EAGAIN) || (errno == EWOULDBLOCK))
429 ERROR ("statsd plugin: recv(2) failed: %s",
430 sstrerror (errno, errbuf, sizeof (errbuf)));
434 buffer_size = (size_t) status;
435 if (buffer_size >= sizeof (buffer))
436 buffer_size = sizeof (buffer) - 1;
437 buffer[buffer_size] = 0;
439 statsd_parse_buffer (buffer);
440 } /* }}} void statsd_network_read */
442 static int statsd_network_init (struct pollfd **ret_fds, /* {{{ */
445 struct pollfd *fds = NULL;
448 struct addrinfo ai_hints;
449 struct addrinfo *ai_list = NULL;
450 struct addrinfo *ai_ptr;
453 char const *node = (conf_node != NULL) ? conf_node : STATSD_DEFAULT_NODE;
454 char const *service = (conf_service != NULL)
455 ? conf_service : STATSD_DEFAULT_SERVICE;
457 memset (&ai_hints, 0, sizeof (ai_hints));
458 ai_hints.ai_flags = AI_PASSIVE;
460 ai_hints.ai_flags |= AI_ADDRCONFIG;
462 ai_hints.ai_family = AF_UNSPEC;
463 ai_hints.ai_socktype = SOCK_DGRAM;
465 status = getaddrinfo (node, service, &ai_hints, &ai_list);
468 ERROR ("statsd plugin: getaddrinfo (\"%s\", \"%s\") failed: %s",
469 node, service, gai_strerror (status));
473 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
478 char dbg_node[NI_MAXHOST];
479 char dbg_service[NI_MAXSERV];
481 fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype, ai_ptr->ai_protocol);
485 ERROR ("statsd plugin: socket(2) failed: %s",
486 sstrerror (errno, errbuf, sizeof (errbuf)));
490 getnameinfo (ai_ptr->ai_addr, ai_ptr->ai_addrlen,
491 dbg_node, sizeof (dbg_node), dbg_service, sizeof (dbg_service),
492 NI_DGRAM | NI_NUMERICHOST | NI_NUMERICSERV);
493 DEBUG ("statsd plugin: Trying to bind to [%s]:%s ...", dbg_node, dbg_service);
495 status = bind (fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
499 ERROR ("statsd plugin: bind(2) failed: %s",
500 sstrerror (errno, errbuf, sizeof (errbuf)));
505 tmp = realloc (fds, sizeof (*fds) * (fds_num + 1));
508 ERROR ("statsd plugin: realloc failed.");
515 memset (tmp, 0, sizeof (*tmp));
517 tmp->events = POLLIN | POLLPRI;
520 freeaddrinfo (ai_list);
524 ERROR ("statsd plugin: Unable to create listening socket for [%s]:%s.",
525 (node != NULL) ? node : "::", service);
530 *ret_fds_num = fds_num;
532 } /* }}} int statsd_network_init */
534 static void *statsd_network_thread (void *args) /* {{{ */
536 struct pollfd *fds = NULL;
541 status = statsd_network_init (&fds, &fds_num);
544 ERROR ("statsd plugin: Unable to open listening sockets.");
545 pthread_exit ((void *) 0);
548 while (!network_thread_shutdown)
550 status = poll (fds, (nfds_t) fds_num, /* timeout = */ -1);
555 if ((errno == EINTR) || (errno == EAGAIN))
558 ERROR ("statsd plugin: poll(2) failed: %s",
559 sstrerror (errno, errbuf, sizeof (errbuf)));
563 for (i = 0; i < fds_num; i++)
565 if ((fds[i].revents & (POLLIN | POLLPRI)) == 0)
568 statsd_network_read (fds[i].fd);
571 } /* while (!network_thread_shutdown) */
574 for (i = 0; i < fds_num; i++)
579 } /* }}} void *statsd_network_thread */
581 static int statsd_config_timer_percentile (oconfig_item_t *ci) /* {{{ */
583 double percent = NAN;
587 status = cf_util_get_double (ci, &percent);
591 if ((percent <= 0.0) || (percent >= 100))
593 ERROR ("statsd plugin: The value for \"%s\" must be between 0 and 100, "
594 "exclusively.", ci->key);
598 tmp = realloc (conf_timer_percentile,
599 sizeof (*conf_timer_percentile) * (conf_timer_percentile_num + 1));
602 ERROR ("statsd plugin: realloc failed.");
605 conf_timer_percentile = tmp;
606 conf_timer_percentile[conf_timer_percentile_num] = percent;
607 conf_timer_percentile_num++;
610 } /* }}} int statsd_config_timer_percentile */
612 static int statsd_config (oconfig_item_t *ci) /* {{{ */
616 for (i = 0; i < ci->children_num; i++)
618 oconfig_item_t *child = ci->children + i;
620 if (strcasecmp ("Host", child->key) == 0)
621 cf_util_get_string (child, &conf_node);
622 else if (strcasecmp ("Port", child->key) == 0)
623 cf_util_get_service (child, &conf_service);
624 else if (strcasecmp ("DeleteCounters", child->key) == 0)
625 cf_util_get_boolean (child, &conf_delete_counters);
626 else if (strcasecmp ("DeleteTimers", child->key) == 0)
627 cf_util_get_boolean (child, &conf_delete_timers);
628 else if (strcasecmp ("DeleteGauges", child->key) == 0)
629 cf_util_get_boolean (child, &conf_delete_gauges);
630 else if (strcasecmp ("DeleteSets", child->key) == 0)
631 cf_util_get_boolean (child, &conf_delete_sets);
632 else if (strcasecmp ("TimerLower", child->key) == 0)
633 cf_util_get_boolean (child, &conf_timer_lower);
634 else if (strcasecmp ("TimerUpper", child->key) == 0)
635 cf_util_get_boolean (child, &conf_timer_upper);
636 else if (strcasecmp ("TimerSum", child->key) == 0)
637 cf_util_get_boolean (child, &conf_timer_sum);
638 else if (strcasecmp ("TimerPercentile", child->key) == 0)
639 statsd_config_timer_percentile (child);
641 ERROR ("statsd plugin: The \"%s\" config option is not valid.",
646 } /* }}} int statsd_config */
648 static int statsd_init (void) /* {{{ */
650 pthread_mutex_lock (&metrics_lock);
651 if (metrics_tree == NULL)
652 metrics_tree = c_avl_create ((void *) strcmp);
654 if (!network_thread_running)
658 status = pthread_create (&network_thread,
660 statsd_network_thread,
665 pthread_mutex_unlock (&metrics_lock);
666 ERROR ("statsd plugin: pthread_create failed: %s",
667 sstrerror (errno, errbuf, sizeof (errbuf)));
671 network_thread_running = 1;
673 pthread_mutex_unlock (&metrics_lock);
676 } /* }}} int statsd_init */
678 /* Must hold metrics_lock when calling this function. */
679 static int statsd_metric_clear_set_unsafe (statsd_metric_t *metric) /* {{{ */
684 if ((metric == NULL) || (metric->type != STATSD_SET))
687 if (metric->set == NULL)
690 while (c_avl_pick (metric->set, &key, &value) == 0)
697 } /* }}} int statsd_metric_clear_set_unsafe */
699 /* Must hold metrics_lock when calling this function. */
700 static int statsd_metric_submit_unsafe (char const *name, /* {{{ */
701 statsd_metric_t const *metric)
704 value_list_t vl = VALUE_LIST_INIT;
708 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
709 sstrncpy (vl.plugin, "statsd", sizeof (vl.plugin));
711 if (metric->type == STATSD_GAUGE)
712 sstrncpy (vl.type, "gauge", sizeof (vl.type));
713 else if (metric->type == STATSD_TIMER)
714 sstrncpy (vl.type, "latency", sizeof (vl.type));
715 else if (metric->type == STATSD_SET)
716 sstrncpy (vl.type, "objects", sizeof (vl.type));
717 else /* if (metric->type == STATSD_COUNTER) */
718 sstrncpy (vl.type, "derive", sizeof (vl.type));
720 sstrncpy (vl.type_instance, name, sizeof (vl.type_instance));
722 if (metric->type == STATSD_GAUGE)
723 values[0].gauge = (gauge_t) metric->value;
724 else if (metric->type == STATSD_TIMER)
728 if (metric->updates_num == 0)
733 ssnprintf (vl.type_instance, sizeof (vl.type_instance),
735 values[0].gauge = CDTIME_T_TO_DOUBLE (
736 latency_counter_get_average (metric->latency));
737 plugin_dispatch_values (&vl);
739 if (conf_timer_lower) {
740 ssnprintf (vl.type_instance, sizeof (vl.type_instance),
742 values[0].gauge = CDTIME_T_TO_DOUBLE (
743 latency_counter_get_min (metric->latency));
744 plugin_dispatch_values (&vl);
747 if (conf_timer_upper) {
748 ssnprintf (vl.type_instance, sizeof (vl.type_instance),
750 values[0].gauge = CDTIME_T_TO_DOUBLE (
751 latency_counter_get_max (metric->latency));
752 plugin_dispatch_values (&vl);
755 if (conf_timer_sum) {
756 ssnprintf (vl.type_instance, sizeof (vl.type_instance),
758 values[0].gauge = CDTIME_T_TO_DOUBLE (
759 latency_counter_get_sum (metric->latency));
760 plugin_dispatch_values (&vl);
763 for (i = 0; i < conf_timer_percentile_num; i++)
765 ssnprintf (vl.type_instance, sizeof (vl.type_instance),
766 "%s-percentile-%.0f", name, conf_timer_percentile[i]);
767 values[0].gauge = CDTIME_T_TO_DOUBLE (
768 latency_counter_get_percentile (
769 metric->latency, conf_timer_percentile[i]));
770 plugin_dispatch_values (&vl);
773 latency_counter_reset (metric->latency);
776 else if (metric->type == STATSD_SET)
778 if (metric->set == NULL)
779 values[0].gauge = 0.0;
781 values[0].gauge = (gauge_t) c_avl_size (metric->set);
784 values[0].derive = (derive_t) metric->value;
786 return (plugin_dispatch_values (&vl));
787 } /* }}} int statsd_metric_submit_unsafe */
789 static int statsd_read (void) /* {{{ */
791 c_avl_iterator_t *iter;
793 statsd_metric_t *metric;
795 char **to_be_deleted = NULL;
796 size_t to_be_deleted_num = 0;
799 pthread_mutex_lock (&metrics_lock);
801 if (metrics_tree == NULL)
803 pthread_mutex_unlock (&metrics_lock);
807 iter = c_avl_get_iterator (metrics_tree);
808 while (c_avl_iterator_next (iter, (void *) &name, (void *) &metric) == 0)
810 if ((metric->updates_num == 0)
811 && ((conf_delete_counters && (metric->type == STATSD_COUNTER))
812 || (conf_delete_timers && (metric->type == STATSD_TIMER))
813 || (conf_delete_gauges && (metric->type == STATSD_GAUGE))
814 || (conf_delete_sets && (metric->type == STATSD_SET))))
816 DEBUG ("statsd plugin: Deleting metric \"%s\".", name);
817 strarray_add (&to_be_deleted, &to_be_deleted_num, name);
821 /* Names have a prefix, e.g. "c:", which determines the (statsd) type.
822 * Remove this here. */
823 statsd_metric_submit_unsafe (name + 2, metric);
825 /* Reset the metric. */
826 metric->updates_num = 0;
827 if (metric->type == STATSD_SET)
828 statsd_metric_clear_set_unsafe (metric);
830 c_avl_iterator_destroy (iter);
832 for (i = 0; i < to_be_deleted_num; i++)
836 status = c_avl_remove (metrics_tree, to_be_deleted[i],
837 (void *) &name, (void *) &metric);
840 ERROR ("stats plugin: c_avl_remove (\"%s\") failed with status %i.",
841 to_be_deleted[i], status);
849 pthread_mutex_unlock (&metrics_lock);
851 strarray_free (to_be_deleted, to_be_deleted_num);
854 } /* }}} int statsd_read */
856 static int statsd_shutdown (void) /* {{{ */
861 pthread_mutex_lock (&metrics_lock);
863 if (network_thread_running)
865 network_thread_shutdown = 1;
866 pthread_kill (network_thread, SIGTERM);
867 pthread_join (network_thread, /* retval = */ NULL);
869 network_thread_running = 0;
871 while (c_avl_pick (metrics_tree, &key, &value) == 0)
876 c_avl_destroy (metrics_tree);
880 sfree (conf_service);
882 pthread_mutex_unlock (&metrics_lock);
885 } /* }}} int statsd_shutdown */
887 void module_register (void)
889 plugin_register_complex_config ("statsd", statsd_config);
890 plugin_register_init ("statsd", statsd_init);
891 plugin_register_read ("statsd", statsd_read);
892 plugin_register_shutdown ("statsd", statsd_shutdown);
895 /* vim: set sw=2 sts=2 et fdm=marker : */