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>
38 #include <sys/socket.h>
42 /* AIX doesn't have MSG_DONTWAIT */
44 # define MSG_DONTWAIT MSG_NONBLOCK
47 #ifndef STATSD_DEFAULT_NODE
48 # define STATSD_DEFAULT_NODE NULL
51 #ifndef STATSD_DEFAULT_SERVICE
52 # define STATSD_DEFAULT_SERVICE "8125"
62 typedef enum metric_type_e metric_type_t;
64 struct statsd_metric_s
68 latency_counter_t *latency;
70 unsigned long updates_num;
72 typedef struct statsd_metric_s statsd_metric_t;
74 static c_avl_tree_t *metrics_tree = NULL;
75 static pthread_mutex_t metrics_lock = PTHREAD_MUTEX_INITIALIZER;
77 static pthread_t network_thread;
78 static _Bool network_thread_running = 0;
79 static _Bool network_thread_shutdown = 0;
81 static char *conf_node = NULL;
82 static char *conf_service = NULL;
84 static _Bool conf_delete_counters = 0;
85 static _Bool conf_delete_timers = 0;
86 static _Bool conf_delete_gauges = 0;
87 static _Bool conf_delete_sets = 0;
89 static double *conf_timer_percentile = NULL;
90 static size_t conf_timer_percentile_num = 0;
92 static _Bool conf_timer_lower = 0;
93 static _Bool conf_timer_upper = 0;
94 static _Bool conf_timer_sum = 0;
95 static _Bool conf_timer_count = 0;
97 /* Must hold metrics_lock when calling this function. */
98 static statsd_metric_t *statsd_metric_lookup_unsafe (char const *name, /* {{{ */
101 char key[DATA_MAX_NAME_LEN + 2];
103 statsd_metric_t *metric;
108 case STATSD_COUNTER: key[0] = 'c'; break;
109 case STATSD_TIMER: key[0] = 't'; break;
110 case STATSD_GAUGE: key[0] = 'g'; break;
111 case STATSD_SET: key[0] = 's'; break;
112 default: return (NULL);
116 sstrncpy (&key[2], name, sizeof (key) - 2);
118 status = c_avl_get (metrics_tree, key, (void *) &metric);
122 key_copy = strdup (key);
123 if (key_copy == NULL)
125 ERROR ("statsd plugin: strdup failed.");
129 metric = malloc (sizeof (*metric));
132 ERROR ("statsd plugin: malloc failed.");
136 memset (metric, 0, sizeof (*metric));
139 metric->latency = NULL;
142 status = c_avl_insert (metrics_tree, key_copy, metric);
145 ERROR ("statsd plugin: c_avl_insert failed.");
152 } /* }}} statsd_metric_lookup_unsafe */
154 static int statsd_metric_set (char const *name, double value, /* {{{ */
157 statsd_metric_t *metric;
159 pthread_mutex_lock (&metrics_lock);
161 metric = statsd_metric_lookup_unsafe (name, type);
164 pthread_mutex_unlock (&metrics_lock);
168 metric->value = value;
169 metric->updates_num++;
171 pthread_mutex_unlock (&metrics_lock);
174 } /* }}} int statsd_metric_set */
176 static int statsd_metric_add (char const *name, double delta, /* {{{ */
179 statsd_metric_t *metric;
181 pthread_mutex_lock (&metrics_lock);
183 metric = statsd_metric_lookup_unsafe (name, type);
186 pthread_mutex_unlock (&metrics_lock);
190 metric->value += delta;
191 metric->updates_num++;
193 pthread_mutex_unlock (&metrics_lock);
196 } /* }}} int statsd_metric_add */
198 static int statsd_parse_value (char const *str, value_t *ret_value) /* {{{ */
202 ret_value->gauge = (gauge_t) strtod (str, &endptr);
203 if ((str == endptr) || ((endptr != NULL) && (*endptr != 0)))
207 } /* }}} int statsd_parse_value */
209 static int statsd_handle_counter (char const *name, /* {{{ */
210 char const *value_str,
217 if ((extra != NULL) && (extra[0] != '@'))
223 status = statsd_parse_value (extra + 1, &scale);
227 if (!isfinite (scale.gauge) || (scale.gauge <= 0.0) || (scale.gauge > 1.0))
232 status = statsd_parse_value (value_str, &value);
236 return (statsd_metric_add (name, (double) (value.gauge / scale.gauge),
238 } /* }}} int statsd_handle_counter */
240 static int statsd_handle_gauge (char const *name, /* {{{ */
241 char const *value_str)
247 status = statsd_parse_value (value_str, &value);
251 if ((value_str[0] == '+') || (value_str[0] == '-'))
252 return (statsd_metric_add (name, (double) value.gauge, STATSD_GAUGE));
254 return (statsd_metric_set (name, (double) value.gauge, STATSD_GAUGE));
255 } /* }}} int statsd_handle_gauge */
257 static int statsd_handle_timer (char const *name, /* {{{ */
258 char const *value_str,
261 statsd_metric_t *metric;
267 if ((extra != NULL) && (extra[0] != '@'))
273 status = statsd_parse_value (extra + 1, &scale);
277 if (!isfinite (scale.gauge) || (scale.gauge <= 0.0) || (scale.gauge > 1.0))
282 status = statsd_parse_value (value_str, &value_ms);
286 value = MS_TO_CDTIME_T (value_ms.gauge / scale.gauge);
288 pthread_mutex_lock (&metrics_lock);
290 metric = statsd_metric_lookup_unsafe (name, STATSD_TIMER);
293 pthread_mutex_unlock (&metrics_lock);
297 if (metric->latency == NULL)
298 metric->latency = latency_counter_create ();
299 if (metric->latency == NULL)
301 pthread_mutex_unlock (&metrics_lock);
305 latency_counter_add (metric->latency, value);
306 metric->updates_num++;
308 pthread_mutex_unlock (&metrics_lock);
310 } /* }}} int statsd_handle_timer */
312 static int statsd_handle_set (char const *name, /* {{{ */
313 char const *set_key_orig)
315 statsd_metric_t *metric = NULL;
319 pthread_mutex_lock (&metrics_lock);
321 metric = statsd_metric_lookup_unsafe (name, STATSD_SET);
324 pthread_mutex_unlock (&metrics_lock);
328 /* Make sure metric->set exists. */
329 if (metric->set == NULL)
330 metric->set = c_avl_create ((void *) strcmp);
332 if (metric->set == NULL)
334 pthread_mutex_unlock (&metrics_lock);
335 ERROR ("statsd plugin: c_avl_create failed.");
339 set_key = strdup (set_key_orig);
342 pthread_mutex_unlock (&metrics_lock);
343 ERROR ("statsd plugin: strdup failed.");
347 status = c_avl_insert (metric->set, set_key, /* value = */ NULL);
350 pthread_mutex_unlock (&metrics_lock);
352 ERROR ("statsd plugin: c_avl_insert (\"%s\") failed with status %i.",
357 else if (status > 0) /* key already exists */
362 metric->updates_num++;
364 pthread_mutex_unlock (&metrics_lock);
366 } /* }}} int statsd_handle_set */
368 static int statsd_parse_line (char *buffer) /* {{{ */
375 type = strchr (name, '|');
381 value = strrchr (name, ':');
387 extra = strchr (type, '|');
394 if (strcmp ("c", type) == 0)
395 return (statsd_handle_counter (name, value, extra));
396 else if (strcmp ("ms", type) == 0)
397 return (statsd_handle_timer (name, value, extra));
399 /* extra is only valid for counters and timers */
403 if (strcmp ("g", type) == 0)
404 return (statsd_handle_gauge (name, value));
405 else if (strcmp ("s", type) == 0)
406 return (statsd_handle_set (name, value));
409 } /* }}} void statsd_parse_line */
411 static void statsd_parse_buffer (char *buffer) /* {{{ */
413 while (buffer != NULL)
419 next = strchr (buffer, '\n');
432 sstrncpy (orig, buffer, sizeof (orig));
434 status = statsd_parse_line (buffer);
436 ERROR ("statsd plugin: Unable to parse line: \"%s\"", orig);
440 } /* }}} void statsd_parse_buffer */
442 static void statsd_network_read (int fd) /* {{{ */
448 status = recv (fd, buffer, sizeof (buffer), /* flags = */ MSG_DONTWAIT);
453 if ((errno == EAGAIN) || (errno == EWOULDBLOCK))
456 ERROR ("statsd plugin: recv(2) failed: %s",
457 sstrerror (errno, errbuf, sizeof (errbuf)));
461 buffer_size = (size_t) status;
462 if (buffer_size >= sizeof (buffer))
463 buffer_size = sizeof (buffer) - 1;
464 buffer[buffer_size] = 0;
466 statsd_parse_buffer (buffer);
467 } /* }}} void statsd_network_read */
469 static int statsd_network_init (struct pollfd **ret_fds, /* {{{ */
472 struct pollfd *fds = NULL;
475 struct addrinfo ai_hints;
476 struct addrinfo *ai_list = NULL;
477 struct addrinfo *ai_ptr;
480 char const *node = (conf_node != NULL) ? conf_node : STATSD_DEFAULT_NODE;
481 char const *service = (conf_service != NULL)
482 ? conf_service : STATSD_DEFAULT_SERVICE;
484 memset (&ai_hints, 0, sizeof (ai_hints));
485 ai_hints.ai_flags = AI_PASSIVE;
487 ai_hints.ai_flags |= AI_ADDRCONFIG;
489 ai_hints.ai_family = AF_UNSPEC;
490 ai_hints.ai_socktype = SOCK_DGRAM;
492 status = getaddrinfo (node, service, &ai_hints, &ai_list);
495 ERROR ("statsd plugin: getaddrinfo (\"%s\", \"%s\") failed: %s",
496 node, service, gai_strerror (status));
500 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
505 char dbg_node[NI_MAXHOST];
506 char dbg_service[NI_MAXSERV];
508 fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype, ai_ptr->ai_protocol);
512 ERROR ("statsd plugin: socket(2) failed: %s",
513 sstrerror (errno, errbuf, sizeof (errbuf)));
517 getnameinfo (ai_ptr->ai_addr, ai_ptr->ai_addrlen,
518 dbg_node, sizeof (dbg_node), dbg_service, sizeof (dbg_service),
519 NI_DGRAM | NI_NUMERICHOST | NI_NUMERICSERV);
520 DEBUG ("statsd plugin: Trying to bind to [%s]:%s ...", dbg_node, dbg_service);
522 status = bind (fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
526 ERROR ("statsd plugin: bind(2) failed: %s",
527 sstrerror (errno, errbuf, sizeof (errbuf)));
532 tmp = realloc (fds, sizeof (*fds) * (fds_num + 1));
535 ERROR ("statsd plugin: realloc failed.");
542 memset (tmp, 0, sizeof (*tmp));
544 tmp->events = POLLIN | POLLPRI;
547 freeaddrinfo (ai_list);
551 ERROR ("statsd plugin: Unable to create listening socket for [%s]:%s.",
552 (node != NULL) ? node : "::", service);
557 *ret_fds_num = fds_num;
559 } /* }}} int statsd_network_init */
561 static void *statsd_network_thread (void *args) /* {{{ */
563 struct pollfd *fds = NULL;
568 status = statsd_network_init (&fds, &fds_num);
571 ERROR ("statsd plugin: Unable to open listening sockets.");
572 pthread_exit ((void *) 0);
575 while (!network_thread_shutdown)
577 status = poll (fds, (nfds_t) fds_num, /* timeout = */ -1);
582 if ((errno == EINTR) || (errno == EAGAIN))
585 ERROR ("statsd plugin: poll(2) failed: %s",
586 sstrerror (errno, errbuf, sizeof (errbuf)));
590 for (i = 0; i < fds_num; i++)
592 if ((fds[i].revents & (POLLIN | POLLPRI)) == 0)
595 statsd_network_read (fds[i].fd);
598 } /* while (!network_thread_shutdown) */
601 for (i = 0; i < fds_num; i++)
606 } /* }}} void *statsd_network_thread */
608 static int statsd_config_timer_percentile (oconfig_item_t *ci) /* {{{ */
610 double percent = NAN;
614 status = cf_util_get_double (ci, &percent);
618 if ((percent <= 0.0) || (percent >= 100))
620 ERROR ("statsd plugin: The value for \"%s\" must be between 0 and 100, "
621 "exclusively.", ci->key);
625 tmp = realloc (conf_timer_percentile,
626 sizeof (*conf_timer_percentile) * (conf_timer_percentile_num + 1));
629 ERROR ("statsd plugin: realloc failed.");
632 conf_timer_percentile = tmp;
633 conf_timer_percentile[conf_timer_percentile_num] = percent;
634 conf_timer_percentile_num++;
637 } /* }}} int statsd_config_timer_percentile */
639 static int statsd_config (oconfig_item_t *ci) /* {{{ */
643 for (i = 0; i < ci->children_num; i++)
645 oconfig_item_t *child = ci->children + i;
647 if (strcasecmp ("Host", child->key) == 0)
648 cf_util_get_string (child, &conf_node);
649 else if (strcasecmp ("Port", child->key) == 0)
650 cf_util_get_service (child, &conf_service);
651 else if (strcasecmp ("DeleteCounters", child->key) == 0)
652 cf_util_get_boolean (child, &conf_delete_counters);
653 else if (strcasecmp ("DeleteTimers", child->key) == 0)
654 cf_util_get_boolean (child, &conf_delete_timers);
655 else if (strcasecmp ("DeleteGauges", child->key) == 0)
656 cf_util_get_boolean (child, &conf_delete_gauges);
657 else if (strcasecmp ("DeleteSets", child->key) == 0)
658 cf_util_get_boolean (child, &conf_delete_sets);
659 else if (strcasecmp ("TimerLower", child->key) == 0)
660 cf_util_get_boolean (child, &conf_timer_lower);
661 else if (strcasecmp ("TimerUpper", child->key) == 0)
662 cf_util_get_boolean (child, &conf_timer_upper);
663 else if (strcasecmp ("TimerSum", child->key) == 0)
664 cf_util_get_boolean (child, &conf_timer_sum);
665 else if (strcasecmp ("TimerCount", child->key) == 0)
666 cf_util_get_boolean (child, &conf_timer_count);
667 else if (strcasecmp ("TimerPercentile", child->key) == 0)
668 statsd_config_timer_percentile (child);
670 ERROR ("statsd plugin: The \"%s\" config option is not valid.",
675 } /* }}} int statsd_config */
677 static int statsd_init (void) /* {{{ */
679 pthread_mutex_lock (&metrics_lock);
680 if (metrics_tree == NULL)
681 metrics_tree = c_avl_create ((void *) strcmp);
683 if (!network_thread_running)
687 status = pthread_create (&network_thread,
689 statsd_network_thread,
694 pthread_mutex_unlock (&metrics_lock);
695 ERROR ("statsd plugin: pthread_create failed: %s",
696 sstrerror (errno, errbuf, sizeof (errbuf)));
700 network_thread_running = 1;
702 pthread_mutex_unlock (&metrics_lock);
705 } /* }}} int statsd_init */
707 /* Must hold metrics_lock when calling this function. */
708 static int statsd_metric_clear_set_unsafe (statsd_metric_t *metric) /* {{{ */
713 if ((metric == NULL) || (metric->type != STATSD_SET))
716 if (metric->set == NULL)
719 while (c_avl_pick (metric->set, &key, &value) == 0)
726 } /* }}} int statsd_metric_clear_set_unsafe */
728 /* Must hold metrics_lock when calling this function. */
729 static int statsd_metric_submit_unsafe (char const *name, /* {{{ */
730 statsd_metric_t const *metric)
733 value_list_t vl = VALUE_LIST_INIT;
737 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
738 sstrncpy (vl.plugin, "statsd", sizeof (vl.plugin));
740 if (metric->type == STATSD_GAUGE)
741 sstrncpy (vl.type, "gauge", sizeof (vl.type));
742 else if (metric->type == STATSD_TIMER)
743 sstrncpy (vl.type, "latency", sizeof (vl.type));
744 else if (metric->type == STATSD_SET)
745 sstrncpy (vl.type, "objects", sizeof (vl.type));
746 else /* if (metric->type == STATSD_COUNTER) */
747 sstrncpy (vl.type, "derive", sizeof (vl.type));
749 sstrncpy (vl.type_instance, name, sizeof (vl.type_instance));
751 if (metric->type == STATSD_GAUGE)
752 values[0].gauge = (gauge_t) metric->value;
753 else if (metric->type == STATSD_TIMER)
757 if (metric->updates_num == 0)
762 ssnprintf (vl.type_instance, sizeof (vl.type_instance),
764 values[0].gauge = CDTIME_T_TO_DOUBLE (
765 latency_counter_get_average (metric->latency));
766 plugin_dispatch_values (&vl);
768 if (conf_timer_lower) {
769 ssnprintf (vl.type_instance, sizeof (vl.type_instance),
771 values[0].gauge = CDTIME_T_TO_DOUBLE (
772 latency_counter_get_min (metric->latency));
773 plugin_dispatch_values (&vl);
776 if (conf_timer_upper) {
777 ssnprintf (vl.type_instance, sizeof (vl.type_instance),
779 values[0].gauge = CDTIME_T_TO_DOUBLE (
780 latency_counter_get_max (metric->latency));
781 plugin_dispatch_values (&vl);
784 if (conf_timer_sum) {
785 ssnprintf (vl.type_instance, sizeof (vl.type_instance),
787 values[0].gauge = CDTIME_T_TO_DOUBLE (
788 latency_counter_get_sum (metric->latency));
789 plugin_dispatch_values (&vl);
792 for (i = 0; i < conf_timer_percentile_num; i++)
794 ssnprintf (vl.type_instance, sizeof (vl.type_instance),
795 "%s-percentile-%.0f", name, conf_timer_percentile[i]);
796 values[0].gauge = CDTIME_T_TO_DOUBLE (
797 latency_counter_get_percentile (
798 metric->latency, conf_timer_percentile[i]));
799 plugin_dispatch_values (&vl);
802 /* Keep this at the end, since vl.type is set to "gauge" here. The
803 * vl.type's above are implicitly set to "latency". */
804 if (conf_timer_count) {
805 sstrncpy (vl.type, "gauge", sizeof (vl.type));
806 ssnprintf (vl.type_instance, sizeof (vl.type_instance),
808 values[0].gauge = latency_counter_get_num (metric->latency);
809 plugin_dispatch_values (&vl);
812 latency_counter_reset (metric->latency);
815 else if (metric->type == STATSD_SET)
817 if (metric->set == NULL)
818 values[0].gauge = 0.0;
820 values[0].gauge = (gauge_t) c_avl_size (metric->set);
823 values[0].derive = (derive_t) metric->value;
825 return (plugin_dispatch_values (&vl));
826 } /* }}} int statsd_metric_submit_unsafe */
828 static int statsd_read (void) /* {{{ */
830 c_avl_iterator_t *iter;
832 statsd_metric_t *metric;
834 char **to_be_deleted = NULL;
835 size_t to_be_deleted_num = 0;
838 pthread_mutex_lock (&metrics_lock);
840 if (metrics_tree == NULL)
842 pthread_mutex_unlock (&metrics_lock);
846 iter = c_avl_get_iterator (metrics_tree);
847 while (c_avl_iterator_next (iter, (void *) &name, (void *) &metric) == 0)
849 if ((metric->updates_num == 0)
850 && ((conf_delete_counters && (metric->type == STATSD_COUNTER))
851 || (conf_delete_timers && (metric->type == STATSD_TIMER))
852 || (conf_delete_gauges && (metric->type == STATSD_GAUGE))
853 || (conf_delete_sets && (metric->type == STATSD_SET))))
855 DEBUG ("statsd plugin: Deleting metric \"%s\".", name);
856 strarray_add (&to_be_deleted, &to_be_deleted_num, name);
860 /* Names have a prefix, e.g. "c:", which determines the (statsd) type.
861 * Remove this here. */
862 statsd_metric_submit_unsafe (name + 2, metric);
864 /* Reset the metric. */
865 metric->updates_num = 0;
866 if (metric->type == STATSD_SET)
867 statsd_metric_clear_set_unsafe (metric);
869 c_avl_iterator_destroy (iter);
871 for (i = 0; i < to_be_deleted_num; i++)
875 status = c_avl_remove (metrics_tree, to_be_deleted[i],
876 (void *) &name, (void *) &metric);
879 ERROR ("stats plugin: c_avl_remove (\"%s\") failed with status %i.",
880 to_be_deleted[i], status);
888 pthread_mutex_unlock (&metrics_lock);
890 strarray_free (to_be_deleted, to_be_deleted_num);
893 } /* }}} int statsd_read */
895 static int statsd_shutdown (void) /* {{{ */
900 pthread_mutex_lock (&metrics_lock);
902 if (network_thread_running)
904 network_thread_shutdown = 1;
905 pthread_kill (network_thread, SIGTERM);
906 pthread_join (network_thread, /* retval = */ NULL);
908 network_thread_running = 0;
910 while (c_avl_pick (metrics_tree, &key, &value) == 0)
915 c_avl_destroy (metrics_tree);
919 sfree (conf_service);
921 pthread_mutex_unlock (&metrics_lock);
924 } /* }}} int statsd_shutdown */
926 void module_register (void)
928 plugin_register_complex_config ("statsd", statsd_config);
929 plugin_register_init ("statsd", statsd_init);
930 plugin_register_read ("statsd", statsd_read);
931 plugin_register_shutdown ("statsd", statsd_shutdown);
934 /* vim: set sw=2 sts=2 et fdm=marker : */