2 * collectd - src/rrdtool.c
3 * Copyright (C) 2006,2007 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"
41 typedef struct rrd_cache_s rrd_cache_t;
46 static int rra_timespans[] =
54 static int rra_timespans_num = STATIC_ARRAY_SIZE (rra_timespans);
56 static int *rra_timespans_custom = NULL;
57 static int rra_timespans_custom_num = 0;
59 static char *rra_types[] =
65 static int rra_types_num = STATIC_ARRAY_SIZE (rra_types);
67 static const char *config_keys[] =
78 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
80 static char *datadir = NULL;
81 static int stepsize = 0;
82 static int heartbeat = 0;
83 static int rrarows = 1200;
84 static double xff = 0.1;
86 static int cache_timeout = 0;
87 static int cache_flush_timeout = 0;
88 static time_t cache_flush_last;
89 static avl_tree_t *cache = NULL;
90 static pthread_mutex_t cache_lock = PTHREAD_MUTEX_INITIALIZER;
95 static int rra_get (char ***ret)
97 static char **rra_def = NULL;
98 static int rra_num = 0;
113 if ((rra_num != 0) && (rra_def != NULL))
119 /* Use the configured timespans or fall back to the built-in defaults */
120 if (rra_timespans_custom_num != 0)
122 rts = rra_timespans_custom;
123 rts_num = rra_timespans_custom_num;
128 rts_num = rra_timespans_num;
131 rra_max = rts_num * rra_types_num;
133 if ((rra_def = (char **) malloc ((rra_max + 1) * sizeof (char *))) == NULL)
135 memset (rra_def, '\0', (rra_max + 1) * sizeof (char *));
137 if ((stepsize <= 0) || (rrarows <= 0))
144 for (i = 0; i < rts_num; i++)
148 if ((span / stepsize) < rrarows)
154 cdp_len = (int) floor (((double) span)
155 / ((double) (rrarows * stepsize)));
157 cdp_num = (int) ceil (((double) span)
158 / ((double) (cdp_len * stepsize)));
160 for (j = 0; j < rra_types_num; j++)
162 if (rra_num >= rra_max)
165 if (snprintf (buffer, sizeof (buffer), "RRA:%s:%3.1f:%u:%u",
167 cdp_len, cdp_num) >= sizeof (buffer))
169 ERROR ("rra_get: Buffer would have been truncated.");
173 rra_def[rra_num++] = sstrdup (buffer);
178 DEBUG ("rra_num = %i", rra_num);
179 for (i = 0; i < rra_num; i++)
180 DEBUG (" %s", rra_def[i]);
187 static void ds_free (int ds_num, char **ds_def)
191 for (i = 0; i < ds_num; i++)
192 if (ds_def[i] != NULL)
197 static int ds_get (char ***ret, const data_set_t *ds)
206 DEBUG ("ds->ds_num = %i", ds->ds_num);
208 ds_def = (char **) malloc (ds->ds_num * sizeof (char *));
212 ERROR ("rrdtool plugin: malloc failed: %s",
213 sstrerror (errno, errbuf, sizeof (errbuf)));
216 memset (ds_def, '\0', ds->ds_num * sizeof (char *));
218 for (ds_num = 0; ds_num < ds->ds_num; ds_num++)
220 data_source_t *d = ds->ds + ds_num;
224 ds_def[ds_num] = NULL;
226 if (d->type == DS_TYPE_COUNTER)
228 else if (d->type == DS_TYPE_GAUGE)
232 ERROR ("rrdtool plugin: Unknown DS type: %i",
243 snprintf (min, sizeof (min), "%lf", d->min);
244 min[sizeof (min) - 1] = '\0';
253 snprintf (max, sizeof (max), "%lf", d->max);
254 max[sizeof (max) - 1] = '\0';
257 status = snprintf (buffer, sizeof (buffer),
259 d->name, type, heartbeat,
261 if ((status < 1) || (status >= sizeof (buffer)))
264 ds_def[ds_num] = sstrdup (buffer);
265 } /* for ds_num = 0 .. ds->ds_num */
270 DEBUG ("ds_num = %i", ds_num);
271 for (i = 0; i < ds_num; i++)
272 DEBUG (" %s", ds_def[i]);
276 if (ds_num != ds->ds_num)
278 ds_free (ds_num, ds_def);
286 static int rrd_create_file (char *filename, const data_set_t *ds, const value_list_t *vl)
295 char stepsize_str[16];
299 if (check_create_dir (filename))
302 if ((rra_num = rra_get (&rra_def)) < 1)
304 ERROR ("rrd_create_file failed: Could not calculate RRAs");
308 if ((ds_num = ds_get (&ds_def, ds)) < 1)
310 ERROR ("rrd_create_file failed: Could not calculate DSes");
314 argc = ds_num + rra_num + 6;
316 if ((argv = (char **) malloc (sizeof (char *) * (argc + 1))) == NULL)
319 ERROR ("rrd_create failed: %s",
320 sstrerror (errno, errbuf, sizeof (errbuf)));
324 status = snprintf (stepsize_str, sizeof (stepsize_str),
326 if ((status < 1) || (status >= sizeof (stepsize_str)))
328 ERROR ("rrdtool plugin: snprintf failed.");
332 assert (vl->time > 10);
333 status = snprintf (begin_str, sizeof (begin_str),
334 "%llu", (unsigned long long) (vl->time - 10));
335 if ((status < 1) || (status >= sizeof (begin_str)))
337 ERROR ("rrdtool plugin: snprintf failed.");
346 argv[5] = stepsize_str;
349 for (i = 0; i < ds_num; i++)
350 argv[j++] = ds_def[i];
351 for (i = 0; i < rra_num; i++)
352 argv[j++] = rra_def[i];
355 optind = 0; /* bug in librrd? */
357 if (rrd_create (argc, argv) == -1)
359 ERROR ("rrd_create failed: %s: %s", filename, rrd_get_error ());
364 ds_free (ds_num, ds_def);
369 static int value_list_to_string (char *buffer, int buffer_len,
370 const data_set_t *ds, const value_list_t *vl)
376 memset (buffer, '\0', buffer_len);
378 status = snprintf (buffer, buffer_len, "%u", (unsigned int) vl->time);
379 if ((status < 1) || (status >= buffer_len))
383 for (i = 0; i < ds->ds_num; i++)
385 if ((ds->ds[i].type != DS_TYPE_COUNTER)
386 && (ds->ds[i].type != DS_TYPE_GAUGE))
389 if (ds->ds[i].type == DS_TYPE_COUNTER)
390 status = snprintf (buffer + offset, buffer_len - offset,
391 ":%llu", vl->values[i].counter);
393 status = snprintf (buffer + offset, buffer_len - offset,
394 ":%lf", vl->values[i].gauge);
396 if ((status < 1) || (status >= (buffer_len - offset)))
400 } /* for ds->ds_num */
403 } /* int value_list_to_string */
405 static int value_list_to_filename (char *buffer, int buffer_len,
406 const data_set_t *ds, const value_list_t *vl)
413 status = snprintf (buffer + offset, buffer_len - offset,
415 if ((status < 1) || (status >= buffer_len - offset))
420 status = snprintf (buffer + offset, buffer_len - offset,
422 if ((status < 1) || (status >= buffer_len - offset))
426 if (strlen (vl->plugin_instance) > 0)
427 status = snprintf (buffer + offset, buffer_len - offset,
428 "%s-%s/", vl->plugin, vl->plugin_instance);
430 status = snprintf (buffer + offset, buffer_len - offset,
432 if ((status < 1) || (status >= buffer_len - offset))
436 if (strlen (vl->type_instance) > 0)
437 status = snprintf (buffer + offset, buffer_len - offset,
438 "%s-%s.rrd", ds->type, vl->type_instance);
440 status = snprintf (buffer + offset, buffer_len - offset,
442 if ((status < 1) || (status >= buffer_len - offset))
447 } /* int value_list_to_filename */
449 static rrd_cache_t *rrd_cache_insert (const char *filename,
450 const char *value, time_t value_time)
452 rrd_cache_t *rc = NULL;
456 avl_get (cache, filename, (void *) &rc);
460 rc = (rrd_cache_t *) malloc (sizeof (rrd_cache_t));
470 if (rc->last_value >= value_time)
472 WARNING ("rrdtool plugin: (rc->last_value = %u) >= (value_time = %u)",
473 (unsigned int) rc->last_value,
474 (unsigned int) value_time);
478 rc->values = (char **) realloc ((void *) rc->values,
479 (rc->values_num + 1) * sizeof (char *));
480 if (rc->values == NULL)
483 ERROR ("rrdtool plugin: realloc failed: %s",
484 sstrerror (errno, errbuf, sizeof (errbuf)));
487 void *cache_key = NULL;
488 avl_remove (cache, filename, &cache_key, NULL);
495 rc->values[rc->values_num] = strdup (value);
496 if (rc->values[rc->values_num] != NULL)
499 if (rc->values_num == 1)
500 rc->first_value = value_time;
501 rc->last_value = value_time;
503 /* Insert if this is the first value */
504 if ((cache != NULL) && (new_rc == 1))
506 void *cache_key = strdup (filename);
508 if (cache_key == NULL)
511 ERROR ("rrdtool plugin: strdup failed: %s",
512 sstrerror (errno, errbuf, sizeof (errbuf)));
513 sfree (rc->values[0]);
519 avl_insert (cache, cache_key, rc);
522 DEBUG ("rrd_cache_insert (%s, %s, %u) = %p", filename, value,
523 (unsigned int) value_time, (void *) rc);
526 } /* rrd_cache_t *rrd_cache_insert */
528 static int rrd_write_cache_entry (const char *filename, rrd_cache_t *rc)
538 if (rc->values_num < 1)
541 argc = rc->values_num + 2;
542 argv = (char **) malloc ((argc + 1) * sizeof (char *));
546 fn = strdup (filename);
555 memcpy (argv + 2, rc->values, rc->values_num * sizeof (char *));
558 DEBUG ("rrd_update (argc = %i, argv = %p)", argc, (void *) argv);
560 optind = 0; /* bug in librrd? */
562 status = rrd_update (argc, argv);
565 WARNING ("rrd_update failed: %s: %s",
566 filename, rrd_get_error ());
572 /* Free the value list of `rc' */
573 for (i = 0; i < rc->values_num; i++)
574 free (rc->values[i]);
580 } /* int rrd_write_cache_entry */
582 static void rrd_cache_flush (int timeout)
591 avl_iterator_t *iter;
597 DEBUG ("Flushing cache, timeout = %i", timeout);
601 /* Build a list of entries to be flushed */
602 iter = avl_get_iterator (cache);
603 while (avl_iterator_next (iter, (void *) &key, (void *) &rc) == 0)
605 DEBUG ("key = %s; age = %i;", key, now - rc->first_value);
606 if ((now - rc->first_value) >= timeout)
608 keys = (char **) realloc ((void *) keys,
609 (keys_num + 1) * sizeof (char *));
613 ERROR ("rrdtool plugin: "
614 "realloc failed: %s",
615 sstrerror (errno, errbuf,
617 avl_iterator_destroy (iter);
620 keys[keys_num] = key;
623 } /* while (avl_iterator_next) */
624 avl_iterator_destroy (iter);
626 for (i = 0; i < keys_num; i++)
628 if (avl_remove (cache, keys[i], (void *) &key, (void *) &rc) != 0)
630 DEBUG ("avl_remove (%s) failed.", keys[i]);
634 rrd_write_cache_entry (keys[i], rc);
635 /* rc's value-list is free's by `rrd_write_cache_entry' */
639 } /* for (i = 0..keys_num) */
642 DEBUG ("Flushed %i value(s)", keys_num);
644 cache_flush_last = now;
645 } /* void rrd_cache_flush */
647 static int rrd_write (const data_set_t *ds, const value_list_t *vl)
655 if (value_list_to_filename (filename, sizeof (filename), ds, vl) != 0)
658 if (value_list_to_string (values, sizeof (values), ds, vl) != 0)
661 if (stat (filename, &statbuf) == -1)
665 if (rrd_create_file (filename, ds, vl))
671 ERROR ("stat(%s) failed: %s", filename,
672 sstrerror (errno, errbuf,
677 else if (!S_ISREG (statbuf.st_mode))
679 ERROR ("stat(%s): Not a regular file!",
684 pthread_mutex_lock (&cache_lock);
685 rc = rrd_cache_insert (filename, values, vl->time);
688 pthread_mutex_unlock (&cache_lock);
694 rrd_write_cache_entry (filename, rc);
695 /* rc's value-list is free's by `rrd_write_cache_entry' */
697 pthread_mutex_unlock (&cache_lock);
703 DEBUG ("age (%s) = %i", filename, now - rc->first_value);
705 /* `rc' is not free'd here, because we'll likely reuse it. If not, then
706 * the next flush will remove this entry. */
707 if ((now - rc->first_value) >= cache_timeout)
708 rrd_write_cache_entry (filename, rc);
710 if ((now - cache_flush_last) >= cache_flush_timeout)
711 rrd_cache_flush (cache_flush_timeout);
713 pthread_mutex_unlock (&cache_lock);
715 } /* int rrd_write */
717 static int rrd_config (const char *key, const char *value)
719 if (strcasecmp ("CacheTimeout", key) == 0)
721 int tmp = atoi (value);
724 fprintf (stderr, "rrdtool: `CacheTimeout' must "
725 "be greater than 0.\n");
730 else if (strcasecmp ("CacheFlush", key) == 0)
732 int tmp = atoi (value);
735 fprintf (stderr, "rrdtool: `CacheFlush' must "
736 "be greater than 0.\n");
739 cache_flush_timeout = tmp;
741 else if (strcasecmp ("DataDir", key) == 0)
745 datadir = strdup (value);
748 int len = strlen (datadir);
749 while ((len > 0) && (datadir[len - 1] == '/'))
761 else if (strcasecmp ("StepSize", key) == 0)
763 int tmp = atoi (value);
766 fprintf (stderr, "rrdtool: `StepSize' must "
767 "be greater than 0.\n");
772 else if (strcasecmp ("HeartBeat", key) == 0)
774 int tmp = atoi (value);
777 fprintf (stderr, "rrdtool: `HeartBeat' must "
778 "be greater than 0.\n");
783 else if (strcasecmp ("RRARows", key) == 0)
785 int tmp = atoi (value);
788 fprintf (stderr, "rrdtool: `RRARows' must "
789 "be greater than 0.\n");
794 else if (strcasecmp ("RRATimespan", key) == 0)
796 char *saveptr = NULL;
802 value_copy = strdup (value);
803 if (value_copy == NULL)
807 while ((ptr = strtok_r (dummy, ", \t", &saveptr)) != NULL)
811 tmp_alloc = realloc (rra_timespans_custom,
812 sizeof (int) * (rra_timespans_custom_num + 1));
813 if (tmp_alloc == NULL)
815 fprintf (stderr, "rrdtool: realloc failed.\n");
819 rra_timespans_custom = tmp_alloc;
820 rra_timespans_custom[rra_timespans_custom_num] = atoi (ptr);
821 if (rra_timespans_custom[rra_timespans_custom_num] != 0)
822 rra_timespans_custom_num++;
823 } /* while (strtok_r) */
826 else if (strcasecmp ("XFF", key) == 0)
828 double tmp = atof (value);
829 if ((tmp < 0.0) || (tmp >= 1.0))
831 fprintf (stderr, "rrdtool: `XFF' must "
832 "be in the range 0 to 1 (exclusive).");
842 } /* int rrd_config */
844 static int rrd_shutdown (void)
846 pthread_mutex_lock (&cache_lock);
847 rrd_cache_flush (-1);
851 pthread_mutex_unlock (&cache_lock);
854 } /* int rrd_shutdown */
856 static int rrd_init (void)
859 stepsize = interval_g;
861 heartbeat = 2 * interval_g;
863 if (heartbeat < interval_g)
864 WARNING ("rrdtool plugin: Your `heartbeat' is "
865 "smaller than your `interval'. This will "
866 "likely cause problems.");
867 else if (stepsize < interval_g)
868 WARNING ("rrdtool plugin: Your `stepsize' is "
869 "smaller than your `interval'. This will "
870 "create needlessly big RRD-files.");
872 pthread_mutex_lock (&cache_lock);
873 if (cache_timeout < 2)
876 cache_flush_timeout = 0;
880 if (cache_flush_timeout < cache_timeout)
881 cache_flush_timeout = 10 * cache_timeout;
883 cache = avl_create ((int (*) (const void *, const void *)) strcmp);
884 cache_flush_last = time (NULL);
885 plugin_register_shutdown ("rrdtool", rrd_shutdown);
887 pthread_mutex_unlock (&cache_lock);
889 DEBUG ("rrdtool plugin: rrd_init: datadir = %s; stepsize = %i;"
890 " heartbeat = %i; rrarows = %i; xff = %lf;",
891 (datadir == NULL) ? "(null)" : datadir,
892 stepsize, heartbeat, rrarows, xff);
897 void module_register (void)
899 plugin_register_config ("rrdtool", rrd_config,
900 config_keys, config_keys_num);
901 plugin_register_init ("rrdtool", rrd_init);
902 plugin_register_write ("rrdtool", rrd_write);