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