2 * collectd - src/rrdcached.c
3 * Copyright (C) 2008-2013 Florian octo Forster
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:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
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.
24 * Florian octo Forster <octo at collectd.org>
30 #include "utils_rrdcreate.h"
34 #include <rrd_client.h>
39 static char *datadir = NULL;
40 static char *daemon_address = NULL;
41 static _Bool config_create_files = 1;
42 static _Bool config_collect_stats = 1;
43 static rrdcreate_config_t rrdcreate_config =
50 /* timespans = */ NULL,
51 /* timespans_num = */ 0,
53 /* consolidation_functions = */ NULL,
54 /* consolidation_functions_num = */ 0,
62 static int rc_write (const data_set_t *ds, const value_list_t *vl,
63 user_data_t __attribute__((unused)) *user_data);
64 static int rc_flush (__attribute__((unused)) cdtime_t timeout,
65 const char *identifier, __attribute__((unused)) user_data_t *ud);
67 static int value_list_to_string (char *buffer, int buffer_len,
68 const data_set_t *ds, const value_list_t *vl)
75 assert (0 == strcmp (ds->type, vl->type));
77 memset (buffer, '\0', buffer_len);
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))
85 for (i = 0; i < ds->ds_num; i++)
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))
93 if (ds->ds[i].type == DS_TYPE_COUNTER)
95 status = ssnprintf (buffer + offset, buffer_len - offset,
96 ":%llu", vl->values[i].counter);
98 else if (ds->ds[i].type == DS_TYPE_GAUGE)
100 status = ssnprintf (buffer + offset, buffer_len - offset,
101 ":%f", vl->values[i].gauge);
103 else if (ds->ds[i].type == DS_TYPE_DERIVE) {
104 status = ssnprintf (buffer + offset, buffer_len - offset,
105 ":%"PRIi64, vl->values[i].derive);
107 else /* if (ds->ds[i].type == DS_TYPE_ABSOLUTE) */ {
108 status = ssnprintf (buffer + offset, buffer_len - offset,
109 ":%"PRIu64, vl->values[i].absolute);
113 if ((status < 1) || (status >= (buffer_len - offset)))
117 } /* for ds->ds_num */
120 } /* int value_list_to_string */
122 static int value_list_to_filename (char *buffer, size_t buffer_size,
123 value_list_t const *vl)
125 char const suffix[] = ".rrd";
131 size_t datadir_len = strlen (datadir) + 1;
133 if (datadir_len >= buffer_size)
136 sstrncpy (buffer, datadir, buffer_size);
137 buffer[datadir_len - 1] = '/';
138 buffer[datadir_len] = 0;
140 buffer += datadir_len;
141 buffer_size -= datadir_len;
144 status = FORMAT_VL (buffer, buffer_size, vl);
148 len = strlen (buffer);
149 assert (len < buffer_size);
153 if (buffer_size <= sizeof (suffix))
156 memcpy (buffer, suffix, sizeof (suffix));
158 } /* int value_list_to_filename */
160 static int rc_config_get_int_positive (oconfig_item_t const *ci, int *ret)
165 status = cf_util_get_int (ci, &tmp);
173 } /* int rc_config_get_int_positive */
175 static int rc_config_get_xff (oconfig_item_t const *ci, double *ret)
179 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
181 ERROR ("rrdcached plugin: The \"%s\" needs exactly one numeric argument "
182 "in the range [0.0, 1.0)", ci->key);
186 value = ci->values[0].value.number;
187 if ((value >= 0.0) && (value < 1.0))
193 ERROR ("rrdcached plugin: The \"%s\" needs exactly one numeric argument "
194 "in the range [0.0, 1.0)", ci->key);
196 } /* int rc_config_get_xff */
198 static int rc_config_add_timespan (int timespan)
205 tmp = realloc (rrdcreate_config.timespans,
206 sizeof (*rrdcreate_config.timespans)
207 * (rrdcreate_config.timespans_num + 1));
210 rrdcreate_config.timespans = tmp;
212 rrdcreate_config.timespans[rrdcreate_config.timespans_num] = timespan;
213 rrdcreate_config.timespans_num++;
216 } /* int rc_config_add_timespan */
218 static int rc_config (oconfig_item_t *ci)
222 for (i = 0; i < ci->children_num; i++)
224 oconfig_item_t const *child = ci->children + i;
225 const char *key = child->key;
228 if (strcasecmp ("DataDir", key) == 0)
230 status = cf_util_get_string (child, &datadir);
233 int len = strlen (datadir);
235 while ((len > 0) && (datadir[len - 1] == '/'))
245 else if (strcasecmp ("DaemonAddress", key) == 0)
246 status = cf_util_get_string (child, &daemon_address);
247 else if (strcasecmp ("CreateFiles", key) == 0)
248 status = cf_util_get_boolean (child, &config_create_files);
249 else if (strcasecmp ("CreateFilesAsync", key) == 0)
250 status = cf_util_get_boolean (child, &rrdcreate_config.async);
251 else if (strcasecmp ("CollectStatistics", key) == 0)
252 status = cf_util_get_boolean (child, &config_collect_stats);
253 else if (strcasecmp ("StepSize", key) == 0)
257 status = rc_config_get_int_positive (child, &tmp);
259 rrdcreate_config.stepsize = (unsigned long) tmp;
261 else if (strcasecmp ("HeartBeat", key) == 0)
262 status = rc_config_get_int_positive (child, &rrdcreate_config.heartbeat);
263 else if (strcasecmp ("RRARows", key) == 0)
264 status = rc_config_get_int_positive (child, &rrdcreate_config.rrarows);
265 else if (strcasecmp ("RRATimespan", key) == 0)
268 status = rc_config_get_int_positive (child, &tmp);
270 status = rc_config_add_timespan (tmp);
272 else if (strcasecmp ("XFF", key) == 0)
273 status = rc_config_get_xff (child, &rrdcreate_config.xff);
276 WARNING ("rrdcached plugin: Ignoring invalid option %s.", key);
281 WARNING ("rrdcached plugin: Handling the \"%s\" option failed.", key);
284 if (daemon_address != NULL)
286 plugin_register_write ("rrdcached", rc_write, /* user_data = */ NULL);
287 plugin_register_flush ("rrdcached", rc_flush, /* user_data = */ NULL);
290 } /* int rc_config */
292 static int try_reconnect (void)
299 status = rrdc_connect (daemon_address);
302 char *err = rrd_get_error ();
303 ERROR ("rrdcached plugin: Failed to reconnect to RRDCacheD "
304 "at %s: %s (status=%d)", daemon_address, err, status);
308 INFO ("rrdcached plugin: Successfully reconnected to RRDCacheD "
309 "at %s", daemon_address);
311 } /* int try_reconnect */
313 static int rc_read (void)
321 value_list_t vl = VALUE_LIST_INIT;
323 if (daemon_address == NULL)
326 if (!config_collect_stats)
332 if ((strncmp ("unix:", daemon_address, strlen ("unix:")) == 0)
333 || (daemon_address[0] == '/'))
334 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
336 sstrncpy (vl.host, daemon_address, sizeof (vl.host));
337 sstrncpy (vl.plugin, "rrdcached", sizeof (vl.plugin));
339 status = rrdc_connect (daemon_address);
342 char *err = rrd_get_error ();
343 ERROR ("rrdcached plugin: Failed to connect to RRDCacheD "
344 "at %s: %s (status=%d)", daemon_address, err, status);
350 /* The RRD client lib does not provide any means for checking a
351 * connection, hence we'll have to retry upon failed operations. */
353 status = rrdc_stats_get (&head);
360 if (try_reconnect () == 0)
362 /* else: report the error and fail */
365 ERROR ("rrdcached plugin: rrdc_stats_get failed with status %i.", status);
369 for (ptr = head; ptr != NULL; ptr = ptr->next)
371 if (ptr->type == RRDC_STATS_TYPE_GAUGE)
372 values[0].gauge = (gauge_t) ptr->value.gauge;
373 else if (ptr->type == RRDC_STATS_TYPE_COUNTER)
374 values[0].counter = (counter_t) ptr->value.counter;
378 if (strcasecmp ("QueueLength", ptr->name) == 0)
380 sstrncpy (vl.type, "queue_length", sizeof (vl.type));
381 sstrncpy (vl.type_instance, "", sizeof (vl.type_instance));
383 else if (strcasecmp ("UpdatesWritten", ptr->name) == 0)
385 sstrncpy (vl.type, "operations", sizeof (vl.type));
386 sstrncpy (vl.type_instance, "write-updates", sizeof (vl.type_instance));
388 else if (strcasecmp ("DataSetsWritten", ptr->name) == 0)
390 sstrncpy (vl.type, "operations", sizeof (vl.type));
391 sstrncpy (vl.type_instance, "write-data_sets",
392 sizeof (vl.type_instance));
394 else if (strcasecmp ("TreeNodesNumber", ptr->name) == 0)
396 sstrncpy (vl.type, "gauge", sizeof (vl.type));
397 sstrncpy (vl.type_instance, "tree_nodes", sizeof (vl.type_instance));
399 else if (strcasecmp ("TreeDepth", ptr->name) == 0)
401 sstrncpy (vl.type, "gauge", sizeof (vl.type));
402 sstrncpy (vl.type_instance, "tree_depth", sizeof (vl.type_instance));
404 else if (strcasecmp ("FlushesReceived", ptr->name) == 0)
406 sstrncpy (vl.type, "operations", sizeof (vl.type));
407 sstrncpy (vl.type_instance, "receive-flush", sizeof (vl.type_instance));
409 else if (strcasecmp ("JournalBytes", ptr->name) == 0)
411 sstrncpy (vl.type, "counter", sizeof (vl.type));
412 sstrncpy (vl.type_instance, "journal-bytes", sizeof (vl.type_instance));
414 else if (strcasecmp ("JournalRotate", ptr->name) == 0)
416 sstrncpy (vl.type, "counter", sizeof (vl.type));
417 sstrncpy (vl.type_instance, "journal-rotates", sizeof (vl.type_instance));
419 else if (strcasecmp ("UpdatesReceived", ptr->name) == 0)
421 sstrncpy (vl.type, "operations", sizeof (vl.type));
422 sstrncpy (vl.type_instance, "receive-update", sizeof (vl.type_instance));
426 DEBUG ("rrdcached plugin: rc_read: Unknown statistic `%s'.", ptr->name);
430 plugin_dispatch_values (&vl);
431 } /* for (ptr = head; ptr != NULL; ptr = ptr->next) */
433 rrdc_stats_free (head);
438 static int rc_init (void)
440 if (config_collect_stats)
441 plugin_register_read ("rrdcached", rc_read);
446 static int rc_write (const data_set_t *ds, const value_list_t *vl,
447 user_data_t __attribute__((unused)) *user_data)
449 char filename[PATH_MAX];
451 char *values_array[2];
455 if (daemon_address == NULL)
457 ERROR ("rrdcached plugin: daemon_address == NULL.");
458 plugin_unregister_write ("rrdcached");
462 if (strcmp (ds->type, vl->type) != 0)
464 ERROR ("rrdcached plugin: DS type does not match value list type");
468 if (value_list_to_filename (filename, sizeof (filename), vl) != 0)
470 ERROR ("rrdcached plugin: value_list_to_filename failed.");
474 if (value_list_to_string (values, sizeof (values), ds, vl) != 0)
476 ERROR ("rrdcached plugin: value_list_to_string failed.");
480 values_array[0] = values;
481 values_array[1] = NULL;
483 if (config_create_files)
487 status = stat (filename, &statbuf);
493 ERROR ("rrdcached plugin: stat (%s) failed: %s",
494 filename, sstrerror (errno, errbuf, sizeof (errbuf)));
498 status = cu_rrd_create_file (filename, ds, vl, &rrdcreate_config);
501 ERROR ("rrdcached plugin: cu_rrd_create_file (%s) failed.",
505 else if (rrdcreate_config.async)
510 status = rrdc_connect (daemon_address);
513 char *err = rrd_get_error ();
514 ERROR ("rrdcached plugin: Failed to connect to RRDCacheD "
515 "at %s: %s (status=%d)", daemon_address, err, status);
521 /* The RRD client lib does not provide any means for checking a
522 * connection, hence we'll have to retry upon failed operations. */
523 status = rrdc_update (filename, /* values_num = */ 1, (void *) values_array);
530 if (try_reconnect () == 0)
532 /* else: report the error and fail */
535 ERROR ("rrdcached plugin: rrdc_update (%s, [%s], 1) failed with "
537 filename, values_array[0], status);
544 static int rc_flush (__attribute__((unused)) cdtime_t timeout, /* {{{ */
545 const char *identifier,
546 __attribute__((unused)) user_data_t *ud)
548 char filename[PATH_MAX + 1];
552 if (identifier == NULL)
556 ssnprintf (filename, sizeof (filename), "%s/%s.rrd", datadir, identifier);
558 ssnprintf (filename, sizeof (filename), "%s.rrd", identifier);
560 status = rrdc_connect (daemon_address);
563 char *err = rrd_get_error ();
564 ERROR ("rrdcached plugin: Failed to connect to RRDCacheD "
565 "at %s: %s (status=%d)", daemon_address, err, status);
571 /* The RRD client lib does not provide any means for checking a
572 * connection, hence we'll have to retry upon failed operations. */
573 status = rrdc_flush (filename);
580 if (try_reconnect () == 0)
582 /* else: report the error and fail */
585 ERROR ("rrdcached plugin: rrdc_flush (%s) failed with status %i.",
589 DEBUG ("rrdcached plugin: rrdc_flush (%s): Success.", filename);
592 } /* }}} int rc_flush */
594 static int rc_shutdown (void)
598 } /* int rc_shutdown */
600 void module_register (void)
602 plugin_register_complex_config ("rrdcached", rc_config);
603 plugin_register_init ("rrdcached", rc_init);
604 plugin_register_shutdown ("rrdcached", rc_shutdown);
605 } /* void module_register */
608 * vim: set sw=2 sts=2 et :