src/statsd.c

   1 /**
   2  * collectd - src/statsd.c
   3  * Copyright (C) 2013       Florian octo Forster
   4  *
   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:
  11  *
  12  * The above copyright notice and this permission notice shall be included in
  13  * all copies or substantial portions of the Software.
  14  *
  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.
  22  *
  23  * Authors:
  24  *   Florian octo Forster <octo at collectd.org>
  25  */
  26
  27 #include "collectd.h"
  28 #include "plugin.h"
  29 #include "common.h"
  30 #include "configfile.h"
  31 #include "utils_avltree.h"
  32 #include "utils_latency.h"
  33
  34 #include <sys/types.h>
  35 #include <netdb.h>
  36 #include <poll.h>
  37
  38 /* AIX doesn't have MSG_DONTWAIT */
  39 #ifndef MSG_DONTWAIT
  40 #  define MSG_DONTWAIT MSG_NONBLOCK
  41 #endif
  42
  43 #ifndef STATSD_DEFAULT_NODE
  44 # define STATSD_DEFAULT_NODE NULL
  45 #endif
  46
  47 #ifndef STATSD_DEFAULT_SERVICE
  48 # define STATSD_DEFAULT_SERVICE "8125"
  49 #endif
  50
  51 enum metric_type_e
  52 {
  53   STATSD_COUNTER,
  54   STATSD_TIMER,
  55   STATSD_GAUGE,
  56   STATSD_SET
  57 };
  58 typedef enum metric_type_e metric_type_t;
  59
  60 struct statsd_metric_s
  61 {
  62   metric_type_t type;
  63   double value;
  64   derive_t counter;
  65   latency_counter_t *latency;
  66   c_avl_tree_t *set;
  67   unsigned long updates_num;
  68 };
  69 typedef struct statsd_metric_s statsd_metric_t;
  70
  71 static c_avl_tree_t   *metrics_tree = NULL;
  72 static pthread_mutex_t metrics_lock = PTHREAD_MUTEX_INITIALIZER;
  73
  74 static pthread_t network_thread;
  75 static _Bool     network_thread_running = 0;
  76 static _Bool     network_thread_shutdown = 0;
  77
  78 static char *conf_node = NULL;
  79 static char *conf_service = NULL;
  80
  81 static _Bool conf_delete_counters = 0;
  82 static _Bool conf_delete_timers   = 0;
  83 static _Bool conf_delete_gauges   = 0;
  84 static _Bool conf_delete_sets     = 0;
  85
  86 static double *conf_timer_percentile = NULL;
  87 static size_t  conf_timer_percentile_num = 0;
  88
  89 static _Bool conf_counter_sum     = 0;
  90 static _Bool conf_timer_lower     = 0;
  91 static _Bool conf_timer_upper     = 0;
  92 static _Bool conf_timer_sum       = 0;
  93 static _Bool conf_timer_count     = 0;
  94
  95 /* Must hold metrics_lock when calling this function. */
  96 static statsd_metric_t *statsd_metric_lookup_unsafe (char const *name, /* {{{ */
  97     metric_type_t type)
  98 {
  99   char key[DATA_MAX_NAME_LEN + 2];
 100   char *key_copy;
 101   statsd_metric_t *metric;
 102   int status;
 103
 104   switch (type)
 105   {
 106     case STATSD_COUNTER: key[0] = 'c'; break;
 107     case STATSD_TIMER:   key[0] = 't'; break;
 108     case STATSD_GAUGE:   key[0] = 'g'; break;
 109     case STATSD_SET:     key[0] = 's'; break;
 110     default: return (NULL);
 111   }
 112
 113   key[1] = ':';
 114   sstrncpy (&key[2], name, sizeof (key) - 2);
 115
 116   status = c_avl_get (metrics_tree, key, (void *) &metric);
 117   if (status == 0)
 118     return (metric);
 119
 120   key_copy = strdup (key);
 121   if (key_copy == NULL)
 122   {
 123     ERROR ("statsd plugin: strdup failed.");
 124     return (NULL);
 125   }
 126
 127   metric = calloc (1, sizeof (*metric));
 128   if (metric == NULL)
 129   {
 130     ERROR ("statsd plugin: calloc failed.");
 131     sfree (key_copy);
 132     return (NULL);
 133   }
 134
 135   metric->type = type;
 136   metric->latency = NULL;
 137   metric->set = NULL;
 138
 139   status = c_avl_insert (metrics_tree, key_copy, metric);
 140   if (status != 0)
 141   {
 142     ERROR ("statsd plugin: c_avl_insert failed.");
 143     sfree (key_copy);
 144     sfree (metric);
 145     return (NULL);
 146   }
 147
 148   return (metric);
 149 } /* }}} statsd_metric_lookup_unsafe */
 150
 151 static int statsd_metric_set (char const *name, double value, /* {{{ */
 152     metric_type_t type)
 153 {
 154   statsd_metric_t *metric;
 155
 156   pthread_mutex_lock (&metrics_lock);
 157
 158   metric = statsd_metric_lookup_unsafe (name, type);
 159   if (metric == NULL)
 160   {
 161     pthread_mutex_unlock (&metrics_lock);
 162     return (-1);
 163   }
 164
 165   metric->value = value;
 166   metric->updates_num++;
 167
 168   pthread_mutex_unlock (&metrics_lock);
 169
 170   return (0);
 171 } /* }}} int statsd_metric_set */
 172
 173 static int statsd_metric_add (char const *name, double delta, /* {{{ */
 174     metric_type_t type)
 175 {
 176   statsd_metric_t *metric;
 177
 178   pthread_mutex_lock (&metrics_lock);
 179
 180   metric = statsd_metric_lookup_unsafe (name, type);
 181   if (metric == NULL)
 182   {
 183     pthread_mutex_unlock (&metrics_lock);
 184     return (-1);
 185   }
 186
 187   metric->value += delta;
 188   metric->updates_num++;
 189
 190   pthread_mutex_unlock (&metrics_lock);
 191
 192   return (0);
 193 } /* }}} int statsd_metric_add */
 194
 195 static void statsd_metric_free (statsd_metric_t *metric) /* {{{ */
 196 {
 197   if (metric == NULL)
 198     return;
 199
 200   if (metric->latency != NULL)
 201   {
 202     latency_counter_destroy (metric->latency);
 203     metric->latency = NULL;
 204   }
 205
 206   if (metric->set != NULL)
 207   {
 208     void *key;
 209     void *value;
 210
 211     while (c_avl_pick (metric->set, &key, &value) == 0)
 212     {
 213       sfree (key);
 214       assert (value == NULL);
 215     }
 216
 217     c_avl_destroy (metric->set);
 218     metric->set = NULL;
 219   }
 220
 221   sfree (metric);
 222 } /* }}} void statsd_metric_free */
 223
 224 static int statsd_parse_value (char const *str, value_t *ret_value) /* {{{ */
 225 {
 226   char *endptr = NULL;
 227
 228   ret_value->gauge = (gauge_t) strtod (str, &endptr);
 229   if ((str == endptr) || ((endptr != NULL) && (*endptr != 0)))
 230     return (-1);
 231
 232   return (0);
 233 } /* }}} int statsd_parse_value */
 234
 235 static int statsd_handle_counter (char const *name, /* {{{ */
 236     char const *value_str,
 237     char const *extra)
 238 {
 239   value_t value;
 240   value_t scale;
 241   int status;
 242
 243   if ((extra != NULL) && (extra[0] != '@'))
 244     return (-1);
 245
 246   scale.gauge = 1.0;
 247   if (extra != NULL)
 248   {
 249     status = statsd_parse_value (extra + 1, &scale);
 250     if (status != 0)
 251       return (status);
 252
 253     if (!isfinite (scale.gauge) || (scale.gauge <= 0.0) || (scale.gauge > 1.0))
 254       return (-1);
 255   }
 256
 257   value.gauge = 1.0;
 258   status = statsd_parse_value (value_str, &value);
 259   if (status != 0)
 260     return (status);
 261
 262   /* Changes to the counter are added to (statsd_metric_t*)->value. ->counter is
 263    * only updated in statsd_metric_submit_unsafe(). */
 264   return (statsd_metric_add (name, (double) (value.gauge / scale.gauge),
 265         STATSD_COUNTER));
 266 } /* }}} int statsd_handle_counter */
 267
 268 static int statsd_handle_gauge (char const *name, /* {{{ */
 269     char const *value_str)
 270 {
 271   value_t value;
 272   int status;
 273
 274   value.gauge = 0;
 275   status = statsd_parse_value (value_str, &value);
 276   if (status != 0)
 277     return (status);
 278
 279   if ((value_str[0] == '+') || (value_str[0] == '-'))
 280     return (statsd_metric_add (name, (double) value.gauge, STATSD_GAUGE));
 281   else
 282     return (statsd_metric_set (name, (double) value.gauge, STATSD_GAUGE));
 283 } /* }}} int statsd_handle_gauge */
 284
 285 static int statsd_handle_timer (char const *name, /* {{{ */
 286     char const *value_str,
 287     char const *extra)
 288 {
 289   statsd_metric_t *metric;
 290   value_t value_ms;
 291   value_t scale;
 292   cdtime_t value;
 293   int status;
 294
 295   if ((extra != NULL) && (extra[0] != '@'))
 296     return (-1);
 297
 298   scale.gauge = 1.0;
 299   if (extra != NULL)
 300   {
 301     status = statsd_parse_value (extra + 1, &scale);
 302     if (status != 0)
 303       return (status);
 304
 305     if (!isfinite (scale.gauge) || (scale.gauge <= 0.0) || (scale.gauge > 1.0))
 306       return (-1);
 307   }
 308
 309   value_ms.derive = 0;
 310   status = statsd_parse_value (value_str, &value_ms);
 311   if (status != 0)
 312     return (status);
 313
 314   value = MS_TO_CDTIME_T (value_ms.gauge / scale.gauge);
 315
 316   pthread_mutex_lock (&metrics_lock);
 317
 318   metric = statsd_metric_lookup_unsafe (name, STATSD_TIMER);
 319   if (metric == NULL)
 320   {
 321     pthread_mutex_unlock (&metrics_lock);
 322     return (-1);
 323   }
 324
 325   if (metric->latency == NULL)
 326     metric->latency = latency_counter_create ();
 327   if (metric->latency == NULL)
 328   {
 329     pthread_mutex_unlock (&metrics_lock);
 330     return (-1);
 331   }
 332
 333   latency_counter_add (metric->latency, value);
 334   metric->updates_num++;
 335
 336   pthread_mutex_unlock (&metrics_lock);
 337   return (0);
 338 } /* }}} int statsd_handle_timer */
 339
 340 static int statsd_handle_set (char const *name, /* {{{ */
 341     char const *set_key_orig)
 342 {
 343   statsd_metric_t *metric = NULL;
 344   char *set_key;
 345   int status;
 346
 347   pthread_mutex_lock (&metrics_lock);
 348
 349   metric = statsd_metric_lookup_unsafe (name, STATSD_SET);
 350   if (metric == NULL)
 351   {
 352     pthread_mutex_unlock (&metrics_lock);
 353     return (-1);
 354   }
 355
 356   /* Make sure metric->set exists. */
 357   if (metric->set == NULL)
 358     metric->set = c_avl_create ((int (*) (const void *, const void *)) strcmp);
 359
 360   if (metric->set == NULL)
 361   {
 362     pthread_mutex_unlock (&metrics_lock);
 363     ERROR ("statsd plugin: c_avl_create failed.");
 364     return (-1);
 365   }
 366
 367   set_key = strdup (set_key_orig);
 368   if (set_key == NULL)
 369   {
 370     pthread_mutex_unlock (&metrics_lock);
 371     ERROR ("statsd plugin: strdup failed.");
 372     return (-1);
 373   }
 374
 375   status = c_avl_insert (metric->set, set_key, /* value = */ NULL);
 376   if (status < 0)
 377   {
 378     pthread_mutex_unlock (&metrics_lock);
 379     if (status < 0)
 380       ERROR ("statsd plugin: c_avl_insert (\"%s\") failed with status %i.",
 381           set_key, status);
 382     sfree (set_key);
 383     return (-1);
 384   }
 385   else if (status > 0) /* key already exists */
 386   {
 387     sfree (set_key);
 388   }
 389
 390   metric->updates_num++;
 391
 392   pthread_mutex_unlock (&metrics_lock);
 393   return (0);
 394 } /* }}} int statsd_handle_set */
 395
 396 static int statsd_parse_line (char *buffer) /* {{{ */
 397 {
 398   char *name = buffer;
 399   char *value;
 400   char *type;
 401   char *extra;
 402
 403   type = strchr (name, '|');
 404   if (type == NULL)
 405     return (-1);
 406   *type = 0;
 407   type++;
 408
 409   value = strrchr (name, ':');
 410   if (value == NULL)
 411     return (-1);
 412   *value = 0;
 413   value++;
 414
 415   extra = strchr (type, '|');
 416   if (extra != NULL)
 417   {
 418     *extra = 0;
 419     extra++;
 420   }
 421
 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));
 426
 427   /* extra is only valid for counters and timers */
 428   if (extra != NULL)
 429     return (-1);
 430
 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));
 435   else
 436     return (-1);
 437 } /* }}} void statsd_parse_line */
 438
 439 static void statsd_parse_buffer (char *buffer) /* {{{ */
 440 {
 441   while (buffer != NULL)
 442   {
 443     char orig[64];
 444     char *next;
 445     int status;
 446
 447     next = strchr (buffer, '\n');
 448     if (next != NULL)
 449     {
 450       *next = 0;
 451       next++;
 452     }
 453
 454     if (*buffer == 0)
 455     {
 456       buffer = next;
 457       continue;
 458     }
 459
 460     sstrncpy (orig, buffer, sizeof (orig));
 461
 462     status = statsd_parse_line (buffer);
 463     if (status != 0)
 464       ERROR ("statsd plugin: Unable to parse line: \"%s\"", orig);
 465
 466     buffer = next;
 467   }
 468 } /* }}} void statsd_parse_buffer */
 469
 470 static void statsd_network_read (int fd) /* {{{ */
 471 {
 472   char buffer[4096];
 473   size_t buffer_size;
 474   ssize_t status;
 475
 476   status = recv (fd, buffer, sizeof (buffer), /* flags = */ MSG_DONTWAIT);
 477   if (status < 0)
 478   {
 479     char errbuf[1024];
 480
 481     if ((errno == EAGAIN) || (errno == EWOULDBLOCK))
 482       return;
 483
 484     ERROR ("statsd plugin: recv(2) failed: %s",
 485         sstrerror (errno, errbuf, sizeof (errbuf)));
 486     return;
 487   }
 488
 489   buffer_size = (size_t) status;
 490   if (buffer_size >= sizeof (buffer))
 491     buffer_size = sizeof (buffer) - 1;
 492   buffer[buffer_size] = 0;
 493
 494   statsd_parse_buffer (buffer);
 495 } /* }}} void statsd_network_read */
 496
 497 static int statsd_network_init (struct pollfd **ret_fds, /* {{{ */
 498     size_t *ret_fds_num)
 499 {
 500   struct pollfd *fds = NULL;
 501   size_t fds_num = 0;
 502
 503   struct addrinfo *ai_list = NULL;
 504   struct addrinfo *ai_ptr;
 505   int status;
 506
 507   char const *node = (conf_node != NULL) ? conf_node : STATSD_DEFAULT_NODE;
 508   char const *service = (conf_service != NULL)
 509     ? conf_service : STATSD_DEFAULT_SERVICE;
 510
 511   struct addrinfo ai_hints = {
 512     .ai_family = AF_UNSPEC,
 513     .ai_flags = AI_PASSIVE | AI_ADDRCONFIG,
 514     .ai_socktype = SOCK_DGRAM
 515   };
 516
 517   status = getaddrinfo (node, service, &ai_hints, &ai_list);
 518   if (status != 0)
 519   {
 520     ERROR ("statsd plugin: getaddrinfo (\"%s\", \"%s\") failed: %s",
 521         node, service, gai_strerror (status));
 522     return (status);
 523   }
 524
 525   for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
 526   {
 527     int fd;
 528     struct pollfd *tmp;
 529
 530     char dbg_node[NI_MAXHOST];
 531     char dbg_service[NI_MAXSERV];
 532
 533     fd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype, ai_ptr->ai_protocol);
 534     if (fd < 0)
 535     {
 536       char errbuf[1024];
 537       ERROR ("statsd plugin: socket(2) failed: %s",
 538           sstrerror (errno, errbuf, sizeof (errbuf)));
 539       continue;
 540     }
 541
 542     getnameinfo (ai_ptr->ai_addr, ai_ptr->ai_addrlen,
 543         dbg_node, sizeof (dbg_node), dbg_service, sizeof (dbg_service),
 544         NI_DGRAM | NI_NUMERICHOST | NI_NUMERICSERV);
 545     DEBUG ("statsd plugin: Trying to bind to [%s]:%s ...", dbg_node, dbg_service);
 546
 547     status = bind (fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
 548     if (status != 0)
 549     {
 550       char errbuf[1024];
 551       ERROR ("statsd plugin: bind(2) failed: %s",
 552           sstrerror (errno, errbuf, sizeof (errbuf)));
 553       close (fd);
 554       continue;
 555     }
 556
 557     tmp = realloc (fds, sizeof (*fds) * (fds_num + 1));
 558     if (tmp == NULL)
 559     {
 560       ERROR ("statsd plugin: realloc failed.");
 561       close (fd);
 562       continue;
 563     }
 564     fds = tmp;
 565     tmp = fds + fds_num;
 566     fds_num++;
 567
 568     memset (tmp, 0, sizeof (*tmp));
 569     tmp->fd = fd;
 570     tmp->events = POLLIN | POLLPRI;
 571   }
 572
 573   freeaddrinfo (ai_list);
 574
 575   if (fds_num == 0)
 576   {
 577     ERROR ("statsd plugin: Unable to create listening socket for [%s]:%s.",
 578         (node != NULL) ? node : "::", service);
 579     return (ENOENT);
 580   }
 581
 582   *ret_fds = fds;
 583   *ret_fds_num = fds_num;
 584   return (0);
 585 } /* }}} int statsd_network_init */
 586
 587 static void *statsd_network_thread (void *args) /* {{{ */
 588 {
 589   struct pollfd *fds = NULL;
 590   size_t fds_num = 0;
 591   int status;
 592   size_t i;
 593
 594   status = statsd_network_init (&fds, &fds_num);
 595   if (status != 0)
 596   {
 597     ERROR ("statsd plugin: Unable to open listening sockets.");
 598     pthread_exit ((void *) 0);
 599   }
 600
 601   while (!network_thread_shutdown)
 602   {
 603     status = poll (fds, (nfds_t) fds_num, /* timeout = */ -1);
 604     if (status < 0)
 605     {
 606       char errbuf[1024];
 607
 608       if ((errno == EINTR) || (errno == EAGAIN))
 609         continue;
 610
 611       ERROR ("statsd plugin: poll(2) failed: %s",
 612           sstrerror (errno, errbuf, sizeof (errbuf)));
 613       break;
 614     }
 615
 616     for (i = 0; i < fds_num; i++)
 617     {
 618       if ((fds[i].revents & (POLLIN | POLLPRI)) == 0)
 619         continue;
 620
 621       statsd_network_read (fds[i].fd);
 622       fds[i].revents = 0;
 623     }
 624   } /* while (!network_thread_shutdown) */
 625
 626   /* Clean up */
 627   for (i = 0; i < fds_num; i++)
 628     close (fds[i].fd);
 629   sfree (fds);
 630
 631   return ((void *) 0);
 632 } /* }}} void *statsd_network_thread */
 633
 634 static int statsd_config_timer_percentile (oconfig_item_t *ci) /* {{{ */
 635 {
 636   double percent = NAN;
 637   double *tmp;
 638   int status;
 639
 640   status = cf_util_get_double (ci, &percent);
 641   if (status != 0)
 642     return (status);
 643
 644   if ((percent <= 0.0) || (percent >= 100))
 645   {
 646     ERROR ("statsd plugin: The value for \"%s\" must be between 0 and 100, "
 647         "exclusively.", ci->key);
 648     return (ERANGE);
 649   }
 650
 651   tmp = realloc (conf_timer_percentile,
 652       sizeof (*conf_timer_percentile) * (conf_timer_percentile_num + 1));
 653   if (tmp == NULL)
 654   {
 655     ERROR ("statsd plugin: realloc failed.");
 656     return (ENOMEM);
 657   }
 658   conf_timer_percentile = tmp;
 659   conf_timer_percentile[conf_timer_percentile_num] = percent;
 660   conf_timer_percentile_num++;
 661
 662   return (0);
 663 } /* }}} int statsd_config_timer_percentile */
 664
 665 static int statsd_config (oconfig_item_t *ci) /* {{{ */
 666 {
 667   int i;
 668
 669   for (i = 0; i < ci->children_num; i++)
 670   {
 671     oconfig_item_t *child = ci->children + i;
 672
 673     if (strcasecmp ("Host", child->key) == 0)
 674       cf_util_get_string (child, &conf_node);
 675     else if (strcasecmp ("Port", child->key) == 0)
 676       cf_util_get_service (child, &conf_service);
 677     else if (strcasecmp ("DeleteCounters", child->key) == 0)
 678       cf_util_get_boolean (child, &conf_delete_counters);
 679     else if (strcasecmp ("DeleteTimers", child->key) == 0)
 680       cf_util_get_boolean (child, &conf_delete_timers);
 681     else if (strcasecmp ("DeleteGauges", child->key) == 0)
 682       cf_util_get_boolean (child, &conf_delete_gauges);
 683     else if (strcasecmp ("DeleteSets", child->key) == 0)
 684       cf_util_get_boolean (child, &conf_delete_sets);
 685     else if (strcasecmp ("CounterSum", child->key) == 0)
 686       cf_util_get_boolean (child, &conf_counter_sum);
 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);
 697     else
 698       ERROR ("statsd plugin: The \"%s\" config option is not valid.",
 699           child->key);
 700   }
 701
 702   return (0);
 703 } /* }}} int statsd_config */
 704
 705 static int statsd_init (void) /* {{{ */
 706 {
 707   pthread_mutex_lock (&metrics_lock);
 708   if (metrics_tree == NULL)
 709     metrics_tree = c_avl_create ((int (*) (const void *, const void *)) strcmp);
 710
 711   if (!network_thread_running)
 712   {
 713     int status;
 714
 715     status = pthread_create (&network_thread,
 716         /* attr = */ NULL,
 717         statsd_network_thread,
 718         /* args = */ NULL);
 719     if (status != 0)
 720     {
 721       char errbuf[1024];
 722       pthread_mutex_unlock (&metrics_lock);
 723       ERROR ("statsd plugin: pthread_create failed: %s",
 724           sstrerror (errno, errbuf, sizeof (errbuf)));
 725       return (status);
 726     }
 727   }
 728   network_thread_running = 1;
 729
 730   pthread_mutex_unlock (&metrics_lock);
 731
 732   return (0);
 733 } /* }}} int statsd_init */
 734
 735 /* Must hold metrics_lock when calling this function. */
 736 static int statsd_metric_clear_set_unsafe (statsd_metric_t *metric) /* {{{ */
 737 {
 738   void *key;
 739   void *value;
 740
 741   if ((metric == NULL) || (metric->type != STATSD_SET))
 742     return (EINVAL);
 743
 744   if (metric->set == NULL)
 745     return (0);
 746
 747   while (c_avl_pick (metric->set, &key, &value) == 0)
 748   {
 749     sfree (key);
 750     sfree (value);
 751   }
 752
 753   return (0);
 754 } /* }}} int statsd_metric_clear_set_unsafe */
 755
 756 /* Must hold metrics_lock when calling this function. */
 757 static int statsd_metric_submit_unsafe (char const *name, statsd_metric_t *metric) /* {{{ */
 758 {
 759   value_t values[1];
 760   value_list_t vl = VALUE_LIST_INIT;
 761
 762   vl.values = values;
 763   vl.values_len = 1;
 764   sstrncpy (vl.host, hostname_g, sizeof (vl.host));
 765   sstrncpy (vl.plugin, "statsd", sizeof (vl.plugin));
 766
 767   if (metric->type == STATSD_GAUGE)
 768     sstrncpy (vl.type, "gauge", sizeof (vl.type));
 769   else if (metric->type == STATSD_TIMER)
 770     sstrncpy (vl.type, "latency", sizeof (vl.type));
 771   else if (metric->type == STATSD_SET)
 772     sstrncpy (vl.type, "objects", sizeof (vl.type));
 773   else /* if (metric->type == STATSD_COUNTER) */
 774     sstrncpy (vl.type, "derive", sizeof (vl.type));
 775
 776   sstrncpy (vl.type_instance, name, sizeof (vl.type_instance));
 777
 778   if (metric->type == STATSD_GAUGE)
 779     values[0].gauge = (gauge_t) metric->value;
 780   else if (metric->type == STATSD_TIMER)
 781   {
 782     size_t i;
 783     _Bool have_events = (metric->updates_num > 0);
 784
 785     /* Make sure all timer metrics share the *same* timestamp. */
 786     vl.time = cdtime ();
 787
 788     ssnprintf (vl.type_instance, sizeof (vl.type_instance),
 789         "%s-average", name);
 790     values[0].gauge = have_events
 791       ? CDTIME_T_TO_DOUBLE (latency_counter_get_average (metric->latency))
 792       : NAN;
 793     plugin_dispatch_values (&vl);
 794
 795     if (conf_timer_lower) {
 796       ssnprintf (vl.type_instance, sizeof (vl.type_instance),
 797           "%s-lower", name);
 798       values[0].gauge = have_events
 799         ? CDTIME_T_TO_DOUBLE (latency_counter_get_min (metric->latency))
 800         : NAN;
 801       plugin_dispatch_values (&vl);
 802     }
 803
 804     if (conf_timer_upper) {
 805       ssnprintf (vl.type_instance, sizeof (vl.type_instance),
 806           "%s-upper", name);
 807       values[0].gauge = have_events
 808         ? CDTIME_T_TO_DOUBLE (latency_counter_get_max (metric->latency))
 809         : NAN;
 810       plugin_dispatch_values (&vl);
 811     }
 812
 813     if (conf_timer_sum) {
 814       ssnprintf (vl.type_instance, sizeof (vl.type_instance),
 815           "%s-sum", name);
 816       values[0].gauge = have_events
 817         ? CDTIME_T_TO_DOUBLE (latency_counter_get_sum (metric->latency))
 818         : NAN;
 819       plugin_dispatch_values (&vl);
 820     }
 821
 822     for (i = 0; i < conf_timer_percentile_num; i++)
 823     {
 824       ssnprintf (vl.type_instance, sizeof (vl.type_instance),
 825           "%s-percentile-%.0f", name, conf_timer_percentile[i]);
 826       values[0].gauge = have_events
 827         ? CDTIME_T_TO_DOUBLE (latency_counter_get_percentile (metric->latency, conf_timer_percentile[i]))
 828         : NAN;
 829       plugin_dispatch_values (&vl);
 830     }
 831
 832     /* Keep this at the end, since vl.type is set to "gauge" here. The
 833      * vl.type's above are implicitly set to "latency". */
 834     if (conf_timer_count) {
 835       sstrncpy (vl.type, "gauge", sizeof (vl.type));
 836       ssnprintf (vl.type_instance, sizeof (vl.type_instance),
 837           "%s-count", name);
 838       values[0].gauge = latency_counter_get_num (metric->latency);
 839       plugin_dispatch_values (&vl);
 840     }
 841
 842     latency_counter_reset (metric->latency);
 843     return (0);
 844   }
 845   else if (metric->type == STATSD_SET)
 846   {
 847     if (metric->set == NULL)
 848       values[0].gauge = 0.0;
 849     else
 850       values[0].gauge = (gauge_t) c_avl_size (metric->set);
 851   }
 852   else { /* STATSD_COUNTER */
 853     gauge_t delta = nearbyint (metric->value);
 854
 855     /* Etsy's statsd writes counters as two metrics: a rate and the change since
 856      * the last write. Since collectd does not reset its DERIVE metrics to zero,
 857      * this makes little sense, but we're dispatching a "count" metric here
 858      * anyway - if requested by the user - for compatibility reasons. */
 859     if (conf_counter_sum)
 860     {
 861       sstrncpy (vl.type, "count", sizeof (vl.type));
 862       values[0].gauge = delta;
 863       plugin_dispatch_values (&vl);
 864
 865       /* restore vl.type */
 866       sstrncpy (vl.type, "derive", sizeof (vl.type));
 867     }
 868
 869     /* Rather than resetting value to zero, subtract delta so we correctly keep
 870      * track of residuals. */
 871     metric->value   -= delta;
 872     metric->counter += (derive_t) delta;
 873
 874     values[0].derive = metric->counter;
 875   }
 876
 877   return (plugin_dispatch_values (&vl));
 878 } /* }}} int statsd_metric_submit_unsafe */
 879
 880 static int statsd_read (void) /* {{{ */
 881 {
 882   c_avl_iterator_t *iter;
 883   char *name;
 884   statsd_metric_t *metric;
 885
 886   char **to_be_deleted = NULL;
 887   size_t to_be_deleted_num = 0;
 888   size_t i;
 889
 890   pthread_mutex_lock (&metrics_lock);
 891
 892   if (metrics_tree == NULL)
 893   {
 894     pthread_mutex_unlock (&metrics_lock);
 895     return (0);
 896   }
 897
 898   iter = c_avl_get_iterator (metrics_tree);
 899   while (c_avl_iterator_next (iter, (void *) &name, (void *) &metric) == 0)
 900   {
 901     if ((metric->updates_num == 0)
 902         && ((conf_delete_counters && (metric->type == STATSD_COUNTER))
 903           || (conf_delete_timers && (metric->type == STATSD_TIMER))
 904           || (conf_delete_gauges && (metric->type == STATSD_GAUGE))
 905           || (conf_delete_sets && (metric->type == STATSD_SET))))
 906     {
 907       DEBUG ("statsd plugin: Deleting metric \"%s\".", name);
 908       strarray_add (&to_be_deleted, &to_be_deleted_num, name);
 909       continue;
 910     }
 911
 912     /* Names have a prefix, e.g. "c:", which determines the (statsd) type.
 913      * Remove this here. */
 914     statsd_metric_submit_unsafe (name + 2, metric);
 915
 916     /* Reset the metric. */
 917     metric->updates_num = 0;
 918     if (metric->type == STATSD_SET)
 919       statsd_metric_clear_set_unsafe (metric);
 920   }
 921   c_avl_iterator_destroy (iter);
 922
 923   for (i = 0; i < to_be_deleted_num; i++)
 924   {
 925     int status;
 926
 927     status = c_avl_remove (metrics_tree, to_be_deleted[i],
 928         (void *) &name, (void *) &metric);
 929     if (status != 0)
 930     {
 931       ERROR ("stats plugin: c_avl_remove (\"%s\") failed with status %i.",
 932           to_be_deleted[i], status);
 933       continue;
 934     }
 935
 936     sfree (name);
 937     statsd_metric_free (metric);
 938   }
 939
 940   pthread_mutex_unlock (&metrics_lock);
 941
 942   strarray_free (to_be_deleted, to_be_deleted_num);
 943
 944   return (0);
 945 } /* }}} int statsd_read */
 946
 947 static int statsd_shutdown (void) /* {{{ */
 948 {
 949   void *key;
 950   void *value;
 951
 952   if (network_thread_running)
 953   {
 954     network_thread_shutdown = 1;
 955     pthread_kill (network_thread, SIGTERM);
 956     pthread_join (network_thread, /* retval = */ NULL);
 957   }
 958   network_thread_running = 0;
 959
 960   pthread_mutex_lock (&metrics_lock);
 961
 962   while (c_avl_pick (metrics_tree, &key, &value) == 0)
 963   {
 964     sfree (key);
 965     statsd_metric_free (value);
 966   }
 967   c_avl_destroy (metrics_tree);
 968   metrics_tree = NULL;
 969
 970   sfree (conf_node);
 971   sfree (conf_service);
 972
 973   pthread_mutex_unlock (&metrics_lock);
 974
 975   return (0);
 976 } /* }}} int statsd_shutdown */
 977
 978 void module_register (void)
 979 {
 980   plugin_register_complex_config ("statsd", statsd_config);
 981   plugin_register_init ("statsd", statsd_init);
 982   plugin_register_read ("statsd", statsd_read);
 983   plugin_register_shutdown ("statsd", statsd_shutdown);
 984 }
 985
 986 /* vim: set sw=2 sts=2 et fdm=marker : */