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_handle_counter (char const *name, /* {{{ */
184 char const *value_str,
191 if ((extra != NULL) && (extra[0] != '@'))
197 status = parse_value (extra + 1, &scale, DS_TYPE_GAUGE);
201 if (!isfinite (scale.gauge) || (scale.gauge <= 0.0) || (scale.gauge > 1.0))
206 status = parse_value (value_str, &value, DS_TYPE_DERIVE);
210 if (value.derive < 1)
213 return (statsd_metric_add (name,
214 (int64_t) (((gauge_t) value.derive) / scale.gauge),
216 } /* }}} int statsd_handle_counter */
218 static int statsd_handle_gauge (char const *name, /* {{{ */
219 char const *value_str)
225 status = parse_value (value_str, &value, DS_TYPE_DERIVE);
229 if ((value_str[0] == '+') || (value_str[0] == '-'))
230 return (statsd_metric_add (name, (int64_t) value.derive, STATSD_GAUGE));
232 return (statsd_metric_set (name, (int64_t) value.derive, STATSD_GAUGE));
233 } /* }}} int statsd_handle_gauge */
235 static int statsd_handle_timer (char const *name, /* {{{ */
236 char const *value_str)
238 statsd_metric_t *metric;
244 status = parse_value (value_str, &value_ms, DS_TYPE_DERIVE);
248 value = MS_TO_CDTIME_T (value_ms.derive);
250 pthread_mutex_lock (&metrics_lock);
252 metric = statsd_metric_lookup_unsafe (name, STATSD_TIMER);
255 pthread_mutex_unlock (&metrics_lock);
259 if (metric->latency == NULL)
260 metric->latency = latency_counter_create ();
261 if (metric->latency == NULL)
263 pthread_mutex_unlock (&metrics_lock);
267 latency_counter_add (metric->latency, value);
268 metric->updates_num++;
270 pthread_mutex_unlock (&metrics_lock);
272 } /* }}} int statsd_handle_timer */
274 static int statsd_handle_set (char const *name, /* {{{ */
275 char const *set_key_orig)
277 statsd_metric_t *metric = NULL;
281 pthread_mutex_lock (&metrics_lock);
283 metric = statsd_metric_lookup_unsafe (name, STATSD_SET);
286 pthread_mutex_unlock (&metrics_lock);
290 /* Make sure metric->set exists. */
291 if (metric->set == NULL)
292 metric->set = c_avl_create ((void *) strcmp);
294 if (metric->set == NULL)
296 pthread_mutex_unlock (&metrics_lock);
297 ERROR ("statsd plugin: c_avl_create failed.");
301 set_key = strdup (set_key_orig);
304 pthread_mutex_unlock (&metrics_lock);
305 ERROR ("statsd plugin: strdup failed.");
309 status = c_avl_insert (metric->set, set_key, /* value = */ NULL);
312 pthread_mutex_unlock (&metrics_lock);
314 ERROR ("statsd plugin: c_avl_insert (\"%s\") failed with status %i.",
319 else if (status > 0) /* key already exists */
324 metric->updates_num++;
326 pthread_mutex_unlock (&metrics_lock);
328 } /* }}} int statsd_handle_set */
330 static int statsd_parse_line (char *buffer) /* {{{ */
337 type = strchr (name, '|');
343 value = strrchr (name, ':');
349 extra = strchr (type, '|');
356 if (strcmp ("c", type) == 0)
357 return (statsd_handle_counter (name, value, extra));
359 /* extra is only valid for counters */
363 if (strcmp ("g", type) == 0)
364 return (statsd_handle_gauge (name, value));
365 else if (strcmp ("ms", type) == 0)
366 return (statsd_handle_timer (name, value));
367 else if (strcmp ("s", type) == 0)
368 return (statsd_handle_set (name, value));
371 } /* }}} void statsd_parse_line */
373 static void statsd_parse_buffer (char *buffer) /* {{{ */
376 char *saveptr = NULL;
380 (ptr = strtok_r (dummy, "\r\n", &saveptr)) != NULL;
383 char *line_orig = sstrdup (ptr);
386 status = statsd_parse_line (ptr);
388 ERROR ("statsd plugin: Unable to parse line: \"%s\"", line_orig);
392 } /* }}} void statsd_parse_buffer */
394 static void statsd_network_read (int fd) /* {{{ */
400 status = recv (fd, buffer, sizeof (buffer), /* flags = */ MSG_DONTWAIT);
405 if ((errno == EAGAIN) || (errno == EWOULDBLOCK))
408 ERROR ("statsd plugin: recv(2) failed: %s",
409 sstrerror (errno, errbuf, sizeof (errbuf)));
413 buffer_size = (size_t) status;
414 if (buffer_size >= sizeof (buffer))
415 buffer_size = sizeof (buffer) - 1;
416 buffer[buffer_size] = 0;
418 statsd_parse_buffer (buffer);
419 } /* }}} void statsd_network_read */
421 static int statsd_network_init (struct pollfd **ret_fds, /* {{{ */
424 struct pollfd *fds = NULL;
427 struct addrinfo ai_hints;
428 struct addrinfo *ai_list = NULL;
429 struct addrinfo *ai_ptr;
432 char const *node = (conf_node != NULL) ? conf_node : STATSD_DEFAULT_NODE;
433 char const *service = (conf_service != NULL)
434 ? conf_service : STATSD_DEFAULT_SERVICE;
436 memset (&ai_hints, 0, sizeof (ai_hints));
437 ai_hints.ai_flags = AI_PASSIVE;
439 ai_hints.ai_flags |= AI_ADDRCONFIG;
441 ai_hints.ai_family = AF_UNSPEC;
442 ai_hints.ai_socktype = SOCK_DGRAM;
444 status = getaddrinfo (node, service, &ai_hints, &ai_list);
447 ERROR ("statsd plugin: getaddrinfo (\"%s\", \"%s\") failed: %s",
448 node, service, gai_strerror (status));
452 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
457 char dbg_node[NI_MAXHOST];
458 char dbg_service[NI_MAXSERV];
460 fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype, ai_ptr->ai_protocol);
464 ERROR ("statsd plugin: socket(2) failed: %s",
465 sstrerror (errno, errbuf, sizeof (errbuf)));
469 getnameinfo (ai_ptr->ai_addr, ai_ptr->ai_addrlen,
470 dbg_node, sizeof (dbg_node), dbg_service, sizeof (dbg_service),
471 NI_DGRAM | NI_NUMERICHOST | NI_NUMERICSERV);
472 DEBUG ("statsd plugin: Trying to bind to [%s]:%s ...", dbg_node, dbg_service);
474 status = bind (fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
478 ERROR ("statsd plugin: bind(2) failed: %s",
479 sstrerror (errno, errbuf, sizeof (errbuf)));
484 tmp = realloc (fds, sizeof (*fds) * (fds_num + 1));
487 ERROR ("statsd plugin: realloc failed.");
494 memset (tmp, 0, sizeof (*tmp));
496 tmp->events = POLLIN | POLLPRI;
499 freeaddrinfo (ai_list);
503 ERROR ("statsd plugin: Unable to create listening socket for [%s]:%s.",
504 (node != NULL) ? node : "::", service);
509 *ret_fds_num = fds_num;
511 } /* }}} int statsd_network_init */
513 static void *statsd_network_thread (void *args) /* {{{ */
515 struct pollfd *fds = NULL;
520 status = statsd_network_init (&fds, &fds_num);
523 ERROR ("statsd plugin: Unable to open listening sockets.");
524 pthread_exit ((void *) 0);
527 while (!network_thread_shutdown)
529 status = poll (fds, (nfds_t) fds_num, /* timeout = */ -1);
534 if ((errno == EINTR) || (errno == EAGAIN))
537 ERROR ("statsd plugin: poll(2) failed: %s",
538 sstrerror (errno, errbuf, sizeof (errbuf)));
542 for (i = 0; i < fds_num; i++)
544 if ((fds[i].revents & (POLLIN | POLLPRI)) == 0)
547 statsd_network_read (fds[i].fd);
550 } /* while (!network_thread_shutdown) */
553 for (i = 0; i < fds_num; i++)
558 } /* }}} void *statsd_network_thread */
560 static int statsd_config_timer_percentile (oconfig_item_t *ci) /* {{{ */
562 double percent = NAN;
566 status = cf_util_get_double (ci, &percent);
570 if ((percent <= 0.0) || (percent >= 100))
572 ERROR ("statsd plugin: The value for \"%s\" must be between 0 and 100, "
573 "exclusively.", ci->key);
577 tmp = realloc (conf_timer_percentile,
578 sizeof (*conf_timer_percentile) * (conf_timer_percentile_num + 1));
581 ERROR ("statsd plugin: realloc failed.");
584 conf_timer_percentile = tmp;
585 conf_timer_percentile[conf_timer_percentile_num] = percent;
586 conf_timer_percentile_num++;
589 } /* }}} int statsd_config_timer_percentile */
591 static int statsd_config (oconfig_item_t *ci) /* {{{ */
595 for (i = 0; i < ci->children_num; i++)
597 oconfig_item_t *child = ci->children + i;
599 if (strcasecmp ("Host", child->key) == 0)
600 cf_util_get_string (child, &conf_node);
601 else if (strcasecmp ("Port", child->key) == 0)
602 cf_util_get_service (child, &conf_service);
603 else if (strcasecmp ("DeleteCounters", child->key) == 0)
604 cf_util_get_boolean (child, &conf_delete_counters);
605 else if (strcasecmp ("DeleteTimers", child->key) == 0)
606 cf_util_get_boolean (child, &conf_delete_timers);
607 else if (strcasecmp ("DeleteGauges", child->key) == 0)
608 cf_util_get_boolean (child, &conf_delete_gauges);
609 else if (strcasecmp ("DeleteSets", child->key) == 0)
610 cf_util_get_boolean (child, &conf_delete_sets);
611 else if (strcasecmp ("TimerPercentile", child->key) == 0)
612 statsd_config_timer_percentile (child);
614 ERROR ("statsd plugin: The \"%s\" config option is not valid.",
619 } /* }}} int statsd_config */
621 static int statsd_init (void) /* {{{ */
623 pthread_mutex_lock (&metrics_lock);
624 if (metrics_tree == NULL)
625 metrics_tree = c_avl_create ((void *) strcasecmp);
627 if (!network_thread_running)
631 status = pthread_create (&network_thread,
633 statsd_network_thread,
638 pthread_mutex_unlock (&metrics_lock);
639 ERROR ("statsd plugin: pthread_create failed: %s",
640 sstrerror (errno, errbuf, sizeof (errbuf)));
644 network_thread_running = 1;
646 pthread_mutex_unlock (&metrics_lock);
649 } /* }}} int statsd_init */
651 /* Must hold metrics_lock when calling this function. */
652 static int statsd_metric_clear_set_unsafe (statsd_metric_t *metric) /* {{{ */
657 if ((metric == NULL) || (metric->type != STATSD_SET))
660 if (metric->set == NULL)
663 while (c_avl_pick (metric->set, &key, &value) == 0)
670 } /* }}} int statsd_metric_clear_set_unsafe */
672 /* Must hold metrics_lock when calling this function. */
673 static int statsd_metric_submit_unsafe (char const *name, /* {{{ */
674 statsd_metric_t const *metric)
677 value_list_t vl = VALUE_LIST_INIT;
681 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
682 sstrncpy (vl.plugin, "statsd", sizeof (vl.plugin));
684 if (metric->type == STATSD_GAUGE)
685 sstrncpy (vl.type, "gauge", sizeof (vl.type));
686 else if (metric->type == STATSD_TIMER)
687 sstrncpy (vl.type, "latency", sizeof (vl.type));
688 else if (metric->type == STATSD_SET)
689 sstrncpy (vl.type, "objects", sizeof (vl.type));
690 else /* if (metric->type == STATSD_COUNTER) */
691 sstrncpy (vl.type, "derive", sizeof (vl.type));
693 sstrncpy (vl.type_instance, name, sizeof (vl.type_instance));
695 if (metric->type == STATSD_GAUGE)
696 values[0].gauge = (gauge_t) metric->value;
697 else if (metric->type == STATSD_TIMER)
701 if (metric->updates_num == 0)
706 ssnprintf (vl.type_instance, sizeof (vl.type_instance),
708 values[0].gauge = CDTIME_T_TO_DOUBLE (
709 latency_counter_get_average (metric->latency));
710 plugin_dispatch_values (&vl);
712 for (i = 0; i < conf_timer_percentile_num; i++)
714 ssnprintf (vl.type_instance, sizeof (vl.type_instance),
715 "%s-percentile-%.0f", name, conf_timer_percentile[i]);
716 values[0].gauge = CDTIME_T_TO_DOUBLE (
717 latency_counter_get_percentile (
718 metric->latency, conf_timer_percentile[i]));
719 plugin_dispatch_values (&vl);
722 latency_counter_reset (metric->latency);
725 else if (metric->type == STATSD_SET)
727 if (metric->set == NULL)
728 values[0].gauge = 0.0;
730 values[0].gauge = (gauge_t) c_avl_size (metric->set);
733 values[0].derive = (derive_t) metric->value;
735 return (plugin_dispatch_values (&vl));
736 } /* }}} int statsd_metric_submit_unsafe */
738 static int statsd_read (void) /* {{{ */
740 c_avl_iterator_t *iter;
742 statsd_metric_t *metric;
744 char **to_be_deleted = NULL;
745 size_t to_be_deleted_num = 0;
748 pthread_mutex_lock (&metrics_lock);
750 if (metrics_tree == NULL)
752 pthread_mutex_unlock (&metrics_lock);
756 iter = c_avl_get_iterator (metrics_tree);
757 while (c_avl_iterator_next (iter, (void *) &name, (void *) &metric) == 0)
759 if ((metric->updates_num == 0)
760 && ((conf_delete_counters && (metric->type == STATSD_COUNTER))
761 || (conf_delete_timers && (metric->type == STATSD_TIMER))
762 || (conf_delete_gauges && (metric->type == STATSD_GAUGE))
763 || (conf_delete_sets && (metric->type == STATSD_SET))))
765 DEBUG ("statsd plugin: Deleting metric \"%s\".", name);
766 strarray_add (&to_be_deleted, &to_be_deleted_num, name);
770 /* Names have a prefix, e.g. "c:", which determines the (statsd) type.
771 * Remove this here. */
772 statsd_metric_submit_unsafe (name + 2, metric);
774 /* Reset the metric. */
775 metric->updates_num = 0;
776 if (metric->type == STATSD_SET)
777 statsd_metric_clear_set_unsafe (metric);
779 c_avl_iterator_destroy (iter);
781 for (i = 0; i < to_be_deleted_num; i++)
785 status = c_avl_remove (metrics_tree, to_be_deleted[i],
786 (void *) &name, (void *) &metric);
789 ERROR ("stats plugin: c_avl_remove (\"%s\") failed with status %i.",
790 to_be_deleted[i], status);
798 pthread_mutex_unlock (&metrics_lock);
800 strarray_free (to_be_deleted, to_be_deleted_num);
803 } /* }}} int statsd_read */
805 static int statsd_shutdown (void) /* {{{ */
810 pthread_mutex_lock (&metrics_lock);
812 if (network_thread_running)
814 network_thread_shutdown = 1;
815 pthread_kill (network_thread, SIGTERM);
816 pthread_join (network_thread, /* retval = */ NULL);
818 network_thread_running = 0;
820 while (c_avl_pick (metrics_tree, &key, &value) == 0)
825 c_avl_destroy (metrics_tree);
829 sfree (conf_service);
831 pthread_mutex_unlock (&metrics_lock);
834 } /* }}} int statsd_shutdown */
836 void module_register (void)
838 plugin_register_complex_config ("statsd", statsd_config);
839 plugin_register_init ("statsd", statsd_init);
840 plugin_register_read ("statsd", statsd_read);
841 plugin_register_shutdown ("statsd", statsd_shutdown);
844 /* vim: set sw=2 sts=2 et fdm=marker : */