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"
36 typedef struct rrd_cache_s rrd_cache_t;
41 static int rra_timespans[] =
49 static int rra_timespans_num = STATIC_ARRAY_SIZE (rra_timespans);
51 static char *rra_types[] =
57 static int rra_types_num = STATIC_ARRAY_SIZE (rra_types);
59 static const char *config_keys[] =
69 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
71 static char *datadir = NULL;
72 static int stepsize = 0;
73 static int heartbeat = 0;
74 static int rrarows = 1200;
75 static double xff = 0.1;
77 static int cache_timeout = 0;
78 static int cache_flush_timeout = 0;
79 static time_t cache_flush_last;
80 static avl_tree_t *cache = NULL;
85 static int rra_get (char ***ret)
87 static char **rra_def = NULL;
88 static int rra_num = 0;
90 int rra_max = rra_timespans_num * rra_types_num;
100 if ((rra_num != 0) && (rra_def != NULL))
106 if ((rra_def = (char **) malloc ((rra_max + 1) * sizeof (char *))) == NULL)
108 memset (rra_def, '\0', (rra_max + 1) * sizeof (char *));
110 if ((stepsize <= 0) || (rrarows <= 0))
117 for (i = 0; i < rra_timespans_num; i++)
119 span = rra_timespans[i];
121 if ((span / stepsize) < rrarows)
127 cdp_len = (int) floor (((double) span)
128 / ((double) (rrarows * stepsize)));
130 cdp_num = (int) ceil (((double) span)
131 / ((double) (cdp_len * stepsize)));
133 for (j = 0; j < rra_types_num; j++)
135 if (rra_num >= rra_max)
138 if (snprintf (buffer, sizeof (buffer), "RRA:%s:%3.1f:%u:%u",
140 cdp_len, cdp_num) >= sizeof (buffer))
142 ERROR ("rra_get: Buffer would have been truncated.");
146 rra_def[rra_num++] = sstrdup (buffer);
151 DEBUG ("rra_num = %i", rra_num);
152 for (i = 0; i < rra_num; i++)
153 DEBUG (" %s", rra_def[i]);
160 static void ds_free (int ds_num, char **ds_def)
164 for (i = 0; i < ds_num; i++)
165 if (ds_def[i] != NULL)
170 static int ds_get (char ***ret, const data_set_t *ds)
179 DEBUG ("ds->ds_num = %i", ds->ds_num);
181 ds_def = (char **) malloc (ds->ds_num * sizeof (char *));
184 ERROR ("rrdtool plugin: malloc failed: %s",
188 memset (ds_def, '\0', ds->ds_num * sizeof (char *));
190 for (ds_num = 0; ds_num < ds->ds_num; ds_num++)
192 data_source_t *d = ds->ds + ds_num;
196 ds_def[ds_num] = NULL;
198 if (d->type == DS_TYPE_COUNTER)
200 else if (d->type == DS_TYPE_GAUGE)
204 ERROR ("rrdtool plugin: Unknown DS type: %i",
215 snprintf (min, sizeof (min), "%lf", d->min);
216 min[sizeof (min) - 1] = '\0';
225 snprintf (max, sizeof (max), "%lf", d->max);
226 max[sizeof (max) - 1] = '\0';
229 status = snprintf (buffer, sizeof (buffer),
231 d->name, type, heartbeat,
233 if ((status < 1) || (status >= sizeof (buffer)))
236 ds_def[ds_num] = sstrdup (buffer);
237 } /* for ds_num = 0 .. ds->ds_num */
242 DEBUG ("ds_num = %i", ds_num);
243 for (i = 0; i < ds_num; i++)
244 DEBUG (" %s", ds_def[i]);
248 if (ds_num != ds->ds_num)
250 ds_free (ds_num, ds_def);
258 static int rrd_create_file (char *filename, const data_set_t *ds)
267 char stepsize_str[16];
270 if (check_create_dir (filename))
273 if ((rra_num = rra_get (&rra_def)) < 1)
275 ERROR ("rrd_create_file failed: Could not calculate RRAs");
279 if ((ds_num = ds_get (&ds_def, ds)) < 1)
281 ERROR ("rrd_create_file failed: Could not calculate DSes");
285 argc = ds_num + rra_num + 4;
287 if ((argv = (char **) malloc (sizeof (char *) * (argc + 1))) == NULL)
289 ERROR ("rrd_create failed: %s", strerror (errno));
293 status = snprintf (stepsize_str, sizeof (stepsize_str),
295 if ((status < 1) || (status >= sizeof (stepsize_str)))
297 ERROR ("rrdtool plugin: snprintf failed.");
304 argv[3] = stepsize_str;
307 for (i = 0; i < ds_num; i++)
308 argv[j++] = ds_def[i];
309 for (i = 0; i < rra_num; i++)
310 argv[j++] = rra_def[i];
313 optind = 0; /* bug in librrd? */
315 if (rrd_create (argc, argv) == -1)
317 ERROR ("rrd_create failed: %s: %s", filename, rrd_get_error ());
322 ds_free (ds_num, ds_def);
327 static int value_list_to_string (char *buffer, int buffer_len,
328 const data_set_t *ds, const value_list_t *vl)
334 memset (buffer, '\0', sizeof (buffer_len));
336 status = snprintf (buffer, buffer_len, "%u", (unsigned int) vl->time);
337 if ((status < 1) || (status >= buffer_len))
341 for (i = 0; i < ds->ds_num; i++)
343 if ((ds->ds[i].type != DS_TYPE_COUNTER)
344 && (ds->ds[i].type != DS_TYPE_GAUGE))
347 if (ds->ds[i].type == DS_TYPE_COUNTER)
348 status = snprintf (buffer + offset, buffer_len - offset,
349 ":%llu", vl->values[i].counter);
351 status = snprintf (buffer + offset, buffer_len - offset,
352 ":%lf", vl->values[i].gauge);
354 if ((status < 1) || (status >= (buffer_len - offset)))
358 } /* for ds->ds_num */
361 } /* int value_list_to_string */
363 static int value_list_to_filename (char *buffer, int buffer_len,
364 const data_set_t *ds, const value_list_t *vl)
371 status = snprintf (buffer + offset, buffer_len - offset,
373 if ((status < 1) || (status >= buffer_len - offset))
378 status = snprintf (buffer + offset, buffer_len - offset,
380 if ((status < 1) || (status >= buffer_len - offset))
384 if (strlen (vl->plugin_instance) > 0)
385 status = snprintf (buffer + offset, buffer_len - offset,
386 "%s-%s/", vl->plugin, vl->plugin_instance);
388 status = snprintf (buffer + offset, buffer_len - offset,
390 if ((status < 1) || (status >= buffer_len - offset))
394 if (strlen (vl->type_instance) > 0)
395 status = snprintf (buffer + offset, buffer_len - offset,
396 "%s-%s.rrd", ds->type, vl->type_instance);
398 status = snprintf (buffer + offset, buffer_len - offset,
400 if ((status < 1) || (status >= buffer_len - offset))
405 } /* int value_list_to_filename */
407 static rrd_cache_t *rrd_cache_insert (const char *filename,
410 rrd_cache_t *rc = NULL;
414 avl_get (cache, filename, (void *) &rc);
418 rc = (rrd_cache_t *) malloc (sizeof (rrd_cache_t));
427 rc->values = (char **) realloc ((void *) rc->values,
428 (rc->values_num + 1) * sizeof (char *));
429 if (rc->values == NULL)
431 ERROR ("rrdtool plugin: realloc failed: %s",
435 void *cache_key = NULL;
436 avl_remove (cache, filename, &cache_key, NULL);
443 rc->values[rc->values_num] = strdup (value);
444 if (rc->values[rc->values_num] != NULL)
447 if (rc->values_num == 1)
448 rc->first_value = time (NULL);
450 /* Insert if this is the first value */
451 if ((cache != NULL) && (new_rc == 1))
453 void *cache_key = strdup (filename);
455 if (cache_key == NULL)
457 ERROR ("rrdtool plugin: strdup failed: %s",
459 sfree (rc->values[0]);
465 avl_insert (cache, cache_key, rc);
468 DEBUG ("rrd_cache_insert (%s, %s) = %p", filename, value, (void *) rc);
471 } /* rrd_cache_t *rrd_cache_insert */
473 static int rrd_write_cache_entry (const char *filename, rrd_cache_t *rc)
483 argc = rc->values_num + 2;
484 argv = (char **) malloc ((argc + 1) * sizeof (char *));
488 fn = strdup (filename);
497 memcpy (argv + 2, rc->values, rc->values_num * sizeof (char *));
500 DEBUG ("rrd_update (argc = %i, argv = %p)", argc, (void *) argv);
502 optind = 0; /* bug in librrd? */
504 status = rrd_update (argc, argv);
509 /* Free the value list of `rc' */
510 for (i = 0; i < rc->values_num; i++)
511 free (rc->values[i]);
518 WARNING ("rrd_update failed: %s: %s",
519 filename, rrd_get_error ());
524 } /* int rrd_write_cache_entry */
526 static void rrd_cache_flush (int timeout)
535 avl_iterator_t *iter;
541 DEBUG ("Flushing cache, timeout = %i", timeout);
545 /* Build a list of entries to be flushed */
546 iter = avl_get_iterator (cache);
547 while (avl_iterator_next (iter, (void *) &key, (void *) &rc) == 0)
549 DEBUG ("key = %s; age = %i;", key, now - rc->first_value);
550 if ((now - rc->first_value) >= timeout)
552 keys = (char **) realloc ((void *) keys,
553 (keys_num + 1) * sizeof (char *));
556 DEBUG ("realloc failed: %s", strerror (errno));
557 ERROR ("rrdtool plugin: "
558 "realloc failed: %s",
560 avl_iterator_destroy (iter);
563 keys[keys_num] = key;
566 } /* while (avl_iterator_next) */
567 avl_iterator_destroy (iter);
569 for (i = 0; i < keys_num; i++)
571 if (avl_remove (cache, keys[i], (void *) &key, (void *) &rc) != 0)
573 DEBUG ("avl_remove (%s) failed.", keys[i]);
577 rrd_write_cache_entry (keys[i], rc);
578 /* rc's value-list is free's by `rrd_write_cache_entry' */
582 } /* for (i = 0..keys_num) */
585 DEBUG ("Flushed %i value(s)", keys_num);
587 cache_flush_last = now;
588 } /* void rrd_cache_flush */
590 static int rrd_write (const data_set_t *ds, const value_list_t *vl)
598 if (value_list_to_filename (filename, sizeof (filename), ds, vl) != 0)
601 if (value_list_to_string (values, sizeof (values), ds, vl) != 0)
604 if (stat (filename, &statbuf) == -1)
608 if (rrd_create_file (filename, ds))
613 ERROR ("stat(%s) failed: %s",
614 filename, strerror (errno));
618 else if (!S_ISREG (statbuf.st_mode))
620 ERROR ("stat(%s): Not a regular file!",
625 rc = rrd_cache_insert (filename, values);
631 rrd_write_cache_entry (filename, rc);
632 /* rc's value-list is free's by `rrd_write_cache_entry' */
639 DEBUG ("age (%s) = %i", filename, now - rc->first_value);
641 /* `rc' is not free'd here, because we'll likely reuse it. If not, then
642 * the next flush will remove this entry. */
643 if ((now - rc->first_value) >= cache_timeout)
644 rrd_write_cache_entry (filename, rc);
646 if ((now - cache_flush_last) >= cache_flush_timeout)
647 rrd_cache_flush (cache_flush_timeout);
650 } /* int rrd_write */
652 static int rrd_config (const char *key, const char *value)
654 if (strcasecmp ("CacheTimeout", key) == 0)
656 int tmp = atoi (value);
659 fprintf (stderr, "rrdtool: `CacheTimeout' must "
660 "be greater than 0.\n");
665 else if (strcasecmp ("CacheFlush", key) == 0)
667 int tmp = atoi (value);
670 fprintf (stderr, "rrdtool: `CacheFlush' must "
671 "be greater than 0.\n");
674 cache_flush_timeout = tmp;
676 else if (strcasecmp ("DataDir", key) == 0)
680 datadir = strdup (value);
683 int len = strlen (datadir);
684 while ((len > 0) && (datadir[len - 1] == '/'))
696 else if (strcasecmp ("StepSize", key) == 0)
698 int tmp = atoi (value);
701 fprintf (stderr, "rrdtool: `StepSize' must "
702 "be greater than 0.\n");
707 else if (strcasecmp ("HeartBeat", key) == 0)
709 int tmp = atoi (value);
712 fprintf (stderr, "rrdtool: `HeartBeat' must "
713 "be greater than 0.\n");
718 else if (strcasecmp ("RRARows", key) == 0)
720 int tmp = atoi (value);
723 fprintf (stderr, "rrdtool: `RRARows' must "
724 "be greater than 0.\n");
729 else if (strcasecmp ("XFF", key) == 0)
731 double tmp = atof (value);
732 if ((tmp < 0.0) || (tmp >= 1.0))
734 fprintf (stderr, "rrdtool: `XFF' must "
735 "be in the range 0 to 1 (exclusive).");
745 } /* int rrd_config */
747 static int rrd_shutdown (void)
749 rrd_cache_flush (-1);
755 } /* int rrd_shutdown */
757 static int rrd_init (void)
760 stepsize = interval_g;
762 heartbeat = 2 * interval_g;
764 if (heartbeat < interval_g)
765 WARNING ("rrdtool plugin: Your `heartbeat' is "
766 "smaller than your `interval'. This will "
767 "likely cause problems.");
768 else if (stepsize < interval_g)
769 WARNING ("rrdtool plugin: Your `stepsize' is "
770 "smaller than your `interval'. This will "
771 "create needlessly big RRD-files.");
773 if (cache_timeout < 2)
776 cache_flush_timeout = 0;
780 if (cache_flush_timeout < cache_timeout)
781 cache_flush_timeout = 10 * cache_timeout;
783 cache = avl_create ((int (*) (const void *, const void *)) strcmp);
784 cache_flush_last = time (NULL);
785 plugin_register_shutdown ("rrdtool", rrd_shutdown);
788 DEBUG ("datadir = %s; stepsize = %i; heartbeat = %i; rrarows = %i; xff = %lf;",
789 (datadir == NULL) ? "(null)" : datadir,
790 stepsize, heartbeat, rrarows, xff);
795 void module_register (void)
797 plugin_register_config ("rrdtool", rrd_config,
798 config_keys, config_keys_num);
799 plugin_register_init ("rrdtool", rrd_init);
800 plugin_register_write ("rrdtool", rrd_write);