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"
46 typedef struct rrd_cache_s rrd_cache_t;
51 struct rrd_queue_s *next;
53 typedef struct rrd_queue_s rrd_queue_t;
58 static int rra_timespans[] =
66 static int rra_timespans_num = STATIC_ARRAY_SIZE (rra_timespans);
68 static int *rra_timespans_custom = NULL;
69 static int rra_timespans_custom_num = 0;
71 static char *rra_types[] =
77 static int rra_types_num = STATIC_ARRAY_SIZE (rra_types);
79 static const char *config_keys[] =
90 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
92 /* If datadir is zero, the daemon's basedir is used. If stepsize or heartbeat
93 * is zero a default, depending on the `interval' member of the value list is
95 static char *datadir = NULL;
96 static int stepsize = 0;
97 static int heartbeat = 0;
98 static int rrarows = 1200;
99 static double xff = 0.1;
101 /* XXX: If you need to lock both, cache_lock and queue_lock, at the same time,
102 * ALWAYS lock `cache_lock' first! */
103 static int cache_timeout = 0;
104 static int cache_flush_timeout = 0;
105 static time_t cache_flush_last;
106 static avl_tree_t *cache = NULL;
107 static pthread_mutex_t cache_lock = PTHREAD_MUTEX_INITIALIZER;
109 static rrd_queue_t *queue_head = NULL;
110 static rrd_queue_t *queue_tail = NULL;
111 static pthread_t queue_thread = 0;
112 static pthread_mutex_t queue_lock = PTHREAD_MUTEX_INITIALIZER;
113 static pthread_cond_t queue_cond = PTHREAD_COND_INITIALIZER;
115 static int do_shutdown = 0;
121 static void rra_free (int rra_num, char **rra_def)
125 for (i = 0; i < rra_num; i++)
130 } /* void rra_free */
132 static int rra_get (char ***ret, const value_list_t *vl)
150 /* The stepsize we use here: If it is user-set, use it. If not, use the
151 * interval of the value-list. */
160 ss = (stepsize > 0) ? stepsize : vl->interval;
167 /* Use the configured timespans or fall back to the built-in defaults */
168 if (rra_timespans_custom_num != 0)
170 rts = rra_timespans_custom;
171 rts_num = rra_timespans_custom_num;
176 rts_num = rra_timespans_num;
179 rra_max = rts_num * rra_types_num;
181 if ((rra_def = (char **) malloc ((rra_max + 1) * sizeof (char *))) == NULL)
183 memset (rra_def, '\0', (rra_max + 1) * sizeof (char *));
187 for (i = 0; i < rts_num; i++)
191 if ((span / ss) < rrarows)
197 cdp_len = (int) floor (((double) span)
198 / ((double) (rrarows * ss)));
200 cdp_num = (int) ceil (((double) span)
201 / ((double) (cdp_len * ss)));
203 for (j = 0; j < rra_types_num; j++)
205 if (rra_num >= rra_max)
208 if (snprintf (buffer, sizeof (buffer), "RRA:%s:%3.1f:%u:%u",
210 cdp_len, cdp_num) >= sizeof (buffer))
212 ERROR ("rra_get: Buffer would have been truncated.");
216 rra_def[rra_num++] = sstrdup (buffer);
221 DEBUG ("rra_num = %i", rra_num);
222 for (i = 0; i < rra_num; i++)
223 DEBUG (" %s", rra_def[i]);
230 static void ds_free (int ds_num, char **ds_def)
234 for (i = 0; i < ds_num; i++)
235 if (ds_def[i] != NULL)
240 static int ds_get (char ***ret, const data_set_t *ds, const value_list_t *vl)
249 DEBUG ("ds->ds_num = %i", ds->ds_num);
251 ds_def = (char **) malloc (ds->ds_num * sizeof (char *));
255 ERROR ("rrdtool plugin: malloc failed: %s",
256 sstrerror (errno, errbuf, sizeof (errbuf)));
259 memset (ds_def, '\0', ds->ds_num * sizeof (char *));
261 for (ds_num = 0; ds_num < ds->ds_num; ds_num++)
263 data_source_t *d = ds->ds + ds_num;
267 ds_def[ds_num] = NULL;
269 if (d->type == DS_TYPE_COUNTER)
271 else if (d->type == DS_TYPE_GAUGE)
275 ERROR ("rrdtool plugin: Unknown DS type: %i",
286 snprintf (min, sizeof (min), "%lf", d->min);
287 min[sizeof (min) - 1] = '\0';
296 snprintf (max, sizeof (max), "%lf", d->max);
297 max[sizeof (max) - 1] = '\0';
300 status = snprintf (buffer, sizeof (buffer),
303 (heartbeat > 0) ? heartbeat : (2 * vl->interval),
305 if ((status < 1) || (status >= sizeof (buffer)))
308 ds_def[ds_num] = sstrdup (buffer);
309 } /* for ds_num = 0 .. ds->ds_num */
314 DEBUG ("ds_num = %i", ds_num);
315 for (i = 0; i < ds_num; i++)
316 DEBUG (" %s", ds_def[i]);
320 if (ds_num != ds->ds_num)
322 ds_free (ds_num, ds_def);
330 static int rrd_create_file (char *filename, const data_set_t *ds, const value_list_t *vl)
339 char stepsize_str[16];
343 if (check_create_dir (filename))
346 if ((rra_num = rra_get (&rra_def, vl)) < 1)
348 ERROR ("rrd_create_file failed: Could not calculate RRAs");
352 if ((ds_num = ds_get (&ds_def, ds, vl)) < 1)
354 ERROR ("rrd_create_file failed: Could not calculate DSes");
358 argc = ds_num + rra_num + 6;
360 if ((argv = (char **) malloc (sizeof (char *) * (argc + 1))) == NULL)
363 ERROR ("rrd_create failed: %s",
364 sstrerror (errno, errbuf, sizeof (errbuf)));
368 status = snprintf (stepsize_str, sizeof (stepsize_str),
369 "%i", (stepsize > 0) ? stepsize : vl->interval);
370 if ((status < 1) || (status >= sizeof (stepsize_str)))
372 ERROR ("rrdtool plugin: snprintf failed.");
374 ds_free (ds_num, ds_def);
375 rra_free (rra_num, rra_def);
379 assert (vl->time > 10);
380 status = snprintf (begin_str, sizeof (begin_str),
381 "%llu", (unsigned long long) (vl->time - 10));
382 if ((status < 1) || (status >= sizeof (begin_str)))
384 ERROR ("rrdtool plugin: snprintf failed.");
393 argv[5] = stepsize_str;
396 for (i = 0; i < ds_num; i++)
397 argv[j++] = ds_def[i];
398 for (i = 0; i < rra_num; i++)
399 argv[j++] = rra_def[i];
402 optind = 0; /* bug in librrd? */
404 if (rrd_create (argc, argv) == -1)
406 ERROR ("rrd_create failed: %s: %s", filename, rrd_get_error ());
411 ds_free (ds_num, ds_def);
412 rra_free (rra_num, rra_def);
417 static int value_list_to_string (char *buffer, int buffer_len,
418 const data_set_t *ds, const value_list_t *vl)
424 memset (buffer, '\0', buffer_len);
426 status = snprintf (buffer, buffer_len, "%u", (unsigned int) vl->time);
427 if ((status < 1) || (status >= buffer_len))
431 for (i = 0; i < ds->ds_num; i++)
433 if ((ds->ds[i].type != DS_TYPE_COUNTER)
434 && (ds->ds[i].type != DS_TYPE_GAUGE))
437 if (ds->ds[i].type == DS_TYPE_COUNTER)
438 status = snprintf (buffer + offset, buffer_len - offset,
439 ":%llu", vl->values[i].counter);
441 status = snprintf (buffer + offset, buffer_len - offset,
442 ":%lf", vl->values[i].gauge);
444 if ((status < 1) || (status >= (buffer_len - offset)))
448 } /* for ds->ds_num */
451 } /* int value_list_to_string */
453 static int value_list_to_filename (char *buffer, int buffer_len,
454 const data_set_t *ds, const value_list_t *vl)
461 status = snprintf (buffer + offset, buffer_len - offset,
463 if ((status < 1) || (status >= buffer_len - offset))
468 status = snprintf (buffer + offset, buffer_len - offset,
470 if ((status < 1) || (status >= buffer_len - offset))
474 if (strlen (vl->plugin_instance) > 0)
475 status = snprintf (buffer + offset, buffer_len - offset,
476 "%s-%s/", vl->plugin, vl->plugin_instance);
478 status = snprintf (buffer + offset, buffer_len - offset,
480 if ((status < 1) || (status >= buffer_len - offset))
484 if (strlen (vl->type_instance) > 0)
485 status = snprintf (buffer + offset, buffer_len - offset,
486 "%s-%s.rrd", ds->type, vl->type_instance);
488 status = snprintf (buffer + offset, buffer_len - offset,
490 if ((status < 1) || (status >= buffer_len - offset))
495 } /* int value_list_to_filename */
497 static int rrd_write_to_file (char *filename, char **values, int values_num)
506 argc = values_num + 2;
507 argv = (char **) malloc ((argc + 1) * sizeof (char *));
513 memcpy (argv + 2, values, values_num * sizeof (char *));
516 DEBUG ("rrd_update (argc = %i, argv = %p)", argc, (void *) argv);
518 optind = 0; /* bug in librrd? */
520 status = rrd_update (argc, argv);
523 WARNING ("rrd_update failed: %s: %s",
524 filename, rrd_get_error ());
531 } /* int rrd_write_cache_entry */
533 static void *rrd_queue_thread (void *data)
537 rrd_queue_t *queue_entry;
538 rrd_cache_t *cache_entry;
543 /* XXX: If you need to lock both, cache_lock and queue_lock, at
544 * the same time, ALWAYS lock `cache_lock' first! */
546 /* wait until an entry is available */
547 pthread_mutex_lock (&queue_lock);
548 while ((queue_head == NULL) && (do_shutdown == 0))
549 pthread_cond_wait (&queue_cond, &queue_lock);
551 /* We're in the shutdown phase */
552 if (queue_head == NULL)
554 pthread_mutex_unlock (&queue_lock);
558 /* Dequeue the first entry */
559 queue_entry = queue_head;
560 if (queue_head == queue_tail)
561 queue_head = queue_tail = NULL;
563 queue_head = queue_head->next;
565 /* Unlock the queue again */
566 pthread_mutex_unlock (&queue_lock);
568 /* We now need the cache lock so the entry isn't updated while
569 * we make a copy of it's values */
570 pthread_mutex_lock (&cache_lock);
572 avl_get (cache, queue_entry->filename, (void *) &cache_entry);
574 values = cache_entry->values;
575 values_num = cache_entry->values_num;
577 cache_entry->values = NULL;
578 cache_entry->values_num = 0;
579 cache_entry->flags = FLAG_NONE;
581 pthread_mutex_unlock (&cache_lock);
583 /* Write the values to the RRD-file */
584 rrd_write_to_file (queue_entry->filename, values, values_num);
586 for (i = 0; i < values_num; i++)
591 sfree (queue_entry->filename);
595 pthread_mutex_lock (&cache_lock);
598 pthread_mutex_unlock (&cache_lock);
600 pthread_exit ((void *) 0);
602 } /* void *rrd_queue_thread */
604 static int rrd_queue_cache_entry (const char *filename)
606 rrd_queue_t *queue_entry;
608 queue_entry = (rrd_queue_t *) malloc (sizeof (rrd_queue_t));
609 if (queue_entry == NULL)
612 queue_entry->filename = strdup (filename);
613 if (queue_entry->filename == NULL)
619 queue_entry->next = NULL;
621 pthread_mutex_lock (&queue_lock);
622 if (queue_tail == NULL)
623 queue_head = queue_entry;
625 queue_tail->next = queue_entry;
626 queue_tail = queue_entry;
627 pthread_cond_signal (&queue_cond);
628 pthread_mutex_unlock (&queue_lock);
630 DEBUG ("rrdtool plugin: Put `%s' into the update queue", filename);
633 } /* int rrd_queue_cache_entry */
635 static void rrd_cache_flush (int timeout)
644 avl_iterator_t *iter;
647 DEBUG ("Flushing cache, timeout = %i", timeout);
651 /* Build a list of entries to be flushed */
652 iter = avl_get_iterator (cache);
653 while (avl_iterator_next (iter, (void *) &key, (void *) &rc) == 0)
655 DEBUG ("key = %s; age = %i;", key, now - rc->first_value);
657 if (rc->flags == FLAG_QUEUED)
659 else if ((now - rc->first_value) < timeout)
661 else if (rc->values_num > 0)
663 if (rrd_queue_cache_entry (key) == 0)
664 rc->flags = FLAG_QUEUED;
666 else /* ancient and no values -> waste of memory */
668 keys = (char **) realloc ((void *) keys,
669 (keys_num + 1) * sizeof (char *));
673 ERROR ("rrdtool plugin: "
674 "realloc failed: %s",
675 sstrerror (errno, errbuf,
677 avl_iterator_destroy (iter);
680 keys[keys_num] = key;
683 } /* while (avl_iterator_next) */
684 avl_iterator_destroy (iter);
686 for (i = 0; i < keys_num; i++)
688 if (avl_remove (cache, keys[i], (void *) &key, (void *) &rc) != 0)
690 DEBUG ("avl_remove (%s) failed.", keys[i]);
694 assert (rc->values == NULL);
695 assert (rc->values_num == 0);
700 } /* for (i = 0..keys_num) */
703 DEBUG ("Flushed %i value(s)", keys_num);
705 cache_flush_last = now;
706 } /* void rrd_cache_flush */
708 static int rrd_cache_insert (const char *filename,
709 const char *value, time_t value_time)
711 rrd_cache_t *rc = NULL;
715 pthread_mutex_lock (&cache_lock);
717 avl_get (cache, filename, (void *) &rc);
721 rc = (rrd_cache_t *) malloc (sizeof (rrd_cache_t));
728 rc->flags = FLAG_NONE;
732 if (rc->last_value >= value_time)
734 pthread_mutex_unlock (&cache_lock);
735 WARNING ("rrdtool plugin: (rc->last_value = %u) >= (value_time = %u)",
736 (unsigned int) rc->last_value,
737 (unsigned int) value_time);
741 values_new = (char **) realloc ((void *) rc->values,
742 (rc->values_num + 1) * sizeof (char *));
743 if (values_new == NULL)
746 void *cache_key = NULL;
748 sstrerror (errno, errbuf, sizeof (errbuf));
750 avl_remove (cache, filename, &cache_key, NULL);
751 pthread_mutex_unlock (&cache_lock);
753 ERROR ("rrdtool plugin: realloc failed: %s", errbuf);
760 rc->values = values_new;
762 rc->values[rc->values_num] = strdup (value);
763 if (rc->values[rc->values_num] != NULL)
766 if (rc->values_num == 1)
767 rc->first_value = value_time;
768 rc->last_value = value_time;
770 /* Insert if this is the first value */
773 void *cache_key = strdup (filename);
775 if (cache_key == NULL)
778 sstrerror (errno, errbuf, sizeof (errbuf));
780 pthread_mutex_unlock (&cache_lock);
782 ERROR ("rrdtool plugin: strdup failed: %s", errbuf);
784 sfree (rc->values[0]);
790 avl_insert (cache, cache_key, rc);
793 DEBUG ("rrd_cache_insert (%s, %s, %u) = %p", filename, value,
794 (unsigned int) value_time, (void *) rc);
796 if ((rc->last_value - rc->first_value) >= cache_timeout)
798 /* XXX: If you need to lock both, cache_lock and queue_lock, at
799 * the same time, ALWAYS lock `cache_lock' first! */
800 if (rc->flags != FLAG_QUEUED)
802 if (rrd_queue_cache_entry (filename) == 0)
803 rc->flags = FLAG_QUEUED;
807 DEBUG ("rrdtool plugin: `%s' is already queued.", filename);
811 if ((cache_timeout > 0) &&
812 ((time (NULL) - cache_flush_last) > cache_flush_timeout))
813 rrd_cache_flush (cache_flush_timeout);
816 pthread_mutex_unlock (&cache_lock);
819 } /* int rrd_cache_insert */
821 static int rrd_write (const data_set_t *ds, const value_list_t *vl)
828 if (value_list_to_filename (filename, sizeof (filename), ds, vl) != 0)
831 if (value_list_to_string (values, sizeof (values), ds, vl) != 0)
834 if (stat (filename, &statbuf) == -1)
838 if (rrd_create_file (filename, ds, vl))
844 ERROR ("stat(%s) failed: %s", filename,
845 sstrerror (errno, errbuf,
850 else if (!S_ISREG (statbuf.st_mode))
852 ERROR ("stat(%s): Not a regular file!",
857 status = rrd_cache_insert (filename, values, vl->time);
860 } /* int rrd_write */
862 static int rrd_config (const char *key, const char *value)
864 if (strcasecmp ("CacheTimeout", key) == 0)
866 int tmp = atoi (value);
869 fprintf (stderr, "rrdtool: `CacheTimeout' must "
870 "be greater than 0.\n");
875 else if (strcasecmp ("CacheFlush", key) == 0)
877 int tmp = atoi (value);
880 fprintf (stderr, "rrdtool: `CacheFlush' must "
881 "be greater than 0.\n");
884 cache_flush_timeout = tmp;
886 else if (strcasecmp ("DataDir", key) == 0)
890 datadir = strdup (value);
893 int len = strlen (datadir);
894 while ((len > 0) && (datadir[len - 1] == '/'))
906 else if (strcasecmp ("StepSize", key) == 0)
908 stepsize = atoi (value);
912 else if (strcasecmp ("HeartBeat", key) == 0)
914 heartbeat = atoi (value);
918 else if (strcasecmp ("RRARows", key) == 0)
920 int tmp = atoi (value);
923 fprintf (stderr, "rrdtool: `RRARows' must "
924 "be greater than 0.\n");
929 else if (strcasecmp ("RRATimespan", key) == 0)
931 char *saveptr = NULL;
937 value_copy = strdup (value);
938 if (value_copy == NULL)
942 while ((ptr = strtok_r (dummy, ", \t", &saveptr)) != NULL)
946 tmp_alloc = realloc (rra_timespans_custom,
947 sizeof (int) * (rra_timespans_custom_num + 1));
948 if (tmp_alloc == NULL)
950 fprintf (stderr, "rrdtool: realloc failed.\n");
954 rra_timespans_custom = tmp_alloc;
955 rra_timespans_custom[rra_timespans_custom_num] = atoi (ptr);
956 if (rra_timespans_custom[rra_timespans_custom_num] != 0)
957 rra_timespans_custom_num++;
958 } /* while (strtok_r) */
961 else if (strcasecmp ("XFF", key) == 0)
963 double tmp = atof (value);
964 if ((tmp < 0.0) || (tmp >= 1.0))
966 fprintf (stderr, "rrdtool: `XFF' must "
967 "be in the range 0 to 1 (exclusive).");
977 } /* int rrd_config */
979 static int rrd_shutdown (void)
981 pthread_mutex_lock (&cache_lock);
982 rrd_cache_flush (-1);
983 pthread_mutex_unlock (&cache_lock);
985 pthread_mutex_lock (&queue_lock);
987 pthread_cond_signal (&queue_cond);
988 pthread_mutex_unlock (&queue_lock);
991 } /* int rrd_shutdown */
993 static int rrd_init (void)
1002 heartbeat = 2 * stepsize;
1007 if ((heartbeat > 0) && (heartbeat < interval_g))
1008 WARNING ("rrdtool plugin: Your `heartbeat' is "
1009 "smaller than your `interval'. This will "
1010 "likely cause problems.");
1011 else if ((stepsize > 0) && (stepsize < interval_g))
1012 WARNING ("rrdtool plugin: Your `stepsize' is "
1013 "smaller than your `interval'. This will "
1014 "create needlessly big RRD-files.");
1016 /* Set the cache up */
1017 pthread_mutex_lock (&cache_lock);
1019 cache = avl_create ((int (*) (const void *, const void *)) strcmp);
1022 ERROR ("rrdtool plugin: avl_create failed.");
1026 cache_flush_last = time (NULL);
1027 if (cache_timeout < 2)
1030 cache_flush_timeout = 0;
1032 else if (cache_flush_timeout < cache_timeout)
1033 cache_flush_timeout = 10 * cache_timeout;
1035 pthread_mutex_unlock (&cache_lock);
1037 status = pthread_create (&queue_thread, NULL, rrd_queue_thread, NULL);
1040 ERROR ("rrdtool plugin: Cannot create queue-thread.");
1044 DEBUG ("rrdtool plugin: rrd_init: datadir = %s; stepsize = %i;"
1045 " heartbeat = %i; rrarows = %i; xff = %lf;",
1046 (datadir == NULL) ? "(null)" : datadir,
1047 stepsize, heartbeat, rrarows, xff);
1050 } /* int rrd_init */
1052 void module_register (void)
1054 plugin_register_config ("rrdtool", rrd_config,
1055 config_keys, config_keys_num);
1056 plugin_register_init ("rrdtool", rrd_init);
1057 plugin_register_write ("rrdtool", rrd_write);
1058 plugin_register_shutdown ("rrdtool", rrd_shutdown);