src/rrdcached.c

   1 /**
   2  * collectd - src/rrdcached.c
   3  * Copyright (C) 2008-2012  Florian octo Forster
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License as published by the
   7  * Free Software Foundation; only version 2 of the License is applicable.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  17  *
  18  * Authors:
  19  *   Florian octo Forster <octo at collectd.org>
  20  **/
  21
  22 #include "collectd.h"
  23 #include "plugin.h"
  24 #include "common.h"
  25 #include "utils_rrdcreate.h"
  26
  27 #undef HAVE_CONFIG_H
  28 #include <rrd.h>
  29 #include <rrd_client.h>
  30
  31 /*
  32  * Private variables
  33  */
  34 static char *datadir = NULL;
  35 static char *daemon_address = NULL;
  36 static _Bool config_create_files = 1;
  37 static _Bool config_collect_stats = 1;
  38 static rrdcreate_config_t rrdcreate_config =
  39 {
  40         /* stepsize = */ 0,
  41         /* heartbeat = */ 0,
  42         /* rrarows = */ 1200,
  43         /* xff = */ 0.1,
  44
  45         /* timespans = */ NULL,
  46         /* timespans_num = */ 0,
  47
  48         /* consolidation_functions = */ NULL,
  49         /* consolidation_functions_num = */ 0
  50 };
  51
  52 /*
  53  * Prototypes.
  54  */
  55 static int rc_write (const data_set_t *ds, const value_list_t *vl,
  56     user_data_t __attribute__((unused)) *user_data);
  57 static int rc_flush (__attribute__((unused)) cdtime_t timeout,
  58     const char *identifier, __attribute__((unused)) user_data_t *ud);
  59
  60 static int value_list_to_string (char *buffer, int buffer_len,
  61     const data_set_t *ds, const value_list_t *vl)
  62 {
  63   int offset;
  64   int status;
  65   int i;
  66   time_t t;
  67
  68   assert (0 == strcmp (ds->type, vl->type));
  69
  70   memset (buffer, '\0', buffer_len);
  71
  72   t = CDTIME_T_TO_TIME_T (vl->time);
  73   status = ssnprintf (buffer, buffer_len, "%lu", (unsigned long) t);
  74   if ((status < 1) || (status >= buffer_len))
  75     return (-1);
  76   offset = status;
  77
  78   for (i = 0; i < ds->ds_num; i++)
  79   {
  80     if ((ds->ds[i].type != DS_TYPE_COUNTER)
  81         && (ds->ds[i].type != DS_TYPE_GAUGE)
  82         && (ds->ds[i].type != DS_TYPE_DERIVE)
  83         && (ds->ds[i].type != DS_TYPE_ABSOLUTE))
  84       return (-1);
  85
  86     if (ds->ds[i].type == DS_TYPE_COUNTER)
  87     {
  88       status = ssnprintf (buffer + offset, buffer_len - offset,
  89           ":%llu", vl->values[i].counter);
  90     }
  91     else if (ds->ds[i].type == DS_TYPE_GAUGE)
  92     {
  93       status = ssnprintf (buffer + offset, buffer_len - offset,
  94           ":%f", vl->values[i].gauge);
  95     }
  96     else if (ds->ds[i].type == DS_TYPE_DERIVE) {
  97       status = ssnprintf (buffer + offset, buffer_len - offset,
  98           ":%"PRIi64, vl->values[i].derive);
  99     }
 100     else /* if (ds->ds[i].type == DS_TYPE_ABSOLUTE) */ {
 101       status = ssnprintf (buffer + offset, buffer_len - offset,
 102           ":%"PRIu64, vl->values[i].absolute);
 103
 104     }
 105
 106     if ((status < 1) || (status >= (buffer_len - offset)))
 107       return (-1);
 108
 109     offset += status;
 110   } /* for ds->ds_num */
 111
 112   return (0);
 113 } /* int value_list_to_string */
 114
 115 static int value_list_to_filename (char *buffer, int buffer_len,
 116     const data_set_t *ds, const value_list_t *vl)
 117 {
 118   int offset = 0;
 119   int status;
 120
 121   assert (0 == strcmp (ds->type, vl->type));
 122
 123   if (datadir != NULL)
 124   {
 125     status = ssnprintf (buffer + offset, buffer_len - offset,
 126         "%s/", datadir);
 127     if ((status < 1) || (status >= buffer_len - offset))
 128       return (-1);
 129     offset += status;
 130   }
 131
 132   status = ssnprintf (buffer + offset, buffer_len - offset,
 133       "%s/", vl->host);
 134   if ((status < 1) || (status >= buffer_len - offset))
 135     return (-1);
 136   offset += status;
 137
 138   if (strlen (vl->plugin_instance) > 0)
 139     status = ssnprintf (buffer + offset, buffer_len - offset,
 140         "%s-%s/", vl->plugin, vl->plugin_instance);
 141   else
 142     status = ssnprintf (buffer + offset, buffer_len - offset,
 143         "%s/", vl->plugin);
 144   if ((status < 1) || (status >= buffer_len - offset))
 145     return (-1);
 146   offset += status;
 147
 148   if (strlen (vl->type_instance) > 0)
 149     status = ssnprintf (buffer + offset, buffer_len - offset,
 150         "%s-%s", vl->type, vl->type_instance);
 151   else
 152     status = ssnprintf (buffer + offset, buffer_len - offset,
 153         "%s", vl->type);
 154   if ((status < 1) || (status >= buffer_len - offset))
 155     return (-1);
 156   offset += status;
 157
 158   strncpy (buffer + offset, ".rrd", buffer_len - offset);
 159   buffer[buffer_len - 1] = 0;
 160
 161   return (0);
 162 } /* int value_list_to_filename */
 163
 164 static int rc_config_get_int_positive (oconfig_item_t const *ci, int *ret)
 165 {
 166   int status;
 167   int tmp = 0;
 168
 169   status = cf_util_get_int (ci, &tmp);
 170   if (status != 0)
 171     return (status);
 172   if (tmp < 0)
 173     return (EINVAL);
 174
 175   *ret = tmp;
 176   return (0);
 177 } /* int rc_config_get_int_positive */
 178
 179 static int rc_config (oconfig_item_t *ci)
 180 {
 181   int i;
 182
 183   for (i = 0; i < ci->children_num; i++)
 184   {
 185     oconfig_item_t const *child = ci->children + i;
 186     const char *key = child->key;
 187     int status = 0;
 188
 189     if (strcasecmp ("DataDir", key) == 0)
 190     {
 191       status = cf_util_get_string (child, &datadir);
 192       if (status == 0)
 193       {
 194         int len = strlen (datadir);
 195
 196         while ((len > 0) && (datadir[len - 1] == '/'))
 197         {
 198           len--;
 199           datadir[len] = 0;
 200         }
 201
 202         if (len <= 0)
 203           sfree (datadir);
 204       }
 205     }
 206     else if (strcasecmp ("DaemonAddress", key) == 0)
 207       status = cf_util_get_string (child, &daemon_address);
 208     else if (strcasecmp ("CreateFiles", key) == 0)
 209       status = cf_util_get_boolean (child, &config_create_files);
 210     else if (strcasecmp ("CollectStatistics", key) == 0)
 211       status = cf_util_get_boolean (child, &config_collect_stats);
 212     else if (strcasecmp ("StepSize", key) == 0)
 213       status = rc_config_get_int_positive (child, &rrdcreate_config.stepsize);
 214     else if (strcasecmp ("HeartBeat", key) == 0)
 215       status = rc_config_get_int_positive (child, &rrdcreate_config.heartbeat);
 216     else if (strcasecmp ("RRARows", key) == 0)
 217       status = rc_config_get_int_positive (child, &rrdcreate_config.rrarows);
 218     else
 219     {
 220       WARNING ("rrdcached plugin: Ignoring invalid option %s.", key);
 221       continue;
 222     }
 223
 224     if (status != 0)
 225       WARNING ("rrdcached plugin: Handling the \"%s\" option failed.", key);
 226   }
 227
 228   if (daemon_address != NULL)
 229   {
 230     plugin_register_write ("rrdcached", rc_write, /* user_data = */ NULL);
 231     plugin_register_flush ("rrdcached", rc_flush, /* user_data = */ NULL);
 232   }
 233   return (0);
 234 } /* int rc_config */
 235
 236 static int rc_read (void)
 237 {
 238   int status;
 239   rrdc_stats_t *head;
 240   rrdc_stats_t *ptr;
 241
 242   value_t values[1];
 243   value_list_t vl = VALUE_LIST_INIT;
 244
 245   if (daemon_address == NULL)
 246     return (-1);
 247
 248   if (!config_collect_stats)
 249     return (-1);
 250
 251   vl.values = values;
 252   vl.values_len = 1;
 253
 254   if ((strncmp ("unix:", daemon_address, strlen ("unix:")) == 0)
 255       || (daemon_address[0] == '/'))
 256     sstrncpy (vl.host, hostname_g, sizeof (vl.host));
 257   else
 258     sstrncpy (vl.host, daemon_address, sizeof (vl.host));
 259   sstrncpy (vl.plugin, "rrdcached", sizeof (vl.plugin));
 260
 261   head = NULL;
 262   status = rrdc_stats_get (&head);
 263   if (status != 0)
 264   {
 265     ERROR ("rrdcached plugin: rrdc_stats_get failed with status %i.", status);
 266     return (-1);
 267   }
 268
 269   for (ptr = head; ptr != NULL; ptr = ptr->next)
 270   {
 271     if (ptr->type == RRDC_STATS_TYPE_GAUGE)
 272       values[0].gauge = (gauge_t) ptr->value.gauge;
 273     else if (ptr->type == RRDC_STATS_TYPE_COUNTER)
 274       values[0].counter = (counter_t) ptr->value.counter;
 275     else
 276       continue;
 277
 278     if (strcasecmp ("QueueLength", ptr->name) == 0)
 279     {
 280       sstrncpy (vl.type, "queue_length", sizeof (vl.type));
 281       sstrncpy (vl.type_instance, "", sizeof (vl.type_instance));
 282     }
 283     else if (strcasecmp ("UpdatesWritten", ptr->name) == 0)
 284     {
 285       sstrncpy (vl.type, "operations", sizeof (vl.type));
 286       sstrncpy (vl.type_instance, "write-updates", sizeof (vl.type_instance));
 287     }
 288     else if (strcasecmp ("DataSetsWritten", ptr->name) == 0)
 289     {
 290       sstrncpy (vl.type, "operations", sizeof (vl.type));
 291       sstrncpy (vl.type_instance, "write-data_sets",
 292           sizeof (vl.type_instance));
 293     }
 294     else if (strcasecmp ("TreeNodesNumber", ptr->name) == 0)
 295     {
 296       sstrncpy (vl.type, "gauge", sizeof (vl.type));
 297       sstrncpy (vl.type_instance, "tree_nodes", sizeof (vl.type_instance));
 298     }
 299     else if (strcasecmp ("TreeDepth", ptr->name) == 0)
 300     {
 301       sstrncpy (vl.type, "gauge", sizeof (vl.type));
 302       sstrncpy (vl.type_instance, "tree_depth", sizeof (vl.type_instance));
 303     }
 304     else if (strcasecmp ("FlushesReceived", ptr->name) == 0)
 305     {
 306       sstrncpy (vl.type, "operations", sizeof (vl.type));
 307       sstrncpy (vl.type_instance, "receive-flush", sizeof (vl.type_instance));
 308     }
 309     else if (strcasecmp ("JournalBytes", ptr->name) == 0)
 310     {
 311       sstrncpy (vl.type, "counter", sizeof (vl.type));
 312       sstrncpy (vl.type_instance, "journal-bytes", sizeof (vl.type_instance));
 313     }
 314     else if (strcasecmp ("JournalRotate", ptr->name) == 0)
 315     {
 316       sstrncpy (vl.type, "counter", sizeof (vl.type));
 317       sstrncpy (vl.type_instance, "journal-rotates", sizeof (vl.type_instance));
 318     }
 319     else if (strcasecmp ("UpdatesReceived", ptr->name) == 0)
 320     {
 321       sstrncpy (vl.type, "operations", sizeof (vl.type));
 322       sstrncpy (vl.type_instance, "receive-update", sizeof (vl.type_instance));
 323     }
 324     else
 325     {
 326       DEBUG ("rrdcached plugin: rc_read: Unknown statistic `%s'.", ptr->name);
 327       continue;
 328     }
 329
 330     plugin_dispatch_values (&vl);
 331   } /* for (ptr = head; ptr != NULL; ptr = ptr->next) */
 332
 333   rrdc_stats_free (head);
 334
 335   return (0);
 336 } /* int rc_read */
 337
 338 static int rc_init (void)
 339 {
 340   if (config_collect_stats)
 341     plugin_register_read ("rrdcached", rc_read);
 342
 343   return (0);
 344 } /* int rc_init */
 345
 346 static int rc_write (const data_set_t *ds, const value_list_t *vl,
 347     user_data_t __attribute__((unused)) *user_data)
 348 {
 349   char filename[PATH_MAX];
 350   char values[512];
 351   char *values_array[2];
 352   int status;
 353
 354   if (daemon_address == NULL)
 355   {
 356     ERROR ("rrdcached plugin: daemon_address == NULL.");
 357     plugin_unregister_write ("rrdcached");
 358     return (-1);
 359   }
 360
 361   if (strcmp (ds->type, vl->type) != 0)
 362   {
 363     ERROR ("rrdcached plugin: DS type does not match value list type");
 364     return (-1);
 365   }
 366
 367   if (value_list_to_filename (filename, sizeof (filename), ds, vl) != 0)
 368   {
 369     ERROR ("rrdcached plugin: value_list_to_filename failed.");
 370     return (-1);
 371   }
 372
 373   if (value_list_to_string (values, sizeof (values), ds, vl) != 0)
 374   {
 375     ERROR ("rrdcached plugin: value_list_to_string failed.");
 376     return (-1);
 377   }
 378
 379   values_array[0] = values;
 380   values_array[1] = NULL;
 381
 382   if (config_create_files)
 383   {
 384     struct stat statbuf;
 385
 386     status = stat (filename, &statbuf);
 387     if (status != 0)
 388     {
 389       if (errno != ENOENT)
 390       {
 391         char errbuf[1024];
 392         ERROR ("rrdcached plugin: stat (%s) failed: %s",
 393             filename, sstrerror (errno, errbuf, sizeof (errbuf)));
 394         return (-1);
 395       }
 396
 397       status = cu_rrd_create_file (filename, ds, vl, &rrdcreate_config);
 398       if (status != 0)
 399       {
 400         ERROR ("rrdcached plugin: cu_rrd_create_file (%s) failed.",
 401             filename);
 402         return (-1);
 403       }
 404     }
 405   }
 406
 407   status = rrdc_connect (daemon_address);
 408   if (status != 0)
 409   {
 410     ERROR ("rrdcached plugin: rrdc_connect (%s) failed with status %i.",
 411         daemon_address, status);
 412     return (-1);
 413   }
 414
 415   status = rrdc_update (filename, /* values_num = */ 1, (void *) values_array);
 416   if (status != 0)
 417   {
 418     ERROR ("rrdcached plugin: rrdc_update (%s, [%s], 1) failed with "
 419         "status %i.",
 420         filename, values_array[0], status);
 421     return (-1);
 422   }
 423
 424   return (0);
 425 } /* int rc_write */
 426
 427 static int rc_flush (__attribute__((unused)) cdtime_t timeout, /* {{{ */
 428     const char *identifier,
 429     __attribute__((unused)) user_data_t *ud)
 430 {
 431   char filename[PATH_MAX + 1];
 432   int status;
 433
 434   if (identifier == NULL)
 435     return (EINVAL);
 436
 437   if (datadir != NULL)
 438     ssnprintf (filename, sizeof (filename), "%s/%s.rrd", datadir, identifier);
 439   else
 440     ssnprintf (filename, sizeof (filename), "%s.rrd", identifier);
 441
 442   status = rrdc_connect (daemon_address);
 443   if (status != 0)
 444   {
 445     ERROR ("rrdcached plugin: rrdc_connect (%s) failed with status %i.",
 446         daemon_address, status);
 447     return (-1);
 448   }
 449
 450   status = rrdc_flush (filename);
 451   if (status != 0)
 452   {
 453     ERROR ("rrdcached plugin: rrdc_flush (%s) failed with status %i.",
 454         filename, status);
 455     return (-1);
 456   }
 457   DEBUG ("rrdcached plugin: rrdc_flush (%s): Success.", filename);
 458
 459   return (0);
 460 } /* }}} int rc_flush */
 461
 462 static int rc_shutdown (void)
 463 {
 464   rrdc_disconnect ();
 465   return (0);
 466 } /* int rc_shutdown */
 467
 468 void module_register (void)
 469 {
 470   plugin_register_complex_config ("rrdcached", rc_config);
 471   plugin_register_init ("rrdcached", rc_init);
 472   plugin_register_shutdown ("rrdcached", rc_shutdown);
 473 } /* void module_register */
 474
 475 /*
 476  * vim: set sw=2 sts=2 et :
 477  */