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