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"
40 typedef struct rrd_cache_s rrd_cache_t;
45 static int rra_timespans[] =
53 static int rra_timespans_num = STATIC_ARRAY_SIZE (rra_timespans);
55 static char *rra_types[] =
61 static int rra_types_num = STATIC_ARRAY_SIZE (rra_types);
63 static const char *config_keys[] =
73 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
75 static char *datadir = NULL;
76 static int stepsize = 0;
77 static int heartbeat = 0;
78 static int rrarows = 1200;
79 static double xff = 0.1;
81 static int cache_timeout = 0;
82 static int cache_flush_timeout = 0;
83 static time_t cache_flush_last;
84 static avl_tree_t *cache = NULL;
85 static pthread_mutex_t cache_lock = PTHREAD_MUTEX_INITIALIZER;
90 static int rra_get (char ***ret)
92 static char **rra_def = NULL;
93 static int rra_num = 0;
95 int rra_max = rra_timespans_num * rra_types_num;
105 if ((rra_num != 0) && (rra_def != NULL))
111 if ((rra_def = (char **) malloc ((rra_max + 1) * sizeof (char *))) == NULL)
113 memset (rra_def, '\0', (rra_max + 1) * sizeof (char *));
115 if ((stepsize <= 0) || (rrarows <= 0))
122 for (i = 0; i < rra_timespans_num; i++)
124 span = rra_timespans[i];
126 if ((span / stepsize) < rrarows)
132 cdp_len = (int) floor (((double) span)
133 / ((double) (rrarows * stepsize)));
135 cdp_num = (int) ceil (((double) span)
136 / ((double) (cdp_len * stepsize)));
138 for (j = 0; j < rra_types_num; j++)
140 if (rra_num >= rra_max)
143 if (snprintf (buffer, sizeof (buffer), "RRA:%s:%3.1f:%u:%u",
145 cdp_len, cdp_num) >= sizeof (buffer))
147 ERROR ("rra_get: Buffer would have been truncated.");
151 rra_def[rra_num++] = sstrdup (buffer);
156 DEBUG ("rra_num = %i", rra_num);
157 for (i = 0; i < rra_num; i++)
158 DEBUG (" %s", rra_def[i]);
165 static void ds_free (int ds_num, char **ds_def)
169 for (i = 0; i < ds_num; i++)
170 if (ds_def[i] != NULL)
175 static int ds_get (char ***ret, const data_set_t *ds)
184 DEBUG ("ds->ds_num = %i", ds->ds_num);
186 ds_def = (char **) malloc (ds->ds_num * sizeof (char *));
190 ERROR ("rrdtool plugin: malloc failed: %s",
191 sstrerror (errno, errbuf, sizeof (errbuf)));
194 memset (ds_def, '\0', ds->ds_num * sizeof (char *));
196 for (ds_num = 0; ds_num < ds->ds_num; ds_num++)
198 data_source_t *d = ds->ds + ds_num;
202 ds_def[ds_num] = NULL;
204 if (d->type == DS_TYPE_COUNTER)
206 else if (d->type == DS_TYPE_GAUGE)
210 ERROR ("rrdtool plugin: Unknown DS type: %i",
221 snprintf (min, sizeof (min), "%lf", d->min);
222 min[sizeof (min) - 1] = '\0';
231 snprintf (max, sizeof (max), "%lf", d->max);
232 max[sizeof (max) - 1] = '\0';
235 status = snprintf (buffer, sizeof (buffer),
237 d->name, type, heartbeat,
239 if ((status < 1) || (status >= sizeof (buffer)))
242 ds_def[ds_num] = sstrdup (buffer);
243 } /* for ds_num = 0 .. ds->ds_num */
248 DEBUG ("ds_num = %i", ds_num);
249 for (i = 0; i < ds_num; i++)
250 DEBUG (" %s", ds_def[i]);
254 if (ds_num != ds->ds_num)
256 ds_free (ds_num, ds_def);
264 static int rrd_create_file (char *filename, const data_set_t *ds)
273 char stepsize_str[16];
276 if (check_create_dir (filename))
279 if ((rra_num = rra_get (&rra_def)) < 1)
281 ERROR ("rrd_create_file failed: Could not calculate RRAs");
285 if ((ds_num = ds_get (&ds_def, ds)) < 1)
287 ERROR ("rrd_create_file failed: Could not calculate DSes");
291 argc = ds_num + rra_num + 4;
293 if ((argv = (char **) malloc (sizeof (char *) * (argc + 1))) == NULL)
296 ERROR ("rrd_create failed: %s",
297 sstrerror (errno, errbuf, sizeof (errbuf)));
301 status = snprintf (stepsize_str, sizeof (stepsize_str),
303 if ((status < 1) || (status >= sizeof (stepsize_str)))
305 ERROR ("rrdtool plugin: snprintf failed.");
312 argv[3] = stepsize_str;
315 for (i = 0; i < ds_num; i++)
316 argv[j++] = ds_def[i];
317 for (i = 0; i < rra_num; i++)
318 argv[j++] = rra_def[i];
321 optind = 0; /* bug in librrd? */
323 if (rrd_create (argc, argv) == -1)
325 ERROR ("rrd_create failed: %s: %s", filename, rrd_get_error ());
330 ds_free (ds_num, ds_def);
335 static int value_list_to_string (char *buffer, int buffer_len,
336 const data_set_t *ds, const value_list_t *vl)
342 memset (buffer, '\0', sizeof (buffer_len));
344 status = snprintf (buffer, buffer_len, "%u", (unsigned int) vl->time);
345 if ((status < 1) || (status >= buffer_len))
349 for (i = 0; i < ds->ds_num; i++)
351 if ((ds->ds[i].type != DS_TYPE_COUNTER)
352 && (ds->ds[i].type != DS_TYPE_GAUGE))
355 if (ds->ds[i].type == DS_TYPE_COUNTER)
356 status = snprintf (buffer + offset, buffer_len - offset,
357 ":%llu", vl->values[i].counter);
359 status = snprintf (buffer + offset, buffer_len - offset,
360 ":%lf", vl->values[i].gauge);
362 if ((status < 1) || (status >= (buffer_len - offset)))
366 } /* for ds->ds_num */
369 } /* int value_list_to_string */
371 static int value_list_to_filename (char *buffer, int buffer_len,
372 const data_set_t *ds, const value_list_t *vl)
379 status = snprintf (buffer + offset, buffer_len - offset,
381 if ((status < 1) || (status >= buffer_len - offset))
386 status = snprintf (buffer + offset, buffer_len - offset,
388 if ((status < 1) || (status >= buffer_len - offset))
392 if (strlen (vl->plugin_instance) > 0)
393 status = snprintf (buffer + offset, buffer_len - offset,
394 "%s-%s/", vl->plugin, vl->plugin_instance);
396 status = snprintf (buffer + offset, buffer_len - offset,
398 if ((status < 1) || (status >= buffer_len - offset))
402 if (strlen (vl->type_instance) > 0)
403 status = snprintf (buffer + offset, buffer_len - offset,
404 "%s-%s.rrd", ds->type, vl->type_instance);
406 status = snprintf (buffer + offset, buffer_len - offset,
408 if ((status < 1) || (status >= buffer_len - offset))
413 } /* int value_list_to_filename */
415 static rrd_cache_t *rrd_cache_insert (const char *filename,
418 rrd_cache_t *rc = NULL;
422 avl_get (cache, filename, (void *) &rc);
426 rc = (rrd_cache_t *) malloc (sizeof (rrd_cache_t));
435 rc->values = (char **) realloc ((void *) rc->values,
436 (rc->values_num + 1) * sizeof (char *));
437 if (rc->values == NULL)
440 ERROR ("rrdtool plugin: realloc failed: %s",
441 sstrerror (errno, errbuf, sizeof (errbuf)));
444 void *cache_key = NULL;
445 avl_remove (cache, filename, &cache_key, NULL);
452 rc->values[rc->values_num] = strdup (value);
453 if (rc->values[rc->values_num] != NULL)
456 if (rc->values_num == 1)
457 rc->first_value = time (NULL);
459 /* Insert if this is the first value */
460 if ((cache != NULL) && (new_rc == 1))
462 void *cache_key = strdup (filename);
464 if (cache_key == NULL)
467 ERROR ("rrdtool plugin: strdup failed: %s",
468 sstrerror (errno, errbuf, sizeof (errbuf)));
469 sfree (rc->values[0]);
475 avl_insert (cache, cache_key, rc);
478 DEBUG ("rrd_cache_insert (%s, %s) = %p", filename, value, (void *) rc);
481 } /* rrd_cache_t *rrd_cache_insert */
483 static int rrd_write_cache_entry (const char *filename, rrd_cache_t *rc)
493 if (rc->values_num < 1)
496 argc = rc->values_num + 2;
497 argv = (char **) malloc ((argc + 1) * sizeof (char *));
501 fn = strdup (filename);
510 memcpy (argv + 2, rc->values, rc->values_num * sizeof (char *));
513 DEBUG ("rrd_update (argc = %i, argv = %p)", argc, (void *) argv);
515 optind = 0; /* bug in librrd? */
517 status = rrd_update (argc, argv);
520 WARNING ("rrd_update failed: %s: %s",
521 filename, rrd_get_error ());
527 /* Free the value list of `rc' */
528 for (i = 0; i < rc->values_num; i++)
529 free (rc->values[i]);
535 } /* int rrd_write_cache_entry */
537 static void rrd_cache_flush (int timeout)
546 avl_iterator_t *iter;
552 DEBUG ("Flushing cache, timeout = %i", timeout);
556 /* Build a list of entries to be flushed */
557 iter = avl_get_iterator (cache);
558 while (avl_iterator_next (iter, (void *) &key, (void *) &rc) == 0)
560 DEBUG ("key = %s; age = %i;", key, now - rc->first_value);
561 if ((now - rc->first_value) >= timeout)
563 keys = (char **) realloc ((void *) keys,
564 (keys_num + 1) * sizeof (char *));
568 ERROR ("rrdtool plugin: "
569 "realloc failed: %s",
570 sstrerror (errno, errbuf,
572 avl_iterator_destroy (iter);
575 keys[keys_num] = key;
578 } /* while (avl_iterator_next) */
579 avl_iterator_destroy (iter);
581 for (i = 0; i < keys_num; i++)
583 if (avl_remove (cache, keys[i], (void *) &key, (void *) &rc) != 0)
585 DEBUG ("avl_remove (%s) failed.", keys[i]);
589 rrd_write_cache_entry (keys[i], rc);
590 /* rc's value-list is free's by `rrd_write_cache_entry' */
594 } /* for (i = 0..keys_num) */
597 DEBUG ("Flushed %i value(s)", keys_num);
599 cache_flush_last = now;
600 } /* void rrd_cache_flush */
602 static int rrd_write (const data_set_t *ds, const value_list_t *vl)
610 if (value_list_to_filename (filename, sizeof (filename), ds, vl) != 0)
613 if (value_list_to_string (values, sizeof (values), ds, vl) != 0)
616 if (stat (filename, &statbuf) == -1)
620 if (rrd_create_file (filename, ds))
626 ERROR ("stat(%s) failed: %s", filename,
627 sstrerror (errno, errbuf,
632 else if (!S_ISREG (statbuf.st_mode))
634 ERROR ("stat(%s): Not a regular file!",
639 pthread_mutex_lock (&cache_lock);
640 rc = rrd_cache_insert (filename, values);
643 pthread_mutex_unlock (&cache_lock);
649 rrd_write_cache_entry (filename, rc);
650 /* rc's value-list is free's by `rrd_write_cache_entry' */
652 pthread_mutex_unlock (&cache_lock);
658 DEBUG ("age (%s) = %i", filename, now - rc->first_value);
660 /* `rc' is not free'd here, because we'll likely reuse it. If not, then
661 * the next flush will remove this entry. */
662 if ((now - rc->first_value) >= cache_timeout)
663 rrd_write_cache_entry (filename, rc);
665 if ((now - cache_flush_last) >= cache_flush_timeout)
666 rrd_cache_flush (cache_flush_timeout);
668 pthread_mutex_unlock (&cache_lock);
670 } /* int rrd_write */
672 static int rrd_config (const char *key, const char *value)
674 if (strcasecmp ("CacheTimeout", key) == 0)
676 int tmp = atoi (value);
679 fprintf (stderr, "rrdtool: `CacheTimeout' must "
680 "be greater than 0.\n");
685 else if (strcasecmp ("CacheFlush", key) == 0)
687 int tmp = atoi (value);
690 fprintf (stderr, "rrdtool: `CacheFlush' must "
691 "be greater than 0.\n");
694 cache_flush_timeout = tmp;
696 else if (strcasecmp ("DataDir", key) == 0)
700 datadir = strdup (value);
703 int len = strlen (datadir);
704 while ((len > 0) && (datadir[len - 1] == '/'))
716 else if (strcasecmp ("StepSize", key) == 0)
718 int tmp = atoi (value);
721 fprintf (stderr, "rrdtool: `StepSize' must "
722 "be greater than 0.\n");
727 else if (strcasecmp ("HeartBeat", key) == 0)
729 int tmp = atoi (value);
732 fprintf (stderr, "rrdtool: `HeartBeat' must "
733 "be greater than 0.\n");
738 else if (strcasecmp ("RRARows", key) == 0)
740 int tmp = atoi (value);
743 fprintf (stderr, "rrdtool: `RRARows' must "
744 "be greater than 0.\n");
749 else if (strcasecmp ("XFF", key) == 0)
751 double tmp = atof (value);
752 if ((tmp < 0.0) || (tmp >= 1.0))
754 fprintf (stderr, "rrdtool: `XFF' must "
755 "be in the range 0 to 1 (exclusive).");
765 } /* int rrd_config */
767 static int rrd_shutdown (void)
769 pthread_mutex_lock (&cache_lock);
770 rrd_cache_flush (-1);
774 pthread_mutex_unlock (&cache_lock);
777 } /* int rrd_shutdown */
779 static int rrd_init (void)
782 stepsize = interval_g;
784 heartbeat = 2 * interval_g;
786 if (heartbeat < interval_g)
787 WARNING ("rrdtool plugin: Your `heartbeat' is "
788 "smaller than your `interval'. This will "
789 "likely cause problems.");
790 else if (stepsize < interval_g)
791 WARNING ("rrdtool plugin: Your `stepsize' is "
792 "smaller than your `interval'. This will "
793 "create needlessly big RRD-files.");
795 pthread_mutex_lock (&cache_lock);
796 if (cache_timeout < 2)
799 cache_flush_timeout = 0;
803 if (cache_flush_timeout < cache_timeout)
804 cache_flush_timeout = 10 * cache_timeout;
806 cache = avl_create ((int (*) (const void *, const void *)) strcmp);
807 cache_flush_last = time (NULL);
808 plugin_register_shutdown ("rrdtool", rrd_shutdown);
810 pthread_mutex_unlock (&cache_lock);
812 DEBUG ("rrdtool plugin: rrd_init: datadir = %s; stepsize = %i;"
813 " heartbeat = %i; rrarows = %i; xff = %lf;",
814 (datadir == NULL) ? "(null)" : datadir,
815 stepsize, heartbeat, rrarows, xff);
820 void module_register (modreg_e load)
822 plugin_register_config ("rrdtool", rrd_config,
823 config_keys, config_keys_num);
824 plugin_register_init ("rrdtool", rrd_init);
825 plugin_register_write ("rrdtool", rrd_write);