2 * collectd - src/rrdtool.c
3 * Copyright (C) 2006 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 verplant.org>
25 #include "utils_avltree.h"
26 #include "utils_debug.h"
37 typedef struct rrd_cache_s rrd_cache_t;
42 static int rra_timespans[] =
50 static int rra_timespans_num = STATIC_ARRAY_SIZE (rra_timespans);
52 static char *rra_types[] =
58 static int rra_types_num = STATIC_ARRAY_SIZE (rra_types);
60 static const char *config_keys[] =
70 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
72 static char *datadir = NULL;
73 static int stepsize = 0;
74 static int heartbeat = 0;
75 static int rrarows = 1200;
76 static double xff = 0.1;
78 static int cache_timeout = 0;
79 static int cache_flush_timeout = 0;
80 static time_t cache_flush_last;
81 static avl_tree_t *cache = NULL;
86 static int rra_get (char ***ret)
88 static char **rra_def = NULL;
89 static int rra_num = 0;
91 int rra_max = rra_timespans_num * rra_types_num;
101 if ((rra_num != 0) && (rra_def != NULL))
107 if ((rra_def = (char **) malloc ((rra_max + 1) * sizeof (char *))) == NULL)
109 memset (rra_def, '\0', (rra_max + 1) * sizeof (char *));
111 if ((stepsize <= 0) || (rrarows <= 0))
118 for (i = 0; i < rra_timespans_num; i++)
120 span = rra_timespans[i];
122 if ((span / stepsize) < rrarows)
128 cdp_len = (int) floor (((double) span)
129 / ((double) (rrarows * stepsize)));
131 cdp_num = (int) ceil (((double) span)
132 / ((double) (cdp_len * stepsize)));
134 for (j = 0; j < rra_types_num; j++)
136 if (rra_num >= rra_max)
139 if (snprintf (buffer, sizeof (buffer), "RRA:%s:%3.1f:%u:%u",
141 cdp_len, cdp_num) >= sizeof (buffer))
143 syslog (LOG_ERR, "rra_get: Buffer would have been truncated.");
147 rra_def[rra_num++] = sstrdup (buffer);
152 DBG ("rra_num = %i", rra_num);
153 for (i = 0; i < rra_num; i++)
154 DBG (" %s", rra_def[i]);
161 static void ds_free (int ds_num, char **ds_def)
165 for (i = 0; i < ds_num; i++)
166 if (ds_def[i] != NULL)
171 static int ds_get (char ***ret, const data_set_t *ds)
180 DBG ("ds->ds_num = %i", ds->ds_num);
182 ds_def = (char **) malloc (ds->ds_num * sizeof (char *));
185 syslog (LOG_ERR, "rrdtool plugin: malloc failed: %s",
189 memset (ds_def, '\0', ds->ds_num * sizeof (char *));
191 for (ds_num = 0; ds_num < ds->ds_num; ds_num++)
193 data_source_t *d = ds->ds + ds_num;
197 ds_def[ds_num] = NULL;
199 if (d->type == DS_TYPE_COUNTER)
201 else if (d->type == DS_TYPE_GAUGE)
205 syslog (LOG_ERR, "rrdtool plugin: Unknown DS type: %i",
216 snprintf (min, sizeof (min), "%lf", d->min);
217 min[sizeof (min) - 1] = '\0';
226 snprintf (max, sizeof (max), "%lf", d->max);
227 max[sizeof (max) - 1] = '\0';
230 status = snprintf (buffer, sizeof (buffer),
232 d->name, type, heartbeat,
234 if ((status < 1) || (status >= sizeof (buffer)))
237 ds_def[ds_num] = sstrdup (buffer);
238 } /* for ds_num = 0 .. ds->ds_num */
243 DBG ("ds_num = %i", ds_num);
244 for (i = 0; i < ds_num; i++)
245 DBG (" %s", ds_def[i]);
249 if (ds_num != ds->ds_num)
251 ds_free (ds_num, ds_def);
259 static int rrd_create_file (char *filename, const data_set_t *ds)
268 char stepsize_str[16];
271 if (check_create_dir (filename))
274 if ((rra_num = rra_get (&rra_def)) < 1)
276 syslog (LOG_ERR, "rrd_create_file failed: Could not calculate RRAs");
280 if ((ds_num = ds_get (&ds_def, ds)) < 1)
282 syslog (LOG_ERR, "rrd_create_file failed: Could not calculate DSes");
286 argc = ds_num + rra_num + 4;
288 if ((argv = (char **) malloc (sizeof (char *) * (argc + 1))) == NULL)
290 syslog (LOG_ERR, "rrd_create failed: %s", strerror (errno));
294 status = snprintf (stepsize_str, sizeof (stepsize_str),
296 if ((status < 1) || (status >= sizeof (stepsize_str)))
298 syslog (LOG_ERR, "rrdtool plugin: snprintf failed.");
305 argv[3] = stepsize_str;
308 for (i = 0; i < ds_num; i++)
309 argv[j++] = ds_def[i];
310 for (i = 0; i < rra_num; i++)
311 argv[j++] = rra_def[i];
314 optind = 0; /* bug in librrd? */
316 if (rrd_create (argc, argv) == -1)
318 syslog (LOG_ERR, "rrd_create failed: %s: %s", filename, rrd_get_error ());
323 ds_free (ds_num, ds_def);
328 static int value_list_to_string (char *buffer, int buffer_len,
329 const data_set_t *ds, const value_list_t *vl)
335 memset (buffer, '\0', sizeof (buffer_len));
337 status = snprintf (buffer, buffer_len, "%u", (unsigned int) vl->time);
338 if ((status < 1) || (status >= buffer_len))
342 for (i = 0; i < ds->ds_num; i++)
344 if ((ds->ds[i].type != DS_TYPE_COUNTER)
345 && (ds->ds[i].type != DS_TYPE_GAUGE))
348 if (ds->ds[i].type == DS_TYPE_COUNTER)
349 status = snprintf (buffer + offset, buffer_len - offset,
350 ":%llu", vl->values[i].counter);
352 status = snprintf (buffer + offset, buffer_len - offset,
353 ":%lf", vl->values[i].gauge);
355 if ((status < 1) || (status >= (buffer_len - offset)))
359 } /* for ds->ds_num */
362 } /* int value_list_to_string */
364 static int value_list_to_filename (char *buffer, int buffer_len,
365 const data_set_t *ds, const value_list_t *vl)
372 status = snprintf (buffer + offset, buffer_len - offset,
374 if ((status < 1) || (status >= buffer_len - offset))
379 status = snprintf (buffer + offset, buffer_len - offset,
381 if ((status < 1) || (status >= buffer_len - offset))
385 if (strlen (vl->plugin_instance) > 0)
386 status = snprintf (buffer + offset, buffer_len - offset,
387 "%s-%s/", vl->plugin, vl->plugin_instance);
389 status = snprintf (buffer + offset, buffer_len - offset,
391 if ((status < 1) || (status >= buffer_len - offset))
395 if (strlen (vl->type_instance) > 0)
396 status = snprintf (buffer + offset, buffer_len - offset,
397 "%s-%s.rrd", ds->type, vl->type_instance);
399 status = snprintf (buffer + offset, buffer_len - offset,
401 if ((status < 1) || (status >= buffer_len - offset))
406 } /* int value_list_to_filename */
408 static rrd_cache_t *rrd_cache_insert (const char *filename,
411 rrd_cache_t *rc = NULL;
415 avl_get (cache, filename, (void *) &rc);
419 rc = (rrd_cache_t *) malloc (sizeof (rrd_cache_t));
428 rc->values = (char **) realloc ((void *) rc->values,
429 (rc->values_num + 1) * sizeof (char *));
430 if (rc->values == NULL)
432 syslog (LOG_ERR, "rrdtool plugin: realloc failed: %s",
436 void *cache_key = NULL;
437 avl_remove (cache, filename, &cache_key, NULL);
444 rc->values[rc->values_num] = strdup (value);
445 if (rc->values[rc->values_num] != NULL)
448 if (rc->values_num == 1)
449 rc->first_value = time (NULL);
451 /* Insert if this is the first value */
452 if ((cache != NULL) && (new_rc == 1))
454 void *cache_key = strdup (filename);
456 if (cache_key == NULL)
458 syslog (LOG_ERR, "rrdtool plugin: strdup failed: %s",
460 sfree (rc->values[0]);
466 avl_insert (cache, cache_key, rc);
469 DBG ("rrd_cache_insert (%s, %s) = %p", filename, value, (void *) rc);
472 } /* rrd_cache_t *rrd_cache_insert */
474 static int rrd_write_cache_entry (const char *filename, rrd_cache_t *rc)
484 argc = rc->values_num + 2;
485 argv = (char **) malloc ((argc + 1) * sizeof (char *));
489 fn = strdup (filename);
498 memcpy (argv + 2, rc->values, rc->values_num * sizeof (char *));
501 DBG ("rrd_update (argc = %i, argv = %p)", argc, (void *) argv);
503 optind = 0; /* bug in librrd? */
505 status = rrd_update (argc, argv);
510 /* Free the value list of `rc' */
511 for (i = 0; i < rc->values_num; i++)
512 free (rc->values[i]);
519 syslog (LOG_WARNING, "rrd_update failed: %s: %s",
520 filename, rrd_get_error ());
525 } /* int rrd_write_cache_entry */
527 static void rrd_cache_flush (int timeout)
536 avl_iterator_t *iter;
542 DBG ("Flushing cache, timeout = %i", timeout);
546 /* Build a list of entries to be flushed */
547 iter = avl_get_iterator (cache);
548 while (avl_iterator_next (iter, (void *) &key, (void *) &rc) == 0)
550 DBG ("key = %s; age = %i;", key, now - rc->first_value);
551 if ((now - rc->first_value) >= timeout)
553 keys = (char **) realloc ((void *) keys,
554 (keys_num + 1) * sizeof (char *));
557 DBG ("realloc failed: %s", strerror (errno));
558 syslog (LOG_ERR, "rrdtool plugin: "
559 "realloc failed: %s",
561 avl_iterator_destroy (iter);
564 keys[keys_num] = key;
567 } /* while (avl_iterator_next) */
568 avl_iterator_destroy (iter);
570 for (i = 0; i < keys_num; i++)
572 if (avl_remove (cache, keys[i], (void *) &key, (void *) &rc) != 0)
574 DBG ("avl_remove (%s) failed.", keys[i]);
578 rrd_write_cache_entry (keys[i], rc);
579 /* rc's value-list is free's by `rrd_write_cache_entry' */
583 } /* for (i = 0..keys_num) */
586 DBG ("Flushed %i value(s)", keys_num);
588 cache_flush_last = now;
589 } /* void rrd_cache_flush */
591 static int rrd_write (const data_set_t *ds, const value_list_t *vl)
599 if (value_list_to_filename (filename, sizeof (filename), ds, vl) != 0)
602 if (value_list_to_string (values, sizeof (values), ds, vl) != 0)
605 if (stat (filename, &statbuf) == -1)
609 if (rrd_create_file (filename, ds))
614 syslog (LOG_ERR, "stat(%s) failed: %s",
615 filename, strerror (errno));
619 else if (!S_ISREG (statbuf.st_mode))
621 syslog (LOG_ERR, "stat(%s): Not a regular file!",
626 rc = rrd_cache_insert (filename, values);
632 rrd_write_cache_entry (filename, rc);
633 /* rc's value-list is free's by `rrd_write_cache_entry' */
640 DBG ("age (%s) = %i", filename, now - rc->first_value);
642 /* `rc' is not free'd here, because we'll likely reuse it. If not, then
643 * the next flush will remove this entry. */
644 if ((now - rc->first_value) >= cache_timeout)
645 rrd_write_cache_entry (filename, rc);
647 if ((now - cache_flush_last) >= cache_flush_timeout)
648 rrd_cache_flush (cache_flush_timeout);
651 } /* int rrd_write */
653 static int rrd_config (const char *key, const char *value)
655 if (strcasecmp ("CacheTimeout", key) == 0)
657 int tmp = atoi (value);
660 fprintf (stderr, "rrdtool: `CacheTimeout' must "
661 "be greater than 0.\n");
666 else if (strcasecmp ("CacheFlush", key) == 0)
668 int tmp = atoi (value);
671 fprintf (stderr, "rrdtool: `CacheFlush' must "
672 "be greater than 0.\n");
675 cache_flush_timeout = tmp;
677 else if (strcasecmp ("DataDir", key) == 0)
681 datadir = strdup (value);
684 int len = strlen (datadir);
685 while ((len > 0) && (datadir[len - 1] == '/'))
697 else if (strcasecmp ("StepSize", key) == 0)
699 int tmp = atoi (value);
702 fprintf (stderr, "rrdtool: `StepSize' must "
703 "be greater than 0.\n");
708 else if (strcasecmp ("HeartBeat", key) == 0)
710 int tmp = atoi (value);
713 fprintf (stderr, "rrdtool: `HeartBeat' must "
714 "be greater than 0.\n");
719 else if (strcasecmp ("RRARows", key) == 0)
721 int tmp = atoi (value);
724 fprintf (stderr, "rrdtool: `RRARows' must "
725 "be greater than 0.\n");
730 else if (strcasecmp ("XFF", key) == 0)
732 double tmp = atof (value);
733 if ((tmp < 0.0) || (tmp >= 1.0))
735 fprintf (stderr, "rrdtool: `XFF' must "
736 "be in the range 0 to 1 (exclusive).");
746 } /* int rrd_config */
748 static int rrd_shutdown (void)
750 rrd_cache_flush (-1);
756 } /* int rrd_shutdown */
758 static int rrd_init (void)
761 stepsize = interval_g;
763 heartbeat = 2 * interval_g;
765 if (heartbeat < interval_g)
766 syslog (LOG_WARNING, "rrdtool plugin: Your `heartbeat' is "
767 "smaller than your `interval'. This will "
768 "likely cause problems.");
769 else if (stepsize < interval_g)
770 syslog (LOG_WARNING, "rrdtool plugin: Your `stepsize' is "
771 "smaller than your `interval'. This will "
772 "create needlessly big RRD-files.");
774 if (cache_timeout < 2)
777 cache_flush_timeout = 0;
781 if (cache_flush_timeout < cache_timeout)
782 cache_flush_timeout = 10 * cache_timeout;
784 cache = avl_create ((int (*) (const void *, const void *)) strcmp);
785 cache_flush_last = time (NULL);
786 plugin_register_shutdown ("rrdtool", rrd_shutdown);
789 DBG ("datadir = %s; stepsize = %i; heartbeat = %i; rrarows = %i; xff = %lf;",
790 (datadir == NULL) ? "(null)" : datadir,
791 stepsize, heartbeat, rrarows, xff);
796 void module_register (void)
798 plugin_register_config ("rrdtool", rrd_config,
799 config_keys, config_keys_num);
800 plugin_register_init ("rrdtool", rrd_init);
801 plugin_register_write ("rrdtool", rrd_write);