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>
30 #include "configfile.h"
31 #include "utils_avltree.h"
32 #include "utils_complain.h"
33 #include "utils_latency.h"
37 #include <sys/types.h>
41 /* AIX doesn't have MSG_DONTWAIT */
43 # define MSG_DONTWAIT MSG_NONBLOCK
46 #ifndef STATSD_DEFAULT_NODE
47 # define STATSD_DEFAULT_NODE NULL
50 #ifndef STATSD_DEFAULT_SERVICE
51 # define STATSD_DEFAULT_SERVICE "8125"
61 typedef enum metric_type_e metric_type_t;
63 struct statsd_metric_s
67 latency_counter_t *latency;
69 unsigned long updates_num;
71 typedef struct statsd_metric_s statsd_metric_t;
73 static c_avl_tree_t *metrics_tree = NULL;
74 static pthread_mutex_t metrics_lock = PTHREAD_MUTEX_INITIALIZER;
76 static pthread_t network_thread;
77 static _Bool network_thread_running = 0;
78 static _Bool network_thread_shutdown = 0;
80 static char *conf_node = NULL;
81 static char *conf_service = NULL;
83 static _Bool conf_delete_counters = 0;
84 static _Bool conf_delete_timers = 0;
85 static _Bool conf_delete_gauges = 0;
86 static _Bool conf_delete_sets = 0;
88 static double *conf_timer_percentile = NULL;
89 static size_t conf_timer_percentile_num = 0;
91 static _Bool conf_timer_lower = 0;
92 static _Bool conf_timer_upper = 0;
93 static _Bool conf_timer_sum = 0;
94 static _Bool conf_timer_count = 0;
96 /* Must hold metrics_lock when calling this function. */
97 static statsd_metric_t *statsd_metric_lookup_unsafe (char const *name, /* {{{ */
100 char key[DATA_MAX_NAME_LEN + 2];
102 statsd_metric_t *metric;
107 case STATSD_COUNTER: key[0] = 'c'; break;
108 case STATSD_TIMER: key[0] = 't'; break;
109 case STATSD_GAUGE: key[0] = 'g'; break;
110 case STATSD_SET: key[0] = 's'; break;
111 default: return (NULL);
115 sstrncpy (&key[2], name, sizeof (key) - 2);
117 status = c_avl_get (metrics_tree, key, (void *) &metric);
121 key_copy = strdup (key);
122 if (key_copy == NULL)
124 ERROR ("statsd plugin: strdup failed.");
128 metric = malloc (sizeof (*metric));
131 ERROR ("statsd plugin: malloc failed.");
135 memset (metric, 0, sizeof (*metric));
138 metric->latency = NULL;
141 status = c_avl_insert (metrics_tree, key_copy, metric);
144 ERROR ("statsd plugin: c_avl_insert failed.");
151 } /* }}} statsd_metric_lookup_unsafe */
153 static int statsd_metric_set (char const *name, double value, /* {{{ */
156 statsd_metric_t *metric;
158 pthread_mutex_lock (&metrics_lock);
160 metric = statsd_metric_lookup_unsafe (name, type);
163 pthread_mutex_unlock (&metrics_lock);
167 metric->value = value;
168 metric->updates_num++;
170 pthread_mutex_unlock (&metrics_lock);
173 } /* }}} int statsd_metric_set */
175 static int statsd_metric_add (char const *name, double delta, /* {{{ */
178 statsd_metric_t *metric;
180 pthread_mutex_lock (&metrics_lock);
182 metric = statsd_metric_lookup_unsafe (name, type);
185 pthread_mutex_unlock (&metrics_lock);
189 metric->value += delta;
190 metric->updates_num++;
192 pthread_mutex_unlock (&metrics_lock);
195 } /* }}} int statsd_metric_add */
197 static void statsd_metric_free (statsd_metric_t *metric) /* {{{ */
202 if (metric->latency != NULL)
204 latency_counter_destroy (metric->latency);
205 metric->latency = NULL;
208 if (metric->set != NULL)
213 while (c_avl_pick (metric->set, &key, &value) == 0)
216 assert (value == NULL);
219 c_avl_destroy (metric->set);
224 } /* }}} void statsd_metric_free */
226 static int statsd_parse_value (char const *str, value_t *ret_value) /* {{{ */
230 ret_value->gauge = (gauge_t) strtod (str, &endptr);
231 if ((str == endptr) || ((endptr != NULL) && (*endptr != 0)))
235 } /* }}} int statsd_parse_value */
237 static int statsd_handle_counter (char const *name, /* {{{ */
238 char const *value_str,
245 if ((extra != NULL) && (extra[0] != '@'))
251 status = statsd_parse_value (extra + 1, &scale);
255 if (!isfinite (scale.gauge) || (scale.gauge <= 0.0) || (scale.gauge > 1.0))
260 status = statsd_parse_value (value_str, &value);
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 ((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_hints;
504 struct addrinfo *ai_list = NULL;
505 struct addrinfo *ai_ptr;
508 char const *node = (conf_node != NULL) ? conf_node : STATSD_DEFAULT_NODE;
509 char const *service = (conf_service != NULL)
510 ? conf_service : STATSD_DEFAULT_SERVICE;
512 memset (&ai_hints, 0, sizeof (ai_hints));
513 ai_hints.ai_flags = AI_PASSIVE;
515 ai_hints.ai_flags |= AI_ADDRCONFIG;
517 ai_hints.ai_family = AF_UNSPEC;
518 ai_hints.ai_socktype = SOCK_DGRAM;
520 status = getaddrinfo (node, service, &ai_hints, &ai_list);
523 ERROR ("statsd plugin: getaddrinfo (\"%s\", \"%s\") failed: %s",
524 node, service, gai_strerror (status));
528 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
533 char dbg_node[NI_MAXHOST];
534 char dbg_service[NI_MAXSERV];
536 fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype, ai_ptr->ai_protocol);
540 ERROR ("statsd plugin: socket(2) failed: %s",
541 sstrerror (errno, errbuf, sizeof (errbuf)));
545 getnameinfo (ai_ptr->ai_addr, ai_ptr->ai_addrlen,
546 dbg_node, sizeof (dbg_node), dbg_service, sizeof (dbg_service),
547 NI_DGRAM | NI_NUMERICHOST | NI_NUMERICSERV);
548 DEBUG ("statsd plugin: Trying to bind to [%s]:%s ...", dbg_node, dbg_service);
550 status = bind (fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
554 ERROR ("statsd plugin: bind(2) failed: %s",
555 sstrerror (errno, errbuf, sizeof (errbuf)));
560 tmp = realloc (fds, sizeof (*fds) * (fds_num + 1));
563 ERROR ("statsd plugin: realloc failed.");
570 memset (tmp, 0, sizeof (*tmp));
572 tmp->events = POLLIN | POLLPRI;
575 freeaddrinfo (ai_list);
579 ERROR ("statsd plugin: Unable to create listening socket for [%s]:%s.",
580 (node != NULL) ? node : "::", service);
585 *ret_fds_num = fds_num;
587 } /* }}} int statsd_network_init */
589 static void *statsd_network_thread (void *args) /* {{{ */
591 struct pollfd *fds = NULL;
596 status = statsd_network_init (&fds, &fds_num);
599 ERROR ("statsd plugin: Unable to open listening sockets.");
600 pthread_exit ((void *) 0);
603 while (!network_thread_shutdown)
605 status = poll (fds, (nfds_t) fds_num, /* timeout = */ -1);
610 if ((errno == EINTR) || (errno == EAGAIN))
613 ERROR ("statsd plugin: poll(2) failed: %s",
614 sstrerror (errno, errbuf, sizeof (errbuf)));
618 for (i = 0; i < fds_num; i++)
620 if ((fds[i].revents & (POLLIN | POLLPRI)) == 0)
623 statsd_network_read (fds[i].fd);
626 } /* while (!network_thread_shutdown) */
629 for (i = 0; i < fds_num; i++)
634 } /* }}} void *statsd_network_thread */
636 static int statsd_config_timer_percentile (oconfig_item_t *ci) /* {{{ */
638 double percent = NAN;
642 status = cf_util_get_double (ci, &percent);
646 if ((percent <= 0.0) || (percent >= 100))
648 ERROR ("statsd plugin: The value for \"%s\" must be between 0 and 100, "
649 "exclusively.", ci->key);
653 tmp = realloc (conf_timer_percentile,
654 sizeof (*conf_timer_percentile) * (conf_timer_percentile_num + 1));
657 ERROR ("statsd plugin: realloc failed.");
660 conf_timer_percentile = tmp;
661 conf_timer_percentile[conf_timer_percentile_num] = percent;
662 conf_timer_percentile_num++;
665 } /* }}} int statsd_config_timer_percentile */
667 static int statsd_config (oconfig_item_t *ci) /* {{{ */
671 for (i = 0; i < ci->children_num; i++)
673 oconfig_item_t *child = ci->children + i;
675 if (strcasecmp ("Host", child->key) == 0)
676 cf_util_get_string (child, &conf_node);
677 else if (strcasecmp ("Port", child->key) == 0)
678 cf_util_get_service (child, &conf_service);
679 else if (strcasecmp ("DeleteCounters", child->key) == 0)
680 cf_util_get_boolean (child, &conf_delete_counters);
681 else if (strcasecmp ("DeleteTimers", child->key) == 0)
682 cf_util_get_boolean (child, &conf_delete_timers);
683 else if (strcasecmp ("DeleteGauges", child->key) == 0)
684 cf_util_get_boolean (child, &conf_delete_gauges);
685 else if (strcasecmp ("DeleteSets", child->key) == 0)
686 cf_util_get_boolean (child, &conf_delete_sets);
687 else if (strcasecmp ("TimerLower", child->key) == 0)
688 cf_util_get_boolean (child, &conf_timer_lower);
689 else if (strcasecmp ("TimerUpper", child->key) == 0)
690 cf_util_get_boolean (child, &conf_timer_upper);
691 else if (strcasecmp ("TimerSum", child->key) == 0)
692 cf_util_get_boolean (child, &conf_timer_sum);
693 else if (strcasecmp ("TimerCount", child->key) == 0)
694 cf_util_get_boolean (child, &conf_timer_count);
695 else if (strcasecmp ("TimerPercentile", child->key) == 0)
696 statsd_config_timer_percentile (child);
698 ERROR ("statsd plugin: The \"%s\" config option is not valid.",
703 } /* }}} int statsd_config */
705 static int statsd_init (void) /* {{{ */
707 pthread_mutex_lock (&metrics_lock);
708 if (metrics_tree == NULL)
709 metrics_tree = c_avl_create ((void *) strcmp);
711 if (!network_thread_running)
715 status = pthread_create (&network_thread,
717 statsd_network_thread,
722 pthread_mutex_unlock (&metrics_lock);
723 ERROR ("statsd plugin: pthread_create failed: %s",
724 sstrerror (errno, errbuf, sizeof (errbuf)));
728 network_thread_running = 1;
730 pthread_mutex_unlock (&metrics_lock);
733 } /* }}} int statsd_init */
735 /* Must hold metrics_lock when calling this function. */
736 static int statsd_metric_clear_set_unsafe (statsd_metric_t *metric) /* {{{ */
741 if ((metric == NULL) || (metric->type != STATSD_SET))
744 if (metric->set == NULL)
747 while (c_avl_pick (metric->set, &key, &value) == 0)
754 } /* }}} int statsd_metric_clear_set_unsafe */
756 /* Must hold metrics_lock when calling this function. */
757 static int statsd_metric_submit_unsafe (char const *name, /* {{{ */
758 statsd_metric_t const *metric)
761 value_list_t vl = VALUE_LIST_INIT;
765 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
766 sstrncpy (vl.plugin, "statsd", sizeof (vl.plugin));
768 if (metric->type == STATSD_GAUGE)
769 sstrncpy (vl.type, "gauge", sizeof (vl.type));
770 else if (metric->type == STATSD_TIMER)
771 sstrncpy (vl.type, "latency", sizeof (vl.type));
772 else if (metric->type == STATSD_SET)
773 sstrncpy (vl.type, "objects", sizeof (vl.type));
774 else /* if (metric->type == STATSD_COUNTER) */
775 sstrncpy (vl.type, "derive", sizeof (vl.type));
777 sstrncpy (vl.type_instance, name, sizeof (vl.type_instance));
779 if (metric->type == STATSD_GAUGE)
780 values[0].gauge = (gauge_t) metric->value;
781 else if (metric->type == STATSD_TIMER)
784 _Bool have_events = (metric->updates_num > 0);
786 /* Make sure all timer metrics share the *same* timestamp. */
789 ssnprintf (vl.type_instance, sizeof (vl.type_instance),
791 values[0].gauge = have_events
792 ? CDTIME_T_TO_DOUBLE (latency_counter_get_average (metric->latency))
794 plugin_dispatch_values (&vl);
796 if (conf_timer_lower) {
797 ssnprintf (vl.type_instance, sizeof (vl.type_instance),
799 values[0].gauge = have_events
800 ? CDTIME_T_TO_DOUBLE (latency_counter_get_min (metric->latency))
802 plugin_dispatch_values (&vl);
805 if (conf_timer_upper) {
806 ssnprintf (vl.type_instance, sizeof (vl.type_instance),
808 values[0].gauge = have_events
809 ? CDTIME_T_TO_DOUBLE (latency_counter_get_max (metric->latency))
811 plugin_dispatch_values (&vl);
814 if (conf_timer_sum) {
815 ssnprintf (vl.type_instance, sizeof (vl.type_instance),
817 values[0].gauge = have_events
818 ? CDTIME_T_TO_DOUBLE (latency_counter_get_sum (metric->latency))
820 plugin_dispatch_values (&vl);
823 for (i = 0; i < conf_timer_percentile_num; i++)
825 ssnprintf (vl.type_instance, sizeof (vl.type_instance),
826 "%s-percentile-%.0f", name, conf_timer_percentile[i]);
827 values[0].gauge = have_events
828 ? CDTIME_T_TO_DOUBLE (latency_counter_get_percentile (metric->latency, conf_timer_percentile[i]))
830 plugin_dispatch_values (&vl);
833 /* Keep this at the end, since vl.type is set to "gauge" here. The
834 * vl.type's above are implicitly set to "latency". */
835 if (conf_timer_count) {
836 sstrncpy (vl.type, "gauge", sizeof (vl.type));
837 ssnprintf (vl.type_instance, sizeof (vl.type_instance),
839 values[0].gauge = latency_counter_get_num (metric->latency);
840 plugin_dispatch_values (&vl);
843 latency_counter_reset (metric->latency);
846 else if (metric->type == STATSD_SET)
848 if (metric->set == NULL)
849 values[0].gauge = 0.0;
851 values[0].gauge = (gauge_t) c_avl_size (metric->set);
854 values[0].derive = (derive_t) metric->value;
856 return (plugin_dispatch_values (&vl));
857 } /* }}} int statsd_metric_submit_unsafe */
859 static int statsd_read (void) /* {{{ */
861 c_avl_iterator_t *iter;
863 statsd_metric_t *metric;
865 char **to_be_deleted = NULL;
866 size_t to_be_deleted_num = 0;
869 pthread_mutex_lock (&metrics_lock);
871 if (metrics_tree == NULL)
873 pthread_mutex_unlock (&metrics_lock);
877 iter = c_avl_get_iterator (metrics_tree);
878 while (c_avl_iterator_next (iter, (void *) &name, (void *) &metric) == 0)
880 if ((metric->updates_num == 0)
881 && ((conf_delete_counters && (metric->type == STATSD_COUNTER))
882 || (conf_delete_timers && (metric->type == STATSD_TIMER))
883 || (conf_delete_gauges && (metric->type == STATSD_GAUGE))
884 || (conf_delete_sets && (metric->type == STATSD_SET))))
886 DEBUG ("statsd plugin: Deleting metric \"%s\".", name);
887 strarray_add (&to_be_deleted, &to_be_deleted_num, name);
891 /* Names have a prefix, e.g. "c:", which determines the (statsd) type.
892 * Remove this here. */
893 statsd_metric_submit_unsafe (name + 2, metric);
895 /* Reset the metric. */
896 metric->updates_num = 0;
897 if (metric->type == STATSD_SET)
898 statsd_metric_clear_set_unsafe (metric);
900 c_avl_iterator_destroy (iter);
902 for (i = 0; i < to_be_deleted_num; i++)
906 status = c_avl_remove (metrics_tree, to_be_deleted[i],
907 (void *) &name, (void *) &metric);
910 ERROR ("stats plugin: c_avl_remove (\"%s\") failed with status %i.",
911 to_be_deleted[i], status);
916 statsd_metric_free (metric);
919 pthread_mutex_unlock (&metrics_lock);
921 strarray_free (to_be_deleted, to_be_deleted_num);
924 } /* }}} int statsd_read */
926 static int statsd_shutdown (void) /* {{{ */
931 pthread_mutex_lock (&metrics_lock);
933 if (network_thread_running)
935 network_thread_shutdown = 1;
936 pthread_kill (network_thread, SIGTERM);
937 pthread_join (network_thread, /* retval = */ NULL);
939 network_thread_running = 0;
941 while (c_avl_pick (metrics_tree, &key, &value) == 0)
946 c_avl_destroy (metrics_tree);
950 sfree (conf_service);
952 pthread_mutex_unlock (&metrics_lock);
955 } /* }}} int statsd_shutdown */
957 void module_register (void)
959 plugin_register_complex_config ("statsd", statsd_config);
960 plugin_register_init ("statsd", statsd_init);
961 plugin_register_read ("statsd", statsd_read);
962 plugin_register_shutdown ("statsd", statsd_shutdown);
965 /* vim: set sw=2 sts=2 et fdm=marker : */