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)
295 char stepsize_str[16];
298 if (check_create_dir (filename))
301 if ((rra_num = rra_get (&rra_def)) < 1)
303 ERROR ("rrd_create_file failed: Could not calculate RRAs");
307 if ((ds_num = ds_get (&ds_def, ds)) < 1)
309 ERROR ("rrd_create_file failed: Could not calculate DSes");
313 argc = ds_num + rra_num + 4;
315 if ((argv = (char **) malloc (sizeof (char *) * (argc + 1))) == NULL)
318 ERROR ("rrd_create failed: %s",
319 sstrerror (errno, errbuf, sizeof (errbuf)));
323 status = snprintf (stepsize_str, sizeof (stepsize_str),
325 if ((status < 1) || (status >= sizeof (stepsize_str)))
327 ERROR ("rrdtool plugin: snprintf failed.");
334 argv[3] = stepsize_str;
337 for (i = 0; i < ds_num; i++)
338 argv[j++] = ds_def[i];
339 for (i = 0; i < rra_num; i++)
340 argv[j++] = rra_def[i];
343 optind = 0; /* bug in librrd? */
345 if (rrd_create (argc, argv) == -1)
347 ERROR ("rrd_create failed: %s: %s", filename, rrd_get_error ());
352 ds_free (ds_num, ds_def);
357 static int value_list_to_string (char *buffer, int buffer_len,
358 const data_set_t *ds, const value_list_t *vl)
364 memset (buffer, '\0', sizeof (buffer_len));
366 status = snprintf (buffer, buffer_len, "%u", (unsigned int) vl->time);
367 if ((status < 1) || (status >= buffer_len))
371 for (i = 0; i < ds->ds_num; i++)
373 if ((ds->ds[i].type != DS_TYPE_COUNTER)
374 && (ds->ds[i].type != DS_TYPE_GAUGE))
377 if (ds->ds[i].type == DS_TYPE_COUNTER)
378 status = snprintf (buffer + offset, buffer_len - offset,
379 ":%llu", vl->values[i].counter);
381 status = snprintf (buffer + offset, buffer_len - offset,
382 ":%lf", vl->values[i].gauge);
384 if ((status < 1) || (status >= (buffer_len - offset)))
388 } /* for ds->ds_num */
391 } /* int value_list_to_string */
393 static int value_list_to_filename (char *buffer, int buffer_len,
394 const data_set_t *ds, const value_list_t *vl)
401 status = snprintf (buffer + offset, buffer_len - offset,
403 if ((status < 1) || (status >= buffer_len - offset))
408 status = snprintf (buffer + offset, buffer_len - offset,
410 if ((status < 1) || (status >= buffer_len - offset))
414 if (strlen (vl->plugin_instance) > 0)
415 status = snprintf (buffer + offset, buffer_len - offset,
416 "%s-%s/", vl->plugin, vl->plugin_instance);
418 status = snprintf (buffer + offset, buffer_len - offset,
420 if ((status < 1) || (status >= buffer_len - offset))
424 if (strlen (vl->type_instance) > 0)
425 status = snprintf (buffer + offset, buffer_len - offset,
426 "%s-%s.rrd", ds->type, vl->type_instance);
428 status = snprintf (buffer + offset, buffer_len - offset,
430 if ((status < 1) || (status >= buffer_len - offset))
435 } /* int value_list_to_filename */
437 static rrd_cache_t *rrd_cache_insert (const char *filename,
438 const char *value, time_t value_time)
440 rrd_cache_t *rc = NULL;
444 avl_get (cache, filename, (void *) &rc);
448 rc = (rrd_cache_t *) malloc (sizeof (rrd_cache_t));
458 if (rc->last_value >= value_time)
460 WARNING ("rrdtool plugin: (rc->last_value = %u) >= (value_time = %u)",
461 (unsigned int) rc->last_value,
462 (unsigned int) value_time);
466 rc->values = (char **) realloc ((void *) rc->values,
467 (rc->values_num + 1) * sizeof (char *));
468 if (rc->values == NULL)
471 ERROR ("rrdtool plugin: realloc failed: %s",
472 sstrerror (errno, errbuf, sizeof (errbuf)));
475 void *cache_key = NULL;
476 avl_remove (cache, filename, &cache_key, NULL);
483 rc->values[rc->values_num] = strdup (value);
484 if (rc->values[rc->values_num] != NULL)
487 if (rc->values_num == 1)
488 rc->first_value = value_time;
489 rc->last_value = value_time;
491 /* Insert if this is the first value */
492 if ((cache != NULL) && (new_rc == 1))
494 void *cache_key = strdup (filename);
496 if (cache_key == NULL)
499 ERROR ("rrdtool plugin: strdup failed: %s",
500 sstrerror (errno, errbuf, sizeof (errbuf)));
501 sfree (rc->values[0]);
507 avl_insert (cache, cache_key, rc);
510 DEBUG ("rrd_cache_insert (%s, %s, %u) = %p", filename, value,
511 (unsigned int) value_time, (void *) rc);
514 } /* rrd_cache_t *rrd_cache_insert */
516 static int rrd_write_cache_entry (const char *filename, rrd_cache_t *rc)
526 if (rc->values_num < 1)
529 argc = rc->values_num + 2;
530 argv = (char **) malloc ((argc + 1) * sizeof (char *));
534 fn = strdup (filename);
543 memcpy (argv + 2, rc->values, rc->values_num * sizeof (char *));
546 DEBUG ("rrd_update (argc = %i, argv = %p)", argc, (void *) argv);
548 optind = 0; /* bug in librrd? */
550 status = rrd_update (argc, argv);
553 WARNING ("rrd_update failed: %s: %s",
554 filename, rrd_get_error ());
560 /* Free the value list of `rc' */
561 for (i = 0; i < rc->values_num; i++)
562 free (rc->values[i]);
568 } /* int rrd_write_cache_entry */
570 static void rrd_cache_flush (int timeout)
579 avl_iterator_t *iter;
585 DEBUG ("Flushing cache, timeout = %i", timeout);
589 /* Build a list of entries to be flushed */
590 iter = avl_get_iterator (cache);
591 while (avl_iterator_next (iter, (void *) &key, (void *) &rc) == 0)
593 DEBUG ("key = %s; age = %i;", key, now - rc->first_value);
594 if ((now - rc->first_value) >= timeout)
596 keys = (char **) realloc ((void *) keys,
597 (keys_num + 1) * sizeof (char *));
601 ERROR ("rrdtool plugin: "
602 "realloc failed: %s",
603 sstrerror (errno, errbuf,
605 avl_iterator_destroy (iter);
608 keys[keys_num] = key;
611 } /* while (avl_iterator_next) */
612 avl_iterator_destroy (iter);
614 for (i = 0; i < keys_num; i++)
616 if (avl_remove (cache, keys[i], (void *) &key, (void *) &rc) != 0)
618 DEBUG ("avl_remove (%s) failed.", keys[i]);
622 rrd_write_cache_entry (keys[i], rc);
623 /* rc's value-list is free's by `rrd_write_cache_entry' */
627 } /* for (i = 0..keys_num) */
630 DEBUG ("Flushed %i value(s)", keys_num);
632 cache_flush_last = now;
633 } /* void rrd_cache_flush */
635 static int rrd_write (const data_set_t *ds, const value_list_t *vl)
643 if (value_list_to_filename (filename, sizeof (filename), ds, vl) != 0)
646 if (value_list_to_string (values, sizeof (values), ds, vl) != 0)
649 if (stat (filename, &statbuf) == -1)
653 if (rrd_create_file (filename, ds))
659 ERROR ("stat(%s) failed: %s", filename,
660 sstrerror (errno, errbuf,
665 else if (!S_ISREG (statbuf.st_mode))
667 ERROR ("stat(%s): Not a regular file!",
672 pthread_mutex_lock (&cache_lock);
673 rc = rrd_cache_insert (filename, values, vl->time);
676 pthread_mutex_unlock (&cache_lock);
682 rrd_write_cache_entry (filename, rc);
683 /* rc's value-list is free's by `rrd_write_cache_entry' */
685 pthread_mutex_unlock (&cache_lock);
691 DEBUG ("age (%s) = %i", filename, now - rc->first_value);
693 /* `rc' is not free'd here, because we'll likely reuse it. If not, then
694 * the next flush will remove this entry. */
695 if ((now - rc->first_value) >= cache_timeout)
696 rrd_write_cache_entry (filename, rc);
698 if ((now - cache_flush_last) >= cache_flush_timeout)
699 rrd_cache_flush (cache_flush_timeout);
701 pthread_mutex_unlock (&cache_lock);
703 } /* int rrd_write */
705 static int rrd_config (const char *key, const char *value)
707 if (strcasecmp ("CacheTimeout", key) == 0)
709 int tmp = atoi (value);
712 fprintf (stderr, "rrdtool: `CacheTimeout' must "
713 "be greater than 0.\n");
718 else if (strcasecmp ("CacheFlush", key) == 0)
720 int tmp = atoi (value);
723 fprintf (stderr, "rrdtool: `CacheFlush' must "
724 "be greater than 0.\n");
727 cache_flush_timeout = tmp;
729 else if (strcasecmp ("DataDir", key) == 0)
733 datadir = strdup (value);
736 int len = strlen (datadir);
737 while ((len > 0) && (datadir[len - 1] == '/'))
749 else if (strcasecmp ("StepSize", key) == 0)
751 int tmp = atoi (value);
754 fprintf (stderr, "rrdtool: `StepSize' must "
755 "be greater than 0.\n");
760 else if (strcasecmp ("HeartBeat", key) == 0)
762 int tmp = atoi (value);
765 fprintf (stderr, "rrdtool: `HeartBeat' must "
766 "be greater than 0.\n");
771 else if (strcasecmp ("RRARows", key) == 0)
773 int tmp = atoi (value);
776 fprintf (stderr, "rrdtool: `RRARows' must "
777 "be greater than 0.\n");
782 else if (strcasecmp ("RRATimespan", key) == 0)
784 char *saveptr = NULL;
790 value_copy = strdup (value);
791 if (value_copy == NULL)
795 while ((ptr = strtok_r (dummy, ", \t", &saveptr)) != NULL)
799 tmp_alloc = realloc (rra_timespans_custom,
800 sizeof (int) * (rra_timespans_custom_num + 1));
801 if (tmp_alloc == NULL)
803 fprintf (stderr, "rrdtool: realloc failed.\n");
807 rra_timespans_custom = tmp_alloc;
808 rra_timespans_custom[rra_timespans_custom_num] = atoi (ptr);
809 if (rra_timespans_custom[rra_timespans_custom_num] != 0)
810 rra_timespans_custom_num++;
811 } /* while (strtok_r) */
814 else if (strcasecmp ("XFF", key) == 0)
816 double tmp = atof (value);
817 if ((tmp < 0.0) || (tmp >= 1.0))
819 fprintf (stderr, "rrdtool: `XFF' must "
820 "be in the range 0 to 1 (exclusive).");
830 } /* int rrd_config */
832 static int rrd_shutdown (void)
834 pthread_mutex_lock (&cache_lock);
835 rrd_cache_flush (-1);
839 pthread_mutex_unlock (&cache_lock);
842 } /* int rrd_shutdown */
844 static int rrd_init (void)
847 stepsize = interval_g;
849 heartbeat = 2 * interval_g;
851 if (heartbeat < interval_g)
852 WARNING ("rrdtool plugin: Your `heartbeat' is "
853 "smaller than your `interval'. This will "
854 "likely cause problems.");
855 else if (stepsize < interval_g)
856 WARNING ("rrdtool plugin: Your `stepsize' is "
857 "smaller than your `interval'. This will "
858 "create needlessly big RRD-files.");
860 pthread_mutex_lock (&cache_lock);
861 if (cache_timeout < 2)
864 cache_flush_timeout = 0;
868 if (cache_flush_timeout < cache_timeout)
869 cache_flush_timeout = 10 * cache_timeout;
871 cache = avl_create ((int (*) (const void *, const void *)) strcmp);
872 cache_flush_last = time (NULL);
873 plugin_register_shutdown ("rrdtool", rrd_shutdown);
875 pthread_mutex_unlock (&cache_lock);
877 DEBUG ("rrdtool plugin: rrd_init: datadir = %s; stepsize = %i;"
878 " heartbeat = %i; rrarows = %i; xff = %lf;",
879 (datadir == NULL) ? "(null)" : datadir,
880 stepsize, heartbeat, rrarows, xff);
885 void module_register (void)
887 plugin_register_config ("rrdtool", rrd_config,
888 config_keys, config_keys_num);
889 plugin_register_init ("rrdtool", rrd_init);
890 plugin_register_write ("rrdtool", rrd_write);