src/rrdcached.c

   1 /**
   2  * collectd - src/rrdcached.c
   3  * Copyright (C) 2008-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
  29 #include "plugin.h"
  30 #include "common.h"
  31 #include "utils_rrdcreate.h"
  32
  33 #undef HAVE_CONFIG_H
  34 #include <rrd.h>
  35 #include <rrd_client.h>
  36
  37 /*
  38  * Private variables
  39  */
  40 static char *datadir = NULL;
  41 static char *daemon_address = NULL;
  42 static _Bool config_create_files = 1;
  43 static _Bool config_collect_stats = 1;
  44 static rrdcreate_config_t rrdcreate_config =
  45 {
  46         /* stepsize = */ 0,
  47         /* heartbeat = */ 0,
  48         /* rrarows = */ 1200,
  49         /* xff = */ 0.1,
  50
  51         /* timespans = */ NULL,
  52         /* timespans_num = */ 0,
  53
  54         /* consolidation_functions = */ NULL,
  55         /* consolidation_functions_num = */ 0,
  56
  57         /* async = */ 0
  58 };
  59
  60 /*
  61  * Prototypes.
  62  */
  63 static int rc_write (const data_set_t *ds, const value_list_t *vl,
  64     user_data_t __attribute__((unused)) *user_data);
  65 static int rc_flush (__attribute__((unused)) cdtime_t timeout,
  66     const char *identifier, __attribute__((unused)) user_data_t *ud);
  67
  68 static int value_list_to_string (char *buffer, int buffer_len,
  69     const data_set_t *ds, const value_list_t *vl)
  70 {
  71   int offset;
  72   int status;
  73   time_t t;
  74
  75   assert (0 == strcmp (ds->type, vl->type));
  76
  77   memset (buffer, '\0', buffer_len);
  78
  79   t = CDTIME_T_TO_TIME_T (vl->time);
  80   status = ssnprintf (buffer, buffer_len, "%lu", (unsigned long) t);
  81   if ((status < 1) || (status >= buffer_len))
  82     return (-1);
  83   offset = status;
  84
  85   for (size_t i = 0; i < ds->ds_num; i++)
  86   {
  87     if ((ds->ds[i].type != DS_TYPE_COUNTER)
  88         && (ds->ds[i].type != DS_TYPE_GAUGE)
  89         && (ds->ds[i].type != DS_TYPE_DERIVE)
  90         && (ds->ds[i].type != DS_TYPE_ABSOLUTE))
  91       return (-1);
  92
  93     if (ds->ds[i].type == DS_TYPE_COUNTER)
  94     {
  95       status = ssnprintf (buffer + offset, buffer_len - offset,
  96           ":%llu", vl->values[i].counter);
  97     }
  98     else if (ds->ds[i].type == DS_TYPE_GAUGE)
  99     {
 100       status = ssnprintf (buffer + offset, buffer_len - offset,
 101           ":%f", vl->values[i].gauge);
 102     }
 103     else if (ds->ds[i].type == DS_TYPE_DERIVE) {
 104       status = ssnprintf (buffer + offset, buffer_len - offset,
 105           ":%"PRIi64, vl->values[i].derive);
 106     }
 107     else /* if (ds->ds[i].type == DS_TYPE_ABSOLUTE) */ {
 108       status = ssnprintf (buffer + offset, buffer_len - offset,
 109           ":%"PRIu64, vl->values[i].absolute);
 110
 111     }
 112
 113     if ((status < 1) || (status >= (buffer_len - offset)))
 114       return (-1);
 115
 116     offset += status;
 117   } /* for ds->ds_num */
 118
 119   return (0);
 120 } /* int value_list_to_string */
 121
 122 static int value_list_to_filename (char *buffer, size_t buffer_size,
 123     value_list_t const *vl)
 124 {
 125   char const suffix[] = ".rrd";
 126   int status;
 127   size_t len;
 128
 129   if (datadir != NULL)
 130   {
 131     size_t datadir_len = strlen (datadir) + 1;
 132
 133     if (datadir_len >= buffer_size)
 134       return (ENOMEM);
 135
 136     sstrncpy (buffer, datadir, buffer_size);
 137     buffer[datadir_len - 1] = '/';
 138     buffer[datadir_len] = 0;
 139
 140     buffer += datadir_len;
 141     buffer_size -= datadir_len;
 142   }
 143
 144   status = FORMAT_VL (buffer, buffer_size, vl);
 145   if (status != 0)
 146     return (status);
 147
 148   len = strlen (buffer);
 149   assert (len < buffer_size);
 150   buffer += len;
 151   buffer_size -= len;
 152
 153   if (buffer_size <= sizeof (suffix))
 154     return (ENOMEM);
 155
 156   memcpy (buffer, suffix, sizeof (suffix));
 157   return (0);
 158 } /* int value_list_to_filename */
 159
 160 static int rc_config_get_int_positive (oconfig_item_t const *ci, int *ret)
 161 {
 162   int status;
 163   int tmp = 0;
 164
 165   status = cf_util_get_int (ci, &tmp);
 166   if (status != 0)
 167     return (status);
 168   if (tmp < 0)
 169     return (EINVAL);
 170
 171   *ret = tmp;
 172   return (0);
 173 } /* int rc_config_get_int_positive */
 174
 175 static int rc_config_get_xff (oconfig_item_t const *ci, double *ret)
 176 {
 177   double value;
 178
 179   if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
 180   {
 181     ERROR ("rrdcached plugin: The \"%s\" needs exactly one numeric argument "
 182         "in the range [0.0, 1.0)", ci->key);
 183     return (EINVAL);
 184   }
 185
 186   value = ci->values[0].value.number;
 187   if ((value >= 0.0) && (value < 1.0))
 188   {
 189     *ret = value;
 190     return (0);
 191   }
 192
 193   ERROR ("rrdcached plugin: The \"%s\" needs exactly one numeric argument "
 194       "in the range [0.0, 1.0)", ci->key);
 195   return (EINVAL);
 196 } /* int rc_config_get_xff */
 197
 198 static int rc_config_add_timespan (int timespan)
 199 {
 200   int *tmp;
 201
 202   if (timespan <= 0)
 203     return (EINVAL);
 204
 205   tmp = realloc (rrdcreate_config.timespans,
 206       sizeof (*rrdcreate_config.timespans)
 207       * (rrdcreate_config.timespans_num + 1));
 208   if (tmp == NULL)
 209     return (ENOMEM);
 210   rrdcreate_config.timespans = tmp;
 211
 212   rrdcreate_config.timespans[rrdcreate_config.timespans_num] = timespan;
 213   rrdcreate_config.timespans_num++;
 214
 215   return (0);
 216 } /* int rc_config_add_timespan */
 217
 218 static int rc_config (oconfig_item_t *ci)
 219 {
 220   for (int i = 0; i < ci->children_num; i++)
 221   {
 222     oconfig_item_t const *child = ci->children + i;
 223     const char *key = child->key;
 224     int status = 0;
 225
 226     if (strcasecmp ("DataDir", key) == 0)
 227     {
 228       status = cf_util_get_string (child, &datadir);
 229       if (status == 0)
 230       {
 231         int len = strlen (datadir);
 232
 233         while ((len > 0) && (datadir[len - 1] == '/'))
 234         {
 235           len--;
 236           datadir[len] = 0;
 237         }
 238
 239         if (len <= 0)
 240           sfree (datadir);
 241       }
 242     }
 243     else if (strcasecmp ("DaemonAddress", key) == 0)
 244       status = cf_util_get_string (child, &daemon_address);
 245     else if (strcasecmp ("CreateFiles", key) == 0)
 246       status = cf_util_get_boolean (child, &config_create_files);
 247     else if (strcasecmp ("CreateFilesAsync", key) == 0)
 248       status = cf_util_get_boolean (child, &rrdcreate_config.async);
 249     else if (strcasecmp ("CollectStatistics", key) == 0)
 250       status = cf_util_get_boolean (child, &config_collect_stats);
 251     else if (strcasecmp ("StepSize", key) == 0)
 252     {
 253       int tmp = -1;
 254
 255       status = rc_config_get_int_positive (child, &tmp);
 256       if (status == 0)
 257         rrdcreate_config.stepsize = (unsigned long) tmp;
 258     }
 259     else if (strcasecmp ("HeartBeat", key) == 0)
 260       status = rc_config_get_int_positive (child, &rrdcreate_config.heartbeat);
 261     else if (strcasecmp ("RRARows", key) == 0)
 262       status = rc_config_get_int_positive (child, &rrdcreate_config.rrarows);
 263     else if (strcasecmp ("RRATimespan", key) == 0)
 264     {
 265       int tmp = -1;
 266       status = rc_config_get_int_positive (child, &tmp);
 267       if (status == 0)
 268         status = rc_config_add_timespan (tmp);
 269     }
 270     else if (strcasecmp ("XFF", key) == 0)
 271       status = rc_config_get_xff (child, &rrdcreate_config.xff);
 272     else
 273     {
 274       WARNING ("rrdcached plugin: Ignoring invalid option %s.", key);
 275       continue;
 276     }
 277
 278     if (status != 0)
 279       WARNING ("rrdcached plugin: Handling the \"%s\" option failed.", key);
 280   }
 281
 282   if (daemon_address != NULL)
 283   {
 284     plugin_register_write ("rrdcached", rc_write, /* user_data = */ NULL);
 285     plugin_register_flush ("rrdcached", rc_flush, /* user_data = */ NULL);
 286   }
 287   return (0);
 288 } /* int rc_config */
 289
 290 static int try_reconnect (void)
 291 {
 292   int status;
 293
 294   rrdc_disconnect ();
 295
 296   rrd_clear_error ();
 297   status = rrdc_connect (daemon_address);
 298   if (status != 0)
 299   {
 300     ERROR ("rrdcached plugin: Failed to reconnect to RRDCacheD "
 301         "at %s: %s (status=%d)", daemon_address, rrd_get_error (), status);
 302     return (-1);
 303   }
 304
 305   INFO ("rrdcached plugin: Successfully reconnected to RRDCacheD "
 306       "at %s", daemon_address);
 307   return (0);
 308 } /* int try_reconnect */
 309
 310 static int rc_read (void)
 311 {
 312   int status;
 313   rrdc_stats_t *head;
 314   _Bool retried = 0;
 315
 316   value_t values[1];
 317   value_list_t vl = VALUE_LIST_INIT;
 318
 319   if (daemon_address == NULL)
 320     return (-1);
 321
 322   if (!config_collect_stats)
 323     return (-1);
 324
 325   vl.values = values;
 326   vl.values_len = 1;
 327
 328   if ((strncmp ("unix:", daemon_address, strlen ("unix:")) == 0)
 329       || (daemon_address[0] == '/'))
 330     sstrncpy (vl.host, hostname_g, sizeof (vl.host));
 331   else
 332     sstrncpy (vl.host, daemon_address, sizeof (vl.host));
 333   sstrncpy (vl.plugin, "rrdcached", sizeof (vl.plugin));
 334
 335   rrd_clear_error ();
 336   status = rrdc_connect (daemon_address);
 337   if (status != 0)
 338   {
 339     ERROR ("rrdcached plugin: Failed to connect to RRDCacheD "
 340         "at %s: %s (status=%d)", daemon_address, rrd_get_error (), status);
 341     return (-1);
 342   }
 343
 344   while (42)
 345   {
 346     /* The RRD client lib does not provide any means for checking a
 347      * connection, hence we'll have to retry upon failed operations. */
 348     head = NULL;
 349     rrd_clear_error ();
 350     status = rrdc_stats_get (&head);
 351     if (status == 0)
 352       break;
 353
 354     if (!retried)
 355     {
 356       retried = 1;
 357       if (try_reconnect () == 0)
 358         continue;
 359       /* else: report the error and fail */
 360     }
 361
 362     ERROR ("rrdcached plugin: rrdc_stats_get failed: %s (status=%i).",
 363         rrd_get_error (), status);
 364     return (-1);
 365   }
 366
 367   for (rrdc_stats_t *ptr = head; ptr != NULL; ptr = ptr->next)
 368   {
 369     if (ptr->type == RRDC_STATS_TYPE_GAUGE)
 370       values[0].gauge = (gauge_t) ptr->value.gauge;
 371     else if (ptr->type == RRDC_STATS_TYPE_COUNTER)
 372       values[0].counter = (counter_t) ptr->value.counter;
 373     else
 374       continue;
 375
 376     if (strcasecmp ("QueueLength", ptr->name) == 0)
 377     {
 378       sstrncpy (vl.type, "queue_length", sizeof (vl.type));
 379       sstrncpy (vl.type_instance, "", sizeof (vl.type_instance));
 380     }
 381     else if (strcasecmp ("UpdatesWritten", ptr->name) == 0)
 382     {
 383       sstrncpy (vl.type, "operations", sizeof (vl.type));
 384       sstrncpy (vl.type_instance, "write-updates", sizeof (vl.type_instance));
 385     }
 386     else if (strcasecmp ("DataSetsWritten", ptr->name) == 0)
 387     {
 388       sstrncpy (vl.type, "operations", sizeof (vl.type));
 389       sstrncpy (vl.type_instance, "write-data_sets",
 390           sizeof (vl.type_instance));
 391     }
 392     else if (strcasecmp ("TreeNodesNumber", ptr->name) == 0)
 393     {
 394       sstrncpy (vl.type, "gauge", sizeof (vl.type));
 395       sstrncpy (vl.type_instance, "tree_nodes", sizeof (vl.type_instance));
 396     }
 397     else if (strcasecmp ("TreeDepth", ptr->name) == 0)
 398     {
 399       sstrncpy (vl.type, "gauge", sizeof (vl.type));
 400       sstrncpy (vl.type_instance, "tree_depth", sizeof (vl.type_instance));
 401     }
 402     else if (strcasecmp ("FlushesReceived", ptr->name) == 0)
 403     {
 404       sstrncpy (vl.type, "operations", sizeof (vl.type));
 405       sstrncpy (vl.type_instance, "receive-flush", sizeof (vl.type_instance));
 406     }
 407     else if (strcasecmp ("JournalBytes", ptr->name) == 0)
 408     {
 409       sstrncpy (vl.type, "counter", sizeof (vl.type));
 410       sstrncpy (vl.type_instance, "journal-bytes", sizeof (vl.type_instance));
 411     }
 412     else if (strcasecmp ("JournalRotate", ptr->name) == 0)
 413     {
 414       sstrncpy (vl.type, "counter", sizeof (vl.type));
 415       sstrncpy (vl.type_instance, "journal-rotates", sizeof (vl.type_instance));
 416     }
 417     else if (strcasecmp ("UpdatesReceived", ptr->name) == 0)
 418     {
 419       sstrncpy (vl.type, "operations", sizeof (vl.type));
 420       sstrncpy (vl.type_instance, "receive-update", sizeof (vl.type_instance));
 421     }
 422     else
 423     {
 424       DEBUG ("rrdcached plugin: rc_read: Unknown statistic `%s'.", ptr->name);
 425       continue;
 426     }
 427
 428     plugin_dispatch_values (&vl);
 429   } /* for (ptr = head; ptr != NULL; ptr = ptr->next) */
 430
 431   rrdc_stats_free (head);
 432
 433   return (0);
 434 } /* int rc_read */
 435
 436 static int rc_init (void)
 437 {
 438   if (config_collect_stats)
 439     plugin_register_read ("rrdcached", rc_read);
 440
 441   return (0);
 442 } /* int rc_init */
 443
 444 static int rc_write (const data_set_t *ds, const value_list_t *vl,
 445     user_data_t __attribute__((unused)) *user_data)
 446 {
 447   char filename[PATH_MAX];
 448   char values[512];
 449   char *values_array[2];
 450   int status;
 451   _Bool retried = 0;
 452
 453   if (daemon_address == NULL)
 454   {
 455     ERROR ("rrdcached plugin: daemon_address == NULL.");
 456     plugin_unregister_write ("rrdcached");
 457     return (-1);
 458   }
 459
 460   if (strcmp (ds->type, vl->type) != 0)
 461   {
 462     ERROR ("rrdcached plugin: DS type does not match value list type");
 463     return (-1);
 464   }
 465
 466   if (value_list_to_filename (filename, sizeof (filename), vl) != 0)
 467   {
 468     ERROR ("rrdcached plugin: value_list_to_filename failed.");
 469     return (-1);
 470   }
 471
 472   if (value_list_to_string (values, sizeof (values), ds, vl) != 0)
 473   {
 474     ERROR ("rrdcached plugin: value_list_to_string failed.");
 475     return (-1);
 476   }
 477
 478   values_array[0] = values;
 479   values_array[1] = NULL;
 480
 481   if (config_create_files)
 482   {
 483     struct stat statbuf;
 484
 485     status = stat (filename, &statbuf);
 486     if (status != 0)
 487     {
 488       if (errno != ENOENT)
 489       {
 490         char errbuf[1024];
 491         ERROR ("rrdcached plugin: stat (%s) failed: %s",
 492             filename, sstrerror (errno, errbuf, sizeof (errbuf)));
 493         return (-1);
 494       }
 495
 496       status = cu_rrd_create_file (filename, ds, vl, &rrdcreate_config);
 497       if (status != 0)
 498       {
 499         ERROR ("rrdcached plugin: cu_rrd_create_file (%s) failed.",
 500             filename);
 501         return (-1);
 502       }
 503       else if (rrdcreate_config.async)
 504         return (0);
 505     }
 506   }
 507
 508   rrd_clear_error ();
 509   status = rrdc_connect (daemon_address);
 510   if (status != 0)
 511   {
 512     ERROR ("rrdcached plugin: Failed to connect to RRDCacheD "
 513         "at %s: %s (status=%d)", daemon_address, rrd_get_error (), status);
 514     return (-1);
 515   }
 516
 517   while (42)
 518   {
 519     /* The RRD client lib does not provide any means for checking a
 520      * connection, hence we'll have to retry upon failed operations. */
 521     rrd_clear_error ();
 522     status = rrdc_update (filename, /* values_num = */ 1, (void *) values_array);
 523     if (status == 0)
 524       break;
 525
 526     if (!retried)
 527     {
 528       retried = 1;
 529       if (try_reconnect () == 0)
 530         continue;
 531       /* else: report the error and fail */
 532     }
 533
 534     ERROR ("rrdcached plugin: rrdc_update (%s, [%s], 1) failed: %s (status=%i)",
 535         filename, values_array[0], rrd_get_error (), status);
 536     return (-1);
 537   }
 538
 539   return (0);
 540 } /* int rc_write */
 541
 542 static int rc_flush (__attribute__((unused)) cdtime_t timeout, /* {{{ */
 543     const char *identifier,
 544     __attribute__((unused)) user_data_t *ud)
 545 {
 546   char filename[PATH_MAX + 1];
 547   int status;
 548   _Bool retried = 0;
 549
 550   if (identifier == NULL)
 551     return (EINVAL);
 552
 553   if (datadir != NULL)
 554     ssnprintf (filename, sizeof (filename), "%s/%s.rrd", datadir, identifier);
 555   else
 556     ssnprintf (filename, sizeof (filename), "%s.rrd", identifier);
 557
 558   rrd_clear_error ();
 559   status = rrdc_connect (daemon_address);
 560   if (status != 0)
 561   {
 562     ERROR ("rrdcached plugin: Failed to connect to RRDCacheD "
 563         "at %s: %s (status=%d)", daemon_address, rrd_get_error (), status);
 564     return (-1);
 565   }
 566
 567   while (42)
 568   {
 569     /* The RRD client lib does not provide any means for checking a
 570      * connection, hence we'll have to retry upon failed operations. */
 571     rrd_clear_error ();
 572     status = rrdc_flush (filename);
 573     if (status == 0)
 574       break;
 575
 576     if (!retried)
 577     {
 578       retried = 1;
 579       if (try_reconnect () == 0)
 580         continue;
 581       /* else: report the error and fail */
 582     }
 583
 584     ERROR ("rrdcached plugin: rrdc_flush (%s) failed: %s (status=%i).",
 585         filename, rrd_get_error (), status);
 586     return (-1);
 587   }
 588   DEBUG ("rrdcached plugin: rrdc_flush (%s): Success.", filename);
 589
 590   return (0);
 591 } /* }}} int rc_flush */
 592
 593 static int rc_shutdown (void)
 594 {
 595   rrdc_disconnect ();
 596   return (0);
 597 } /* int rc_shutdown */
 598
 599 void module_register (void)
 600 {
 601   plugin_register_complex_config ("rrdcached", rc_config);
 602   plugin_register_init ("rrdcached", rc_init);
 603   plugin_register_shutdown ("rrdcached", rc_shutdown);
 604 } /* void module_register */
 605
 606 /*
 607  * vim: set sw=2 sts=2 et :
 608  */