src/rrdcached.c

   1 /**
   2  * collectd - src/rrdcached.c
   3  * Copyright (C) 2008  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 verplant.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_client.h>
  29
  30 /*
  31  * Private variables
  32  */
  33 static const char *config_keys[] =
  34 {
  35   "DaemonAddress",
  36   "DataDir",
  37   "CreateFiles",
  38   "CollectStatistics"
  39 };
  40 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
  41
  42 static char *datadir = NULL;
  43 static char *daemon_address = NULL;
  44 static int config_create_files = 1;
  45 static int config_collect_stats = 1;
  46 static rrdcreate_config_t rrdcreate_config =
  47 {
  48         /* stepsize = */ 0,
  49         /* heartbeat = */ 0,
  50         /* rrarows = */ 1200,
  51         /* xff = */ 0.1,
  52
  53         /* timespans = */ NULL,
  54         /* timespans_num = */ 0,
  55
  56         /* consolidation_functions = */ NULL,
  57         /* consolidation_functions_num = */ 0
  58 };
  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
  67   assert (0 == strcmp (ds->type, vl->type));
  68
  69   memset (buffer, '\0', buffer_len);
  70
  71   status = ssnprintf (buffer, buffer_len, "%u", (unsigned int) vl->time);
  72   if ((status < 1) || (status >= buffer_len))
  73     return (-1);
  74   offset = status;
  75
  76   for (i = 0; i < ds->ds_num; i++)
  77   {
  78     if ((ds->ds[i].type != DS_TYPE_COUNTER)
  79         && (ds->ds[i].type != DS_TYPE_GAUGE)
  80         && (ds->ds[i].type != DS_TYPE_DERIVE)
  81         && (ds->ds[i].type != DS_TYPE_ABSOLUTE))
  82       return (-1);
  83
  84     if (ds->ds[i].type == DS_TYPE_COUNTER)
  85     {
  86       status = ssnprintf (buffer + offset, buffer_len - offset,
  87           ":%llu", vl->values[i].counter);
  88     }
  89     else if (ds->ds[i].type == DS_TYPE_GAUGE)
  90     {
  91       status = ssnprintf (buffer + offset, buffer_len - offset,
  92           ":%f", vl->values[i].gauge);
  93     }
  94     else if (ds->ds[i].type == DS_TYPE_DERIVE) {
  95       status = ssnprintf (buffer + offset, buffer_len - offset,
  96           ":%"PRIi64, vl->values[i].derive);
  97     }
  98     else /* if (ds->ds[i].type == DS_TYPE_ABSOLUTE) */ {
  99       status = ssnprintf (buffer + offset, buffer_len - offset,
 100           ":%"PRIu64, vl->values[i].absolute);
 101
 102     }
 103
 104     if ((status < 1) || (status >= (buffer_len - offset)))
 105       return (-1);
 106
 107     offset += status;
 108   } /* for ds->ds_num */
 109
 110   return (0);
 111 } /* int value_list_to_string */
 112
 113 static int value_list_to_filename (char *buffer, int buffer_len,
 114     const data_set_t *ds, const value_list_t *vl)
 115 {
 116   int offset = 0;
 117   int status;
 118
 119   assert (0 == strcmp (ds->type, vl->type));
 120
 121   if (datadir != NULL)
 122   {
 123     status = ssnprintf (buffer + offset, buffer_len - offset,
 124         "%s/", datadir);
 125     if ((status < 1) || (status >= buffer_len - offset))
 126       return (-1);
 127     offset += status;
 128   }
 129
 130   status = ssnprintf (buffer + offset, buffer_len - offset,
 131       "%s/", vl->host);
 132   if ((status < 1) || (status >= buffer_len - offset))
 133     return (-1);
 134   offset += status;
 135
 136   if (strlen (vl->plugin_instance) > 0)
 137     status = ssnprintf (buffer + offset, buffer_len - offset,
 138         "%s-%s/", vl->plugin, vl->plugin_instance);
 139   else
 140     status = ssnprintf (buffer + offset, buffer_len - offset,
 141         "%s/", vl->plugin);
 142   if ((status < 1) || (status >= buffer_len - offset))
 143     return (-1);
 144   offset += status;
 145
 146   if (strlen (vl->type_instance) > 0)
 147     status = ssnprintf (buffer + offset, buffer_len - offset,
 148         "%s-%s", vl->type, vl->type_instance);
 149   else
 150     status = ssnprintf (buffer + offset, buffer_len - offset,
 151         "%s", vl->type);
 152   if ((status < 1) || (status >= buffer_len - offset))
 153     return (-1);
 154   offset += status;
 155
 156   strncpy (buffer + offset, ".rrd", buffer_len - offset);
 157   buffer[buffer_len - 1] = 0;
 158
 159   return (0);
 160 } /* int value_list_to_filename */
 161
 162 static int rc_config (const char *key, const char *value)
 163 {
 164   if (strcasecmp ("DataDir", key) == 0)
 165   {
 166     if (datadir != NULL)
 167       free (datadir);
 168     datadir = strdup (value);
 169     if (datadir != NULL)
 170     {
 171       int len = strlen (datadir);
 172       while ((len > 0) && (datadir[len - 1] == '/'))
 173       {
 174         len--;
 175         datadir[len] = '\0';
 176       }
 177       if (len <= 0)
 178       {
 179         free (datadir);
 180         datadir = NULL;
 181       }
 182     }
 183   }
 184   else if (strcasecmp ("DaemonAddress", key) == 0)
 185   {
 186     sfree (daemon_address);
 187     daemon_address = strdup (value);
 188     if (daemon_address == NULL)
 189     {
 190       ERROR ("rrdcached plugin: strdup failed.");
 191       return (1);
 192     }
 193   }
 194   else if (strcasecmp ("CreateFiles", key) == 0)
 195   {
 196     if (IS_FALSE (value))
 197       config_create_files = 0;
 198     else
 199       config_create_files = 1;
 200   }
 201   else if (strcasecmp ("CollectStatistics", key) == 0)
 202   {
 203     if (IS_FALSE (value))
 204       config_collect_stats = 0;
 205     else
 206       config_collect_stats = 1;
 207   }
 208   else
 209   {
 210     return (-1);
 211   }
 212   return (0);
 213 } /* int rc_config */
 214
 215 static int rc_read (void)
 216 {
 217   int status;
 218   rrdc_stats_t *head;
 219   rrdc_stats_t *ptr;
 220
 221   value_t values[1];
 222   value_list_t vl = VALUE_LIST_INIT;
 223
 224   if (daemon_address == NULL)
 225     return (-1);
 226
 227   if (config_collect_stats == 0)
 228     return (-1);
 229
 230   vl.values = values;
 231   vl.values_len = 1;
 232
 233   if ((strncmp ("unix:", daemon_address, strlen ("unix:")) == 0)
 234       || (daemon_address[0] == '/'))
 235     sstrncpy (vl.host, hostname_g, sizeof (vl.host));
 236   else
 237     sstrncpy (vl.host, daemon_address, sizeof (vl.host));
 238   sstrncpy (vl.plugin, "rrdcached", sizeof (vl.plugin));
 239
 240   head = NULL;
 241   status = rrdc_stats_get (&head);
 242   if (status != 0)
 243   {
 244     ERROR ("rrdcached plugin: rrdc_stats_get failed with status %i.", status);
 245     return (-1);
 246   }
 247
 248   for (ptr = head; ptr != NULL; ptr = ptr->next)
 249   {
 250     if (ptr->type == RRDC_STATS_TYPE_GAUGE)
 251       values[0].gauge = (gauge_t) ptr->value.gauge;
 252     else if (ptr->type == RRDC_STATS_TYPE_COUNTER)
 253       values[0].counter = (counter_t) ptr->value.counter;
 254     else
 255       continue;
 256
 257     if (strcasecmp ("QueueLength", ptr->name) == 0)
 258     {
 259       sstrncpy (vl.type, "queue_length", sizeof (vl.type));
 260       sstrncpy (vl.type_instance, "", sizeof (vl.type_instance));
 261     }
 262     else if (strcasecmp ("UpdatesWritten", ptr->name) == 0)
 263     {
 264       sstrncpy (vl.type, "operations", sizeof (vl.type));
 265       sstrncpy (vl.type_instance, "write-updates", sizeof (vl.type_instance));
 266     }
 267     else if (strcasecmp ("DataSetsWritten", ptr->name) == 0)
 268     {
 269       sstrncpy (vl.type, "operations", sizeof (vl.type));
 270       sstrncpy (vl.type_instance, "write-data_sets",
 271           sizeof (vl.type_instance));
 272     }
 273     else if (strcasecmp ("TreeNodesNumber", ptr->name) == 0)
 274     {
 275       sstrncpy (vl.type, "gauge", sizeof (vl.type));
 276       sstrncpy (vl.type_instance, "tree_nodes", sizeof (vl.type_instance));
 277     }
 278     else if (strcasecmp ("TreeDepth", ptr->name) == 0)
 279     {
 280       sstrncpy (vl.type, "gauge", sizeof (vl.type));
 281       sstrncpy (vl.type_instance, "tree_depth", sizeof (vl.type_instance));
 282     }
 283     else if (strcasecmp ("FlushesReceived", ptr->name) == 0)
 284     {
 285       sstrncpy (vl.type, "operations", sizeof (vl.type));
 286       sstrncpy (vl.type_instance, "receive-flush", sizeof (vl.type_instance));
 287     }
 288     else if (strcasecmp ("JournalBytes", ptr->name) == 0)
 289     {
 290       sstrncpy (vl.type, "counter", sizeof (vl.type));
 291       sstrncpy (vl.type_instance, "journal-bytes", sizeof (vl.type_instance));
 292     }
 293     else if (strcasecmp ("JournalRotate", ptr->name) == 0)
 294     {
 295       sstrncpy (vl.type, "counter", sizeof (vl.type));
 296       sstrncpy (vl.type_instance, "journal-rotates", sizeof (vl.type_instance));
 297     }
 298     else if (strcasecmp ("UpdatesReceived", ptr->name) == 0)
 299     {
 300       sstrncpy (vl.type, "operations", sizeof (vl.type));
 301       sstrncpy (vl.type_instance, "receive-update", sizeof (vl.type_instance));
 302     }
 303     else
 304     {
 305       DEBUG ("rrdcached plugin: rc_read: Unknown statistic `%s'.", ptr->name);
 306       continue;
 307     }
 308
 309     plugin_dispatch_values (&vl);
 310   } /* for (ptr = head; ptr != NULL; ptr = ptr->next) */
 311
 312   rrdc_stats_free (head);
 313
 314   return (0);
 315 } /* int rc_read */
 316
 317 static int rc_init (void)
 318 {
 319   if (config_collect_stats != 0)
 320     plugin_register_read ("rrdcached", rc_read);
 321
 322   return (0);
 323 } /* int rc_init */
 324
 325 static int rc_write (const data_set_t *ds, const value_list_t *vl,
 326     user_data_t __attribute__((unused)) *user_data)
 327 {
 328   char filename[512];
 329   char values[512];
 330   char *values_array[2];
 331   int status;
 332
 333   if (daemon_address == NULL)
 334   {
 335     ERROR ("rrdcached plugin: daemon_address == NULL.");
 336     plugin_unregister_write ("rrdcached");
 337     return (-1);
 338   }
 339
 340   if (strcmp (ds->type, vl->type) != 0)
 341   {
 342     ERROR ("rrdcached plugin: DS type does not match value list type");
 343     return (-1);
 344   }
 345
 346   if (value_list_to_filename (filename, sizeof (filename), ds, vl) != 0)
 347   {
 348     ERROR ("rrdcached plugin: value_list_to_filename failed.");
 349     return (-1);
 350   }
 351
 352   if (value_list_to_string (values, sizeof (values), ds, vl) != 0)
 353   {
 354     ERROR ("rrdcached plugin: value_list_to_string failed.");
 355     return (-1);
 356   }
 357
 358   values_array[0] = values;
 359   values_array[1] = NULL;
 360
 361   if (config_create_files != 0)
 362   {
 363     struct stat statbuf;
 364
 365     status = stat (filename, &statbuf);
 366     if (status != 0)
 367     {
 368       if (errno != ENOENT)
 369       {
 370         char errbuf[1024];
 371         ERROR ("rrdcached plugin: stat (%s) failed: %s",
 372             filename, sstrerror (errno, errbuf, sizeof (errbuf)));
 373         return (-1);
 374       }
 375
 376       status = cu_rrd_create_file (filename, ds, vl, &rrdcreate_config);
 377       if (status != 0)
 378       {
 379         ERROR ("rrdcached plugin: cu_rrd_create_file (%s) failed.",
 380             filename);
 381         return (-1);
 382       }
 383     }
 384   }
 385
 386   status = rrdc_connect (daemon_address);
 387   if (status != 0)
 388   {
 389     ERROR ("rrdcached plugin: rrdc_connect (%s) failed with status %i.",
 390         daemon_address, status);
 391     return (-1);
 392   }
 393
 394   status = rrdc_update (filename, /* values_num = */ 1, (void *) values_array);
 395   if (status != 0)
 396   {
 397     ERROR ("rrdcached plugin: rrdc_update (%s, [%s], 1) failed with "
 398         "status %i.",
 399         filename, values_array[0], status);
 400     return (-1);
 401   }
 402
 403   return (0);
 404 } /* int rc_write */
 405
 406 static int rc_shutdown (void)
 407 {
 408   rrdc_disconnect ();
 409   return (0);
 410 } /* int rc_shutdown */
 411
 412 void module_register (void)
 413 {
 414   plugin_register_config ("rrdcached", rc_config,
 415       config_keys, config_keys_num);
 416   plugin_register_init ("rrdcached", rc_init);
 417   plugin_register_write ("rrdcached", rc_write, /* user_data = */ NULL);
 418   plugin_register_shutdown ("rrdcached", rc_shutdown);
 419 } /* void module_register */
 420
 421 /*
 422  * vim: set sw=2 sts=2 et :
 423  */