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 /* Must hold metrics_lock when calling this function. */
83 static statsd_metric_t *statsd_metric_lookup_unsafe (char const *name, /* {{{ */
86 char key[DATA_MAX_NAME_LEN + 2];
88 statsd_metric_t *metric;
93 case STATSD_COUNTER: key[0] = 'c'; break;
94 case STATSD_TIMER: key[0] = 't'; break;
95 case STATSD_GAUGE: key[0] = 'g'; break;
96 case STATSD_SET: key[0] = 's'; break;
97 default: return (NULL);
101 sstrncpy (&key[2], name, sizeof (key) - 2);
103 status = c_avl_get (metrics_tree, key, (void *) &metric);
107 key_copy = strdup (key);
108 if (key_copy == NULL)
110 ERROR ("statsd plugin: strdup failed.");
114 metric = malloc (sizeof (*metric));
117 ERROR ("statsd plugin: malloc failed.");
121 memset (metric, 0, sizeof (*metric));
124 metric->latency = NULL;
127 status = c_avl_insert (metrics_tree, key_copy, metric);
130 ERROR ("statsd plugin: c_avl_insert failed.");
137 } /* }}} statsd_metric_lookup_unsafe */
139 static int statsd_metric_set (char const *name, int64_t value, /* {{{ */
142 statsd_metric_t *metric;
144 pthread_mutex_lock (&metrics_lock);
146 metric = statsd_metric_lookup_unsafe (name, type);
149 pthread_mutex_unlock (&metrics_lock);
153 metric->value = value;
154 metric->updates_num++;
156 pthread_mutex_unlock (&metrics_lock);
159 } /* }}} int statsd_metric_set */
161 static int statsd_metric_add (char const *name, int64_t delta, /* {{{ */
164 statsd_metric_t *metric;
166 pthread_mutex_lock (&metrics_lock);
168 metric = statsd_metric_lookup_unsafe (name, type);
171 pthread_mutex_unlock (&metrics_lock);
175 metric->value += delta;
176 metric->updates_num++;
178 pthread_mutex_unlock (&metrics_lock);
181 } /* }}} int statsd_metric_add */
183 static int statsd_parse_value (char const *str, value_t *ret_value) /* {{{ */
187 ret_value->derive = (derive_t) strtoll (str, &endptr, /* base = */ 0);
188 if ((str == endptr) || ((endptr != NULL) && (*endptr != 0)))
192 } /* }}} int statsd_parse_value */
194 static int statsd_handle_counter (char const *name, /* {{{ */
195 char const *value_str,
202 if ((extra != NULL) && (extra[0] != '@'))
208 status = parse_value (extra + 1, &scale, DS_TYPE_GAUGE);
212 if (!isfinite (scale.gauge) || (scale.gauge <= 0.0) || (scale.gauge > 1.0))
217 status = statsd_parse_value (value_str, &value);
221 if (value.derive < 1)
224 return (statsd_metric_add (name,
225 (int64_t) (((gauge_t) value.derive) / 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, (int64_t) value.derive, STATSD_GAUGE));
243 return (statsd_metric_set (name, (int64_t) value.derive, 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.derive);
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) /* {{{ */
387 char *saveptr = NULL;
391 (ptr = strtok_r (dummy, "\r\n", &saveptr)) != NULL;
394 char *line_orig = sstrdup (ptr);
397 status = statsd_parse_line (ptr);
399 ERROR ("statsd plugin: Unable to parse line: \"%s\"", line_orig);
403 } /* }}} void statsd_parse_buffer */
405 static void statsd_network_read (int fd) /* {{{ */
411 status = recv (fd, buffer, sizeof (buffer), /* flags = */ MSG_DONTWAIT);
416 if ((errno == EAGAIN) || (errno == EWOULDBLOCK))
419 ERROR ("statsd plugin: recv(2) failed: %s",
420 sstrerror (errno, errbuf, sizeof (errbuf)));
424 buffer_size = (size_t) status;
425 if (buffer_size >= sizeof (buffer))
426 buffer_size = sizeof (buffer) - 1;
427 buffer[buffer_size] = 0;
429 statsd_parse_buffer (buffer);
430 } /* }}} void statsd_network_read */
432 static int statsd_network_init (struct pollfd **ret_fds, /* {{{ */
435 struct pollfd *fds = NULL;
438 struct addrinfo ai_hints;
439 struct addrinfo *ai_list = NULL;
440 struct addrinfo *ai_ptr;
443 char const *node = (conf_node != NULL) ? conf_node : STATSD_DEFAULT_NODE;
444 char const *service = (conf_service != NULL)
445 ? conf_service : STATSD_DEFAULT_SERVICE;
447 memset (&ai_hints, 0, sizeof (ai_hints));
448 ai_hints.ai_flags = AI_PASSIVE;
450 ai_hints.ai_flags |= AI_ADDRCONFIG;
452 ai_hints.ai_family = AF_UNSPEC;
453 ai_hints.ai_socktype = SOCK_DGRAM;
455 status = getaddrinfo (node, service, &ai_hints, &ai_list);
458 ERROR ("statsd plugin: getaddrinfo (\"%s\", \"%s\") failed: %s",
459 node, service, gai_strerror (status));
463 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
468 char dbg_node[NI_MAXHOST];
469 char dbg_service[NI_MAXSERV];
471 fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype, ai_ptr->ai_protocol);
475 ERROR ("statsd plugin: socket(2) failed: %s",
476 sstrerror (errno, errbuf, sizeof (errbuf)));
480 getnameinfo (ai_ptr->ai_addr, ai_ptr->ai_addrlen,
481 dbg_node, sizeof (dbg_node), dbg_service, sizeof (dbg_service),
482 NI_DGRAM | NI_NUMERICHOST | NI_NUMERICSERV);
483 DEBUG ("statsd plugin: Trying to bind to [%s]:%s ...", dbg_node, dbg_service);
485 status = bind (fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
489 ERROR ("statsd plugin: bind(2) failed: %s",
490 sstrerror (errno, errbuf, sizeof (errbuf)));
495 tmp = realloc (fds, sizeof (*fds) * (fds_num + 1));
498 ERROR ("statsd plugin: realloc failed.");
505 memset (tmp, 0, sizeof (*tmp));
507 tmp->events = POLLIN | POLLPRI;
510 freeaddrinfo (ai_list);
514 ERROR ("statsd plugin: Unable to create listening socket for [%s]:%s.",
515 (node != NULL) ? node : "::", service);
520 *ret_fds_num = fds_num;
522 } /* }}} int statsd_network_init */
524 static void *statsd_network_thread (void *args) /* {{{ */
526 struct pollfd *fds = NULL;
531 status = statsd_network_init (&fds, &fds_num);
534 ERROR ("statsd plugin: Unable to open listening sockets.");
535 pthread_exit ((void *) 0);
538 while (!network_thread_shutdown)
540 status = poll (fds, (nfds_t) fds_num, /* timeout = */ -1);
545 if ((errno == EINTR) || (errno == EAGAIN))
548 ERROR ("statsd plugin: poll(2) failed: %s",
549 sstrerror (errno, errbuf, sizeof (errbuf)));
553 for (i = 0; i < fds_num; i++)
555 if ((fds[i].revents & (POLLIN | POLLPRI)) == 0)
558 statsd_network_read (fds[i].fd);
561 } /* while (!network_thread_shutdown) */
564 for (i = 0; i < fds_num; i++)
569 } /* }}} void *statsd_network_thread */
571 static int statsd_config_timer_percentile (oconfig_item_t *ci) /* {{{ */
573 double percent = NAN;
577 status = cf_util_get_double (ci, &percent);
581 if ((percent <= 0.0) || (percent >= 100))
583 ERROR ("statsd plugin: The value for \"%s\" must be between 0 and 100, "
584 "exclusively.", ci->key);
588 tmp = realloc (conf_timer_percentile,
589 sizeof (*conf_timer_percentile) * (conf_timer_percentile_num + 1));
592 ERROR ("statsd plugin: realloc failed.");
595 conf_timer_percentile = tmp;
596 conf_timer_percentile[conf_timer_percentile_num] = percent;
597 conf_timer_percentile_num++;
600 } /* }}} int statsd_config_timer_percentile */
602 static int statsd_config (oconfig_item_t *ci) /* {{{ */
606 for (i = 0; i < ci->children_num; i++)
608 oconfig_item_t *child = ci->children + i;
610 if (strcasecmp ("Host", child->key) == 0)
611 cf_util_get_string (child, &conf_node);
612 else if (strcasecmp ("Port", child->key) == 0)
613 cf_util_get_service (child, &conf_service);
614 else if (strcasecmp ("DeleteCounters", child->key) == 0)
615 cf_util_get_boolean (child, &conf_delete_counters);
616 else if (strcasecmp ("DeleteTimers", child->key) == 0)
617 cf_util_get_boolean (child, &conf_delete_timers);
618 else if (strcasecmp ("DeleteGauges", child->key) == 0)
619 cf_util_get_boolean (child, &conf_delete_gauges);
620 else if (strcasecmp ("DeleteSets", child->key) == 0)
621 cf_util_get_boolean (child, &conf_delete_sets);
622 else if (strcasecmp ("TimerPercentile", child->key) == 0)
623 statsd_config_timer_percentile (child);
625 ERROR ("statsd plugin: The \"%s\" config option is not valid.",
630 } /* }}} int statsd_config */
632 static int statsd_init (void) /* {{{ */
634 pthread_mutex_lock (&metrics_lock);
635 if (metrics_tree == NULL)
636 metrics_tree = c_avl_create ((void *) strcasecmp);
638 if (!network_thread_running)
642 status = pthread_create (&network_thread,
644 statsd_network_thread,
649 pthread_mutex_unlock (&metrics_lock);
650 ERROR ("statsd plugin: pthread_create failed: %s",
651 sstrerror (errno, errbuf, sizeof (errbuf)));
655 network_thread_running = 1;
657 pthread_mutex_unlock (&metrics_lock);
660 } /* }}} int statsd_init */
662 /* Must hold metrics_lock when calling this function. */
663 static int statsd_metric_clear_set_unsafe (statsd_metric_t *metric) /* {{{ */
668 if ((metric == NULL) || (metric->type != STATSD_SET))
671 if (metric->set == NULL)
674 while (c_avl_pick (metric->set, &key, &value) == 0)
681 } /* }}} int statsd_metric_clear_set_unsafe */
683 /* Must hold metrics_lock when calling this function. */
684 static int statsd_metric_submit_unsafe (char const *name, /* {{{ */
685 statsd_metric_t const *metric)
688 value_list_t vl = VALUE_LIST_INIT;
692 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
693 sstrncpy (vl.plugin, "statsd", sizeof (vl.plugin));
695 if (metric->type == STATSD_GAUGE)
696 sstrncpy (vl.type, "gauge", sizeof (vl.type));
697 else if (metric->type == STATSD_TIMER)
698 sstrncpy (vl.type, "latency", sizeof (vl.type));
699 else if (metric->type == STATSD_SET)
700 sstrncpy (vl.type, "objects", sizeof (vl.type));
701 else /* if (metric->type == STATSD_COUNTER) */
702 sstrncpy (vl.type, "derive", sizeof (vl.type));
704 sstrncpy (vl.type_instance, name, sizeof (vl.type_instance));
706 if (metric->type == STATSD_GAUGE)
707 values[0].gauge = (gauge_t) metric->value;
708 else if (metric->type == STATSD_TIMER)
712 if (metric->updates_num == 0)
717 ssnprintf (vl.type_instance, sizeof (vl.type_instance),
719 values[0].gauge = CDTIME_T_TO_DOUBLE (
720 latency_counter_get_average (metric->latency));
721 plugin_dispatch_values (&vl);
723 for (i = 0; i < conf_timer_percentile_num; i++)
725 ssnprintf (vl.type_instance, sizeof (vl.type_instance),
726 "%s-percentile-%.0f", name, conf_timer_percentile[i]);
727 values[0].gauge = CDTIME_T_TO_DOUBLE (
728 latency_counter_get_percentile (
729 metric->latency, conf_timer_percentile[i]));
730 plugin_dispatch_values (&vl);
733 latency_counter_reset (metric->latency);
736 else if (metric->type == STATSD_SET)
738 if (metric->set == NULL)
739 values[0].gauge = 0.0;
741 values[0].gauge = (gauge_t) c_avl_size (metric->set);
744 values[0].derive = (derive_t) metric->value;
746 return (plugin_dispatch_values (&vl));
747 } /* }}} int statsd_metric_submit_unsafe */
749 static int statsd_read (void) /* {{{ */
751 c_avl_iterator_t *iter;
753 statsd_metric_t *metric;
755 char **to_be_deleted = NULL;
756 size_t to_be_deleted_num = 0;
759 pthread_mutex_lock (&metrics_lock);
761 if (metrics_tree == NULL)
763 pthread_mutex_unlock (&metrics_lock);
767 iter = c_avl_get_iterator (metrics_tree);
768 while (c_avl_iterator_next (iter, (void *) &name, (void *) &metric) == 0)
770 if ((metric->updates_num == 0)
771 && ((conf_delete_counters && (metric->type == STATSD_COUNTER))
772 || (conf_delete_timers && (metric->type == STATSD_TIMER))
773 || (conf_delete_gauges && (metric->type == STATSD_GAUGE))
774 || (conf_delete_sets && (metric->type == STATSD_SET))))
776 DEBUG ("statsd plugin: Deleting metric \"%s\".", name);
777 strarray_add (&to_be_deleted, &to_be_deleted_num, name);
781 /* Names have a prefix, e.g. "c:", which determines the (statsd) type.
782 * Remove this here. */
783 statsd_metric_submit_unsafe (name + 2, metric);
785 /* Reset the metric. */
786 metric->updates_num = 0;
787 if (metric->type == STATSD_SET)
788 statsd_metric_clear_set_unsafe (metric);
790 c_avl_iterator_destroy (iter);
792 for (i = 0; i < to_be_deleted_num; i++)
796 status = c_avl_remove (metrics_tree, to_be_deleted[i],
797 (void *) &name, (void *) &metric);
800 ERROR ("stats plugin: c_avl_remove (\"%s\") failed with status %i.",
801 to_be_deleted[i], status);
809 pthread_mutex_unlock (&metrics_lock);
811 strarray_free (to_be_deleted, to_be_deleted_num);
814 } /* }}} int statsd_read */
816 static int statsd_shutdown (void) /* {{{ */
821 pthread_mutex_lock (&metrics_lock);
823 if (network_thread_running)
825 network_thread_shutdown = 1;
826 pthread_kill (network_thread, SIGTERM);
827 pthread_join (network_thread, /* retval = */ NULL);
829 network_thread_running = 0;
831 while (c_avl_pick (metrics_tree, &key, &value) == 0)
836 c_avl_destroy (metrics_tree);
840 sfree (conf_service);
842 pthread_mutex_unlock (&metrics_lock);
845 } /* }}} int statsd_shutdown */
847 void module_register (void)
849 plugin_register_complex_config ("statsd", statsd_config);
850 plugin_register_init ("statsd", statsd_init);
851 plugin_register_read ("statsd", statsd_read);
852 plugin_register_shutdown ("statsd", statsd_shutdown);
855 /* vim: set sw=2 sts=2 et fdm=marker : */