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, size_t buffer_size,
116 value_list_t const *vl)
118 char const suffix[] = ".rrd";
124 size_t datadir_len = strlen (datadir);
126 if (datadir_len >= buffer_size)
129 sstrncpy (buffer, datadir, buffer_size);
130 buffer += datadir_len;
131 buffer_size -= datadir_len;
134 status = FORMAT_VL (buffer, buffer_size, vl);
138 len = strlen (buffer);
139 assert (len < buffer_size);
143 if (buffer_size <= sizeof (suffix))
146 memcpy (buffer, suffix, sizeof (suffix));
148 } /* int value_list_to_filename */
150 static int rc_config_get_int_positive (oconfig_item_t const *ci, int *ret)
155 status = cf_util_get_int (ci, &tmp);
163 } /* int rc_config_get_int_positive */
165 static int rc_config_get_xff (oconfig_item_t const *ci, double *ret)
169 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
171 ERROR ("rrdcached plugin: The \"%s\" needs exactly one numeric argument "
172 "in the range [0.0, 1.0)", ci->key);
176 value = ci->values[0].value.number;
177 if ((value >= 0.0) && (value < 1.0))
183 ERROR ("rrdcached plugin: The \"%s\" needs exactly one numeric argument "
184 "in the range [0.0, 1.0)", ci->key);
186 } /* int rc_config_get_xff */
188 static int rc_config_add_timespan (int timespan)
195 tmp = realloc (rrdcreate_config.timespans,
196 sizeof (*rrdcreate_config.timespans)
197 * (rrdcreate_config.timespans_num + 1));
200 rrdcreate_config.timespans = tmp;
202 rrdcreate_config.timespans[rrdcreate_config.timespans_num] = timespan;
203 rrdcreate_config.timespans_num++;
206 } /* int rc_config_add_timespan */
208 static int rc_config (oconfig_item_t *ci)
212 for (i = 0; i < ci->children_num; i++)
214 oconfig_item_t const *child = ci->children + i;
215 const char *key = child->key;
218 if (strcasecmp ("DataDir", key) == 0)
220 status = cf_util_get_string (child, &datadir);
223 int len = strlen (datadir);
225 while ((len > 0) && (datadir[len - 1] == '/'))
235 else if (strcasecmp ("DaemonAddress", key) == 0)
236 status = cf_util_get_string (child, &daemon_address);
237 else if (strcasecmp ("CreateFiles", key) == 0)
238 status = cf_util_get_boolean (child, &config_create_files);
239 else if (strcasecmp ("CollectStatistics", key) == 0)
240 status = cf_util_get_boolean (child, &config_collect_stats);
241 else if (strcasecmp ("StepSize", key) == 0)
245 status = rc_config_get_int_positive (child, &tmp);
247 rrdcreate_config.stepsize = (unsigned long) tmp;
249 else if (strcasecmp ("HeartBeat", key) == 0)
250 status = rc_config_get_int_positive (child, &rrdcreate_config.heartbeat);
251 else if (strcasecmp ("RRARows", key) == 0)
252 status = rc_config_get_int_positive (child, &rrdcreate_config.rrarows);
253 else if (strcasecmp ("RRATimespan", key) == 0)
256 status = rc_config_get_int_positive (child, &tmp);
258 status = rc_config_add_timespan (tmp);
260 else if (strcasecmp ("XFF", key) == 0)
261 status = rc_config_get_xff (child, &rrdcreate_config.xff);
264 WARNING ("rrdcached plugin: Ignoring invalid option %s.", key);
269 WARNING ("rrdcached plugin: Handling the \"%s\" option failed.", key);
272 if (daemon_address != NULL)
274 plugin_register_write ("rrdcached", rc_write, /* user_data = */ NULL);
275 plugin_register_flush ("rrdcached", rc_flush, /* user_data = */ NULL);
278 } /* int rc_config */
280 static int rc_read (void)
287 value_list_t vl = VALUE_LIST_INIT;
289 if (daemon_address == NULL)
292 if (!config_collect_stats)
298 if ((strncmp ("unix:", daemon_address, strlen ("unix:")) == 0)
299 || (daemon_address[0] == '/'))
300 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
302 sstrncpy (vl.host, daemon_address, sizeof (vl.host));
303 sstrncpy (vl.plugin, "rrdcached", sizeof (vl.plugin));
305 status = rrdc_connect (daemon_address);
308 ERROR ("rrdcached plugin: rrdc_connect (%s) failed with status %i.",
309 daemon_address, status);
314 status = rrdc_stats_get (&head);
317 ERROR ("rrdcached plugin: rrdc_stats_get failed with status %i.", status);
321 for (ptr = head; ptr != NULL; ptr = ptr->next)
323 if (ptr->type == RRDC_STATS_TYPE_GAUGE)
324 values[0].gauge = (gauge_t) ptr->value.gauge;
325 else if (ptr->type == RRDC_STATS_TYPE_COUNTER)
326 values[0].counter = (counter_t) ptr->value.counter;
330 if (strcasecmp ("QueueLength", ptr->name) == 0)
332 sstrncpy (vl.type, "queue_length", sizeof (vl.type));
333 sstrncpy (vl.type_instance, "", sizeof (vl.type_instance));
335 else if (strcasecmp ("UpdatesWritten", ptr->name) == 0)
337 sstrncpy (vl.type, "operations", sizeof (vl.type));
338 sstrncpy (vl.type_instance, "write-updates", sizeof (vl.type_instance));
340 else if (strcasecmp ("DataSetsWritten", ptr->name) == 0)
342 sstrncpy (vl.type, "operations", sizeof (vl.type));
343 sstrncpy (vl.type_instance, "write-data_sets",
344 sizeof (vl.type_instance));
346 else if (strcasecmp ("TreeNodesNumber", ptr->name) == 0)
348 sstrncpy (vl.type, "gauge", sizeof (vl.type));
349 sstrncpy (vl.type_instance, "tree_nodes", sizeof (vl.type_instance));
351 else if (strcasecmp ("TreeDepth", ptr->name) == 0)
353 sstrncpy (vl.type, "gauge", sizeof (vl.type));
354 sstrncpy (vl.type_instance, "tree_depth", sizeof (vl.type_instance));
356 else if (strcasecmp ("FlushesReceived", ptr->name) == 0)
358 sstrncpy (vl.type, "operations", sizeof (vl.type));
359 sstrncpy (vl.type_instance, "receive-flush", sizeof (vl.type_instance));
361 else if (strcasecmp ("JournalBytes", ptr->name) == 0)
363 sstrncpy (vl.type, "counter", sizeof (vl.type));
364 sstrncpy (vl.type_instance, "journal-bytes", sizeof (vl.type_instance));
366 else if (strcasecmp ("JournalRotate", ptr->name) == 0)
368 sstrncpy (vl.type, "counter", sizeof (vl.type));
369 sstrncpy (vl.type_instance, "journal-rotates", sizeof (vl.type_instance));
371 else if (strcasecmp ("UpdatesReceived", ptr->name) == 0)
373 sstrncpy (vl.type, "operations", sizeof (vl.type));
374 sstrncpy (vl.type_instance, "receive-update", sizeof (vl.type_instance));
378 DEBUG ("rrdcached plugin: rc_read: Unknown statistic `%s'.", ptr->name);
382 plugin_dispatch_values (&vl);
383 } /* for (ptr = head; ptr != NULL; ptr = ptr->next) */
385 rrdc_stats_free (head);
390 static int rc_init (void)
392 if (config_collect_stats)
393 plugin_register_read ("rrdcached", rc_read);
398 static int rc_write (const data_set_t *ds, const value_list_t *vl,
399 user_data_t __attribute__((unused)) *user_data)
401 char filename[PATH_MAX];
403 char *values_array[2];
406 if (daemon_address == NULL)
408 ERROR ("rrdcached plugin: daemon_address == NULL.");
409 plugin_unregister_write ("rrdcached");
413 if (strcmp (ds->type, vl->type) != 0)
415 ERROR ("rrdcached plugin: DS type does not match value list type");
419 if (value_list_to_filename (filename, sizeof (filename), vl) != 0)
421 ERROR ("rrdcached plugin: value_list_to_filename failed.");
425 if (value_list_to_string (values, sizeof (values), ds, vl) != 0)
427 ERROR ("rrdcached plugin: value_list_to_string failed.");
431 values_array[0] = values;
432 values_array[1] = NULL;
434 if (config_create_files)
438 status = stat (filename, &statbuf);
444 ERROR ("rrdcached plugin: stat (%s) failed: %s",
445 filename, sstrerror (errno, errbuf, sizeof (errbuf)));
449 status = cu_rrd_create_file (filename, ds, vl, &rrdcreate_config);
452 ERROR ("rrdcached plugin: cu_rrd_create_file (%s) failed.",
459 status = rrdc_connect (daemon_address);
462 ERROR ("rrdcached plugin: rrdc_connect (%s) failed with status %i.",
463 daemon_address, status);
467 status = rrdc_update (filename, /* values_num = */ 1, (void *) values_array);
470 ERROR ("rrdcached plugin: rrdc_update (%s, [%s], 1) failed with "
472 filename, values_array[0], status);
479 static int rc_flush (__attribute__((unused)) cdtime_t timeout, /* {{{ */
480 const char *identifier,
481 __attribute__((unused)) user_data_t *ud)
483 char filename[PATH_MAX + 1];
486 if (identifier == NULL)
490 ssnprintf (filename, sizeof (filename), "%s/%s.rrd", datadir, identifier);
492 ssnprintf (filename, sizeof (filename), "%s.rrd", identifier);
494 status = rrdc_connect (daemon_address);
497 ERROR ("rrdcached plugin: rrdc_connect (%s) failed with status %i.",
498 daemon_address, status);
502 status = rrdc_flush (filename);
505 ERROR ("rrdcached plugin: rrdc_flush (%s) failed with status %i.",
509 DEBUG ("rrdcached plugin: rrdc_flush (%s): Success.", filename);
512 } /* }}} int rc_flush */
514 static int rc_shutdown (void)
518 } /* int rc_shutdown */
520 void module_register (void)
522 plugin_register_complex_config ("rrdcached", rc_config);
523 plugin_register_init ("rrdcached", rc_init);
524 plugin_register_shutdown ("rrdcached", rc_shutdown);
525 } /* void module_register */
528 * vim: set sw=2 sts=2 et :