2 * collectd - src/rrdcached.c
3 * Copyright (C) 2008-2013 Florian octo Forster
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.
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.
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
19 * Florian octo Forster <octo at collectd.org>
25 #include "utils_rrdcreate.h"
29 #include <rrd_client.h>
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 =
45 /* timespans = */ NULL,
46 /* timespans_num = */ 0,
48 /* consolidation_functions = */ NULL,
49 /* consolidation_functions_num = */ 0
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);
60 static int value_list_to_string (char *buffer, int buffer_len,
61 const data_set_t *ds, const value_list_t *vl)
68 assert (0 == strcmp (ds->type, vl->type));
70 memset (buffer, '\0', buffer_len);
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))
78 for (i = 0; i < ds->ds_num; i++)
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))
86 if (ds->ds[i].type == DS_TYPE_COUNTER)
88 status = ssnprintf (buffer + offset, buffer_len - offset,
89 ":%llu", vl->values[i].counter);
91 else if (ds->ds[i].type == DS_TYPE_GAUGE)
93 status = ssnprintf (buffer + offset, buffer_len - offset,
94 ":%f", vl->values[i].gauge);
96 else if (ds->ds[i].type == DS_TYPE_DERIVE) {
97 status = ssnprintf (buffer + offset, buffer_len - offset,
98 ":%"PRIi64, vl->values[i].derive);
100 else /* if (ds->ds[i].type == DS_TYPE_ABSOLUTE) */ {
101 status = ssnprintf (buffer + offset, buffer_len - offset,
102 ":%"PRIu64, vl->values[i].absolute);
106 if ((status < 1) || (status >= (buffer_len - offset)))
110 } /* for ds->ds_num */
113 } /* int value_list_to_string */
115 static int value_list_to_filename (char *buffer, int buffer_len,
116 const data_set_t *ds, const value_list_t *vl)
121 assert (0 == strcmp (ds->type, vl->type));
125 status = ssnprintf (buffer + offset, buffer_len - offset,
127 if ((status < 1) || (status >= buffer_len - offset))
132 status = ssnprintf (buffer + offset, buffer_len - offset,
134 if ((status < 1) || (status >= buffer_len - offset))
138 if (strlen (vl->plugin_instance) > 0)
139 status = ssnprintf (buffer + offset, buffer_len - offset,
140 "%s-%s/", vl->plugin, vl->plugin_instance);
142 status = ssnprintf (buffer + offset, buffer_len - offset,
144 if ((status < 1) || (status >= buffer_len - offset))
148 if (strlen (vl->type_instance) > 0)
149 status = ssnprintf (buffer + offset, buffer_len - offset,
150 "%s-%s", vl->type, vl->type_instance);
152 status = ssnprintf (buffer + offset, buffer_len - offset,
154 if ((status < 1) || (status >= buffer_len - offset))
158 strncpy (buffer + offset, ".rrd", buffer_len - offset);
159 buffer[buffer_len - 1] = 0;
162 } /* int value_list_to_filename */
164 static int rc_config_get_int_positive (oconfig_item_t const *ci, int *ret)
169 status = cf_util_get_int (ci, &tmp);
177 } /* int rc_config_get_int_positive */
179 static int rc_config_get_xff (oconfig_item_t const *ci, double *ret)
183 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
185 ERROR ("rrdcached plugin: The \"%s\" needs exactly one numeric argument "
186 "in the range [0.0, 1.0)", ci->key);
190 value = ci->values[0].value.number;
191 if ((value >= 0.0) && (value < 1.0))
197 ERROR ("rrdcached plugin: The \"%s\" needs exactly one numeric argument "
198 "in the range [0.0, 1.0)", ci->key);
200 } /* int rc_config_get_xff */
202 static int rc_config_add_timespan (int timespan)
209 tmp = realloc (rrdcreate_config.timespans,
210 sizeof (*rrdcreate_config.timespans)
211 * (rrdcreate_config.timespans_num + 1));
214 rrdcreate_config.timespans = tmp;
216 rrdcreate_config.timespans[rrdcreate_config.timespans_num] = timespan;
217 rrdcreate_config.timespans_num++;
220 } /* int rc_config_add_timespan */
222 static int rc_config (oconfig_item_t *ci)
226 for (i = 0; i < ci->children_num; i++)
228 oconfig_item_t const *child = ci->children + i;
229 const char *key = child->key;
232 if (strcasecmp ("DataDir", key) == 0)
234 status = cf_util_get_string (child, &datadir);
237 int len = strlen (datadir);
239 while ((len > 0) && (datadir[len - 1] == '/'))
249 else if (strcasecmp ("DaemonAddress", key) == 0)
250 status = cf_util_get_string (child, &daemon_address);
251 else if (strcasecmp ("CreateFiles", key) == 0)
252 status = cf_util_get_boolean (child, &config_create_files);
253 else if (strcasecmp ("CollectStatistics", key) == 0)
254 status = cf_util_get_boolean (child, &config_collect_stats);
255 else if (strcasecmp ("StepSize", key) == 0)
259 status = rc_config_get_int_positive (child, &tmp);
261 rrdcreate_config.stepsize = (unsigned long) tmp;
263 else if (strcasecmp ("HeartBeat", key) == 0)
264 status = rc_config_get_int_positive (child, &rrdcreate_config.heartbeat);
265 else if (strcasecmp ("RRARows", key) == 0)
266 status = rc_config_get_int_positive (child, &rrdcreate_config.rrarows);
267 else if (strcasecmp ("RRATimespan", key) == 0)
270 status = rc_config_get_int_positive (child, &tmp);
272 status = rc_config_add_timespan (tmp);
274 else if (strcasecmp ("XFF", key) == 0)
275 status = rc_config_get_xff (child, &rrdcreate_config.xff);
278 WARNING ("rrdcached plugin: Ignoring invalid option %s.", key);
283 WARNING ("rrdcached plugin: Handling the \"%s\" option failed.", key);
286 if (daemon_address != NULL)
288 plugin_register_write ("rrdcached", rc_write, /* user_data = */ NULL);
289 plugin_register_flush ("rrdcached", rc_flush, /* user_data = */ NULL);
292 } /* int rc_config */
294 static int rc_read (void)
301 value_list_t vl = VALUE_LIST_INIT;
303 if (daemon_address == NULL)
306 if (!config_collect_stats)
312 if ((strncmp ("unix:", daemon_address, strlen ("unix:")) == 0)
313 || (daemon_address[0] == '/'))
314 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
316 sstrncpy (vl.host, daemon_address, sizeof (vl.host));
317 sstrncpy (vl.plugin, "rrdcached", sizeof (vl.plugin));
319 status = rrdc_connect (daemon_address);
322 ERROR ("rrdcached plugin: rrdc_connect (%s) failed with status %i.",
323 daemon_address, status);
328 status = rrdc_stats_get (&head);
331 ERROR ("rrdcached plugin: rrdc_stats_get failed with status %i.", status);
335 for (ptr = head; ptr != NULL; ptr = ptr->next)
337 if (ptr->type == RRDC_STATS_TYPE_GAUGE)
338 values[0].gauge = (gauge_t) ptr->value.gauge;
339 else if (ptr->type == RRDC_STATS_TYPE_COUNTER)
340 values[0].counter = (counter_t) ptr->value.counter;
344 if (strcasecmp ("QueueLength", ptr->name) == 0)
346 sstrncpy (vl.type, "queue_length", sizeof (vl.type));
347 sstrncpy (vl.type_instance, "", sizeof (vl.type_instance));
349 else if (strcasecmp ("UpdatesWritten", ptr->name) == 0)
351 sstrncpy (vl.type, "operations", sizeof (vl.type));
352 sstrncpy (vl.type_instance, "write-updates", sizeof (vl.type_instance));
354 else if (strcasecmp ("DataSetsWritten", ptr->name) == 0)
356 sstrncpy (vl.type, "operations", sizeof (vl.type));
357 sstrncpy (vl.type_instance, "write-data_sets",
358 sizeof (vl.type_instance));
360 else if (strcasecmp ("TreeNodesNumber", ptr->name) == 0)
362 sstrncpy (vl.type, "gauge", sizeof (vl.type));
363 sstrncpy (vl.type_instance, "tree_nodes", sizeof (vl.type_instance));
365 else if (strcasecmp ("TreeDepth", ptr->name) == 0)
367 sstrncpy (vl.type, "gauge", sizeof (vl.type));
368 sstrncpy (vl.type_instance, "tree_depth", sizeof (vl.type_instance));
370 else if (strcasecmp ("FlushesReceived", ptr->name) == 0)
372 sstrncpy (vl.type, "operations", sizeof (vl.type));
373 sstrncpy (vl.type_instance, "receive-flush", sizeof (vl.type_instance));
375 else if (strcasecmp ("JournalBytes", ptr->name) == 0)
377 sstrncpy (vl.type, "counter", sizeof (vl.type));
378 sstrncpy (vl.type_instance, "journal-bytes", sizeof (vl.type_instance));
380 else if (strcasecmp ("JournalRotate", ptr->name) == 0)
382 sstrncpy (vl.type, "counter", sizeof (vl.type));
383 sstrncpy (vl.type_instance, "journal-rotates", sizeof (vl.type_instance));
385 else if (strcasecmp ("UpdatesReceived", ptr->name) == 0)
387 sstrncpy (vl.type, "operations", sizeof (vl.type));
388 sstrncpy (vl.type_instance, "receive-update", sizeof (vl.type_instance));
392 DEBUG ("rrdcached plugin: rc_read: Unknown statistic `%s'.", ptr->name);
396 plugin_dispatch_values (&vl);
397 } /* for (ptr = head; ptr != NULL; ptr = ptr->next) */
399 rrdc_stats_free (head);
404 static int rc_init (void)
406 if (config_collect_stats)
407 plugin_register_read ("rrdcached", rc_read);
412 static int rc_write (const data_set_t *ds, const value_list_t *vl,
413 user_data_t __attribute__((unused)) *user_data)
415 char filename[PATH_MAX];
417 char *values_array[2];
420 if (daemon_address == NULL)
422 ERROR ("rrdcached plugin: daemon_address == NULL.");
423 plugin_unregister_write ("rrdcached");
427 if (strcmp (ds->type, vl->type) != 0)
429 ERROR ("rrdcached plugin: DS type does not match value list type");
433 if (value_list_to_filename (filename, sizeof (filename), ds, vl) != 0)
435 ERROR ("rrdcached plugin: value_list_to_filename failed.");
439 if (value_list_to_string (values, sizeof (values), ds, vl) != 0)
441 ERROR ("rrdcached plugin: value_list_to_string failed.");
445 values_array[0] = values;
446 values_array[1] = NULL;
448 if (config_create_files)
452 status = stat (filename, &statbuf);
458 ERROR ("rrdcached plugin: stat (%s) failed: %s",
459 filename, sstrerror (errno, errbuf, sizeof (errbuf)));
463 status = cu_rrd_create_file (filename, ds, vl, &rrdcreate_config);
466 ERROR ("rrdcached plugin: cu_rrd_create_file (%s) failed.",
473 status = rrdc_connect (daemon_address);
476 ERROR ("rrdcached plugin: rrdc_connect (%s) failed with status %i.",
477 daemon_address, status);
481 status = rrdc_update (filename, /* values_num = */ 1, (void *) values_array);
484 ERROR ("rrdcached plugin: rrdc_update (%s, [%s], 1) failed with "
486 filename, values_array[0], status);
493 static int rc_flush (__attribute__((unused)) cdtime_t timeout, /* {{{ */
494 const char *identifier,
495 __attribute__((unused)) user_data_t *ud)
497 char filename[PATH_MAX + 1];
500 if (identifier == NULL)
504 ssnprintf (filename, sizeof (filename), "%s/%s.rrd", datadir, identifier);
506 ssnprintf (filename, sizeof (filename), "%s.rrd", identifier);
508 status = rrdc_connect (daemon_address);
511 ERROR ("rrdcached plugin: rrdc_connect (%s) failed with status %i.",
512 daemon_address, status);
516 status = rrdc_flush (filename);
519 ERROR ("rrdcached plugin: rrdc_flush (%s) failed with status %i.",
523 DEBUG ("rrdcached plugin: rrdc_flush (%s): Success.", filename);
526 } /* }}} int rc_flush */
528 static int rc_shutdown (void)
532 } /* int rc_shutdown */
534 void module_register (void)
536 plugin_register_complex_config ("rrdcached", rc_config);
537 plugin_register_init ("rrdcached", rc_init);
538 plugin_register_shutdown ("rrdcached", rc_shutdown);
539 } /* void module_register */
542 * vim: set sw=2 sts=2 et :