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 #if !HAVE_THREADSAFE_LIBRRD
116 static pthread_mutex_t librrd_lock = PTHREAD_MUTEX_INITIALIZER;
119 static int do_shutdown = 0;
125 static void rra_free (int rra_num, char **rra_def)
129 for (i = 0; i < rra_num; i++)
134 } /* void rra_free */
136 static int rra_get (char ***ret, const value_list_t *vl)
154 /* The stepsize we use here: If it is user-set, use it. If not, use the
155 * interval of the value-list. */
164 ss = (stepsize > 0) ? stepsize : vl->interval;
171 /* Use the configured timespans or fall back to the built-in defaults */
172 if (rra_timespans_custom_num != 0)
174 rts = rra_timespans_custom;
175 rts_num = rra_timespans_custom_num;
180 rts_num = rra_timespans_num;
183 rra_max = rts_num * rra_types_num;
185 if ((rra_def = (char **) malloc ((rra_max + 1) * sizeof (char *))) == NULL)
187 memset (rra_def, '\0', (rra_max + 1) * sizeof (char *));
191 for (i = 0; i < rts_num; i++)
195 if ((span / ss) < rrarows)
201 cdp_len = (int) floor (((double) span)
202 / ((double) (rrarows * ss)));
204 cdp_num = (int) ceil (((double) span)
205 / ((double) (cdp_len * ss)));
207 for (j = 0; j < rra_types_num; j++)
209 if (rra_num >= rra_max)
212 if (snprintf (buffer, sizeof (buffer), "RRA:%s:%3.1f:%u:%u",
214 cdp_len, cdp_num) >= sizeof (buffer))
216 ERROR ("rra_get: Buffer would have been truncated.");
220 rra_def[rra_num++] = sstrdup (buffer);
225 DEBUG ("rra_num = %i", rra_num);
226 for (i = 0; i < rra_num; i++)
227 DEBUG (" %s", rra_def[i]);
234 static void ds_free (int ds_num, char **ds_def)
238 for (i = 0; i < ds_num; i++)
239 if (ds_def[i] != NULL)
244 static int ds_get (char ***ret, const data_set_t *ds, const value_list_t *vl)
253 DEBUG ("ds->ds_num = %i", ds->ds_num);
255 ds_def = (char **) malloc (ds->ds_num * sizeof (char *));
259 ERROR ("rrdtool plugin: malloc failed: %s",
260 sstrerror (errno, errbuf, sizeof (errbuf)));
263 memset (ds_def, '\0', ds->ds_num * sizeof (char *));
265 for (ds_num = 0; ds_num < ds->ds_num; ds_num++)
267 data_source_t *d = ds->ds + ds_num;
271 ds_def[ds_num] = NULL;
273 if (d->type == DS_TYPE_COUNTER)
275 else if (d->type == DS_TYPE_GAUGE)
279 ERROR ("rrdtool plugin: Unknown DS type: %i",
290 snprintf (min, sizeof (min), "%lf", d->min);
291 min[sizeof (min) - 1] = '\0';
300 snprintf (max, sizeof (max), "%lf", d->max);
301 max[sizeof (max) - 1] = '\0';
304 status = snprintf (buffer, sizeof (buffer),
307 (heartbeat > 0) ? heartbeat : (2 * vl->interval),
309 if ((status < 1) || (status >= sizeof (buffer)))
312 ds_def[ds_num] = sstrdup (buffer);
313 } /* for ds_num = 0 .. ds->ds_num */
318 DEBUG ("ds_num = %i", ds_num);
319 for (i = 0; i < ds_num; i++)
320 DEBUG (" %s", ds_def[i]);
324 if (ds_num != ds->ds_num)
326 ds_free (ds_num, ds_def);
334 #if HAVE_THREADSAFE_LIBRRD
335 static int srrd_create (char *filename, unsigned long pdp_step, time_t last_up,
336 int argc, char **argv)
340 optind = 0; /* bug in librrd? */
343 status = rrd_create_r (filename, pdp_step, last_up, argc, argv);
347 WARNING ("rrdtool plugin: rrd_create_r (%s) failed: %s",
348 filename, rrd_get_error ());
352 } /* int srrd_create */
354 static int srrd_update (char *filename, char *template, int argc, char **argv)
358 optind = 0; /* bug in librrd? */
361 status = rrd_update_r (filename, template, argc, argv);
365 WARNING ("rrdtool plugin: rrd_update_r (%s) failed: %s",
366 filename, rrd_get_error ());
370 } /* int srrd_update */
371 /* #endif HAVE_THREADSAFE_LIBRRD */
373 #else /* !HAVE_THREADSAFE_LIBRRD */
374 static int srrd_create (char *filename, unsigned long pdp_step, time_t last_up,
375 int argc, char **argv)
382 char pdp_step_str[16];
383 char last_up_str[16];
386 new_argv = (char **) malloc ((new_argc + 1) * sizeof (char *));
387 if (new_argv == NULL)
389 ERROR ("rrdtool plugin: malloc failed.");
394 last_up = time (NULL) - 10;
396 snprintf (pdp_step_str, sizeof (pdp_step_str), "%lu", pdp_step);
397 pdp_step_str[sizeof (pdp_step_str) - 1] = '\0';
398 snprintf (last_up_str, sizeof (last_up_str), "%u", (unsigned int) last_up);
399 last_up_str[sizeof (last_up_str) - 1] = '\0';
401 new_argv[0] = "create";
402 new_argv[1] = filename;
404 new_argv[3] = pdp_step_str;
406 new_argv[5] = last_up_str;
408 memcpy (new_argv + 6, argv, argc * sizeof (char *));
409 new_argv[new_argc] = NULL;
411 pthread_mutex_lock (&librrd_lock);
412 optind = 0; /* bug in librrd? */
415 status = rrd_create (new_argc, new_argv);
416 pthread_mutex_unlock (&librrd_lock);
420 WARNING ("rrdtool plugin: rrd_create (%s) failed: %s",
421 filename, rrd_get_error ());
427 } /* int srrd_create */
429 static int srrd_update (char *filename, char *template, int argc, char **argv)
436 assert (template == NULL);
439 new_argv = (char **) malloc ((new_argc + 1) * sizeof (char *));
440 if (new_argv == NULL)
442 ERROR ("rrdtool plugin: malloc failed.");
446 new_argv[0] = "update";
447 new_argv[1] = filename;
449 memcpy (new_argv + 2, argv, argc * sizeof (char *));
450 new_argv[new_argc] = NULL;
452 pthread_mutex_lock (&librrd_lock);
453 optind = 0; /* bug in librrd? */
456 status = rrd_update (argc, argv);
457 pthread_mutex_unlock (&librrd_lock);
461 WARNING ("rrdtool plugin: rrd_update_r failed: %s: %s",
462 argv[1], rrd_get_error ());
468 } /* int srrd_update */
469 #endif /* !HAVE_THREADSAFE_LIBRRD */
471 static int rrd_create_file (char *filename, const data_set_t *ds, const value_list_t *vl)
482 if (check_create_dir (filename))
485 if ((rra_num = rra_get (&rra_def, vl)) < 1)
487 ERROR ("rrd_create_file failed: Could not calculate RRAs");
491 if ((ds_num = ds_get (&ds_def, ds, vl)) < 1)
493 ERROR ("rrd_create_file failed: Could not calculate DSes");
497 argc = ds_num + rra_num;
499 if ((argv = (char **) malloc (sizeof (char *) * (argc + 1))) == NULL)
502 ERROR ("rrd_create failed: %s",
503 sstrerror (errno, errbuf, sizeof (errbuf)));
507 memcpy (argv, ds_def, ds_num * sizeof (char *));
508 memcpy (argv + ds_num, rra_def, rra_num * sizeof (char *));
509 argv[ds_num + rra_num] = NULL;
511 assert (vl->time > 10);
512 status = srrd_create (filename,
513 (stepsize > 0) ? stepsize : vl->interval,
518 ds_free (ds_num, ds_def);
519 rra_free (rra_num, rra_def);
524 static int value_list_to_string (char *buffer, int buffer_len,
525 const data_set_t *ds, const value_list_t *vl)
531 memset (buffer, '\0', buffer_len);
533 status = snprintf (buffer, buffer_len, "%u", (unsigned int) vl->time);
534 if ((status < 1) || (status >= buffer_len))
538 for (i = 0; i < ds->ds_num; i++)
540 if ((ds->ds[i].type != DS_TYPE_COUNTER)
541 && (ds->ds[i].type != DS_TYPE_GAUGE))
544 if (ds->ds[i].type == DS_TYPE_COUNTER)
545 status = snprintf (buffer + offset, buffer_len - offset,
546 ":%llu", vl->values[i].counter);
548 status = snprintf (buffer + offset, buffer_len - offset,
549 ":%lf", vl->values[i].gauge);
551 if ((status < 1) || (status >= (buffer_len - offset)))
555 } /* for ds->ds_num */
558 } /* int value_list_to_string */
560 static int value_list_to_filename (char *buffer, int buffer_len,
561 const data_set_t *ds, const value_list_t *vl)
568 status = snprintf (buffer + offset, buffer_len - offset,
570 if ((status < 1) || (status >= buffer_len - offset))
575 status = snprintf (buffer + offset, buffer_len - offset,
577 if ((status < 1) || (status >= buffer_len - offset))
581 if (strlen (vl->plugin_instance) > 0)
582 status = snprintf (buffer + offset, buffer_len - offset,
583 "%s-%s/", vl->plugin, vl->plugin_instance);
585 status = snprintf (buffer + offset, buffer_len - offset,
587 if ((status < 1) || (status >= buffer_len - offset))
591 if (strlen (vl->type_instance) > 0)
592 status = snprintf (buffer + offset, buffer_len - offset,
593 "%s-%s.rrd", ds->type, vl->type_instance);
595 status = snprintf (buffer + offset, buffer_len - offset,
597 if ((status < 1) || (status >= buffer_len - offset))
602 } /* int value_list_to_filename */
604 static void *rrd_queue_thread (void *data)
608 rrd_queue_t *queue_entry;
609 rrd_cache_t *cache_entry;
614 /* XXX: If you need to lock both, cache_lock and queue_lock, at
615 * the same time, ALWAYS lock `cache_lock' first! */
617 /* wait until an entry is available */
618 pthread_mutex_lock (&queue_lock);
619 while ((queue_head == NULL) && (do_shutdown == 0))
620 pthread_cond_wait (&queue_cond, &queue_lock);
622 /* We're in the shutdown phase */
623 if (queue_head == NULL)
625 pthread_mutex_unlock (&queue_lock);
629 /* Dequeue the first entry */
630 queue_entry = queue_head;
631 if (queue_head == queue_tail)
632 queue_head = queue_tail = NULL;
634 queue_head = queue_head->next;
636 /* Unlock the queue again */
637 pthread_mutex_unlock (&queue_lock);
639 /* We now need the cache lock so the entry isn't updated while
640 * we make a copy of it's values */
641 pthread_mutex_lock (&cache_lock);
643 avl_get (cache, queue_entry->filename, (void *) &cache_entry);
645 values = cache_entry->values;
646 values_num = cache_entry->values_num;
648 cache_entry->values = NULL;
649 cache_entry->values_num = 0;
650 cache_entry->flags = FLAG_NONE;
652 pthread_mutex_unlock (&cache_lock);
654 /* Write the values to the RRD-file */
655 srrd_update (queue_entry->filename, NULL, values_num, values);
657 for (i = 0; i < values_num; i++)
662 sfree (queue_entry->filename);
666 pthread_mutex_lock (&cache_lock);
669 pthread_mutex_unlock (&cache_lock);
671 pthread_exit ((void *) 0);
673 } /* void *rrd_queue_thread */
675 static int rrd_queue_cache_entry (const char *filename)
677 rrd_queue_t *queue_entry;
679 queue_entry = (rrd_queue_t *) malloc (sizeof (rrd_queue_t));
680 if (queue_entry == NULL)
683 queue_entry->filename = strdup (filename);
684 if (queue_entry->filename == NULL)
690 queue_entry->next = NULL;
692 pthread_mutex_lock (&queue_lock);
693 if (queue_tail == NULL)
694 queue_head = queue_entry;
696 queue_tail->next = queue_entry;
697 queue_tail = queue_entry;
698 pthread_cond_signal (&queue_cond);
699 pthread_mutex_unlock (&queue_lock);
701 DEBUG ("rrdtool plugin: Put `%s' into the update queue", filename);
704 } /* int rrd_queue_cache_entry */
706 static void rrd_cache_flush (int timeout)
715 avl_iterator_t *iter;
718 DEBUG ("Flushing cache, timeout = %i", timeout);
722 /* Build a list of entries to be flushed */
723 iter = avl_get_iterator (cache);
724 while (avl_iterator_next (iter, (void *) &key, (void *) &rc) == 0)
726 DEBUG ("key = %s; age = %i;", key, now - rc->first_value);
728 if (rc->flags == FLAG_QUEUED)
730 else if ((now - rc->first_value) < timeout)
732 else if (rc->values_num > 0)
734 if (rrd_queue_cache_entry (key) == 0)
735 rc->flags = FLAG_QUEUED;
737 else /* ancient and no values -> waste of memory */
739 keys = (char **) realloc ((void *) keys,
740 (keys_num + 1) * sizeof (char *));
744 ERROR ("rrdtool plugin: "
745 "realloc failed: %s",
746 sstrerror (errno, errbuf,
748 avl_iterator_destroy (iter);
751 keys[keys_num] = key;
754 } /* while (avl_iterator_next) */
755 avl_iterator_destroy (iter);
757 for (i = 0; i < keys_num; i++)
759 if (avl_remove (cache, keys[i], (void *) &key, (void *) &rc) != 0)
761 DEBUG ("avl_remove (%s) failed.", keys[i]);
765 assert (rc->values == NULL);
766 assert (rc->values_num == 0);
771 } /* for (i = 0..keys_num) */
774 DEBUG ("Flushed %i value(s)", keys_num);
776 cache_flush_last = now;
777 } /* void rrd_cache_flush */
779 static int rrd_cache_insert (const char *filename,
780 const char *value, time_t value_time)
782 rrd_cache_t *rc = NULL;
786 pthread_mutex_lock (&cache_lock);
788 avl_get (cache, filename, (void *) &rc);
792 rc = (rrd_cache_t *) malloc (sizeof (rrd_cache_t));
799 rc->flags = FLAG_NONE;
803 if (rc->last_value >= value_time)
805 pthread_mutex_unlock (&cache_lock);
806 WARNING ("rrdtool plugin: (rc->last_value = %u) >= (value_time = %u)",
807 (unsigned int) rc->last_value,
808 (unsigned int) value_time);
812 values_new = (char **) realloc ((void *) rc->values,
813 (rc->values_num + 1) * sizeof (char *));
814 if (values_new == NULL)
817 void *cache_key = NULL;
819 sstrerror (errno, errbuf, sizeof (errbuf));
821 avl_remove (cache, filename, &cache_key, NULL);
822 pthread_mutex_unlock (&cache_lock);
824 ERROR ("rrdtool plugin: realloc failed: %s", errbuf);
831 rc->values = values_new;
833 rc->values[rc->values_num] = strdup (value);
834 if (rc->values[rc->values_num] != NULL)
837 if (rc->values_num == 1)
838 rc->first_value = value_time;
839 rc->last_value = value_time;
841 /* Insert if this is the first value */
844 void *cache_key = strdup (filename);
846 if (cache_key == NULL)
849 sstrerror (errno, errbuf, sizeof (errbuf));
851 pthread_mutex_unlock (&cache_lock);
853 ERROR ("rrdtool plugin: strdup failed: %s", errbuf);
855 sfree (rc->values[0]);
861 avl_insert (cache, cache_key, rc);
864 DEBUG ("rrd_cache_insert (%s, %s, %u) = %p", filename, value,
865 (unsigned int) value_time, (void *) rc);
867 if ((rc->last_value - rc->first_value) >= cache_timeout)
869 /* XXX: If you need to lock both, cache_lock and queue_lock, at
870 * the same time, ALWAYS lock `cache_lock' first! */
871 if (rc->flags != FLAG_QUEUED)
873 if (rrd_queue_cache_entry (filename) == 0)
874 rc->flags = FLAG_QUEUED;
878 DEBUG ("rrdtool plugin: `%s' is already queued.", filename);
882 if ((cache_timeout > 0) &&
883 ((time (NULL) - cache_flush_last) > cache_flush_timeout))
884 rrd_cache_flush (cache_flush_timeout);
887 pthread_mutex_unlock (&cache_lock);
890 } /* int rrd_cache_insert */
892 static int rrd_write (const data_set_t *ds, const value_list_t *vl)
899 if (value_list_to_filename (filename, sizeof (filename), ds, vl) != 0)
902 if (value_list_to_string (values, sizeof (values), ds, vl) != 0)
905 if (stat (filename, &statbuf) == -1)
909 if (rrd_create_file (filename, ds, vl))
915 ERROR ("stat(%s) failed: %s", filename,
916 sstrerror (errno, errbuf,
921 else if (!S_ISREG (statbuf.st_mode))
923 ERROR ("stat(%s): Not a regular file!",
928 status = rrd_cache_insert (filename, values, vl->time);
931 } /* int rrd_write */
933 static int rrd_config (const char *key, const char *value)
935 if (strcasecmp ("CacheTimeout", key) == 0)
937 int tmp = atoi (value);
940 fprintf (stderr, "rrdtool: `CacheTimeout' must "
941 "be greater than 0.\n");
946 else if (strcasecmp ("CacheFlush", key) == 0)
948 int tmp = atoi (value);
951 fprintf (stderr, "rrdtool: `CacheFlush' must "
952 "be greater than 0.\n");
955 cache_flush_timeout = tmp;
957 else if (strcasecmp ("DataDir", key) == 0)
961 datadir = strdup (value);
964 int len = strlen (datadir);
965 while ((len > 0) && (datadir[len - 1] == '/'))
977 else if (strcasecmp ("StepSize", key) == 0)
979 stepsize = atoi (value);
983 else if (strcasecmp ("HeartBeat", key) == 0)
985 heartbeat = atoi (value);
989 else if (strcasecmp ("RRARows", key) == 0)
991 int tmp = atoi (value);
994 fprintf (stderr, "rrdtool: `RRARows' must "
995 "be greater than 0.\n");
1000 else if (strcasecmp ("RRATimespan", key) == 0)
1002 char *saveptr = NULL;
1008 value_copy = strdup (value);
1009 if (value_copy == NULL)
1013 while ((ptr = strtok_r (dummy, ", \t", &saveptr)) != NULL)
1017 tmp_alloc = realloc (rra_timespans_custom,
1018 sizeof (int) * (rra_timespans_custom_num + 1));
1019 if (tmp_alloc == NULL)
1021 fprintf (stderr, "rrdtool: realloc failed.\n");
1025 rra_timespans_custom = tmp_alloc;
1026 rra_timespans_custom[rra_timespans_custom_num] = atoi (ptr);
1027 if (rra_timespans_custom[rra_timespans_custom_num] != 0)
1028 rra_timespans_custom_num++;
1029 } /* while (strtok_r) */
1032 else if (strcasecmp ("XFF", key) == 0)
1034 double tmp = atof (value);
1035 if ((tmp < 0.0) || (tmp >= 1.0))
1037 fprintf (stderr, "rrdtool: `XFF' must "
1038 "be in the range 0 to 1 (exclusive).");
1048 } /* int rrd_config */
1050 static int rrd_shutdown (void)
1052 pthread_mutex_lock (&cache_lock);
1053 rrd_cache_flush (-1);
1054 pthread_mutex_unlock (&cache_lock);
1056 pthread_mutex_lock (&queue_lock);
1058 pthread_cond_signal (&queue_cond);
1059 pthread_mutex_unlock (&queue_lock);
1062 } /* int rrd_shutdown */
1064 static int rrd_init (void)
1073 heartbeat = 2 * stepsize;
1078 if ((heartbeat > 0) && (heartbeat < interval_g))
1079 WARNING ("rrdtool plugin: Your `heartbeat' is "
1080 "smaller than your `interval'. This will "
1081 "likely cause problems.");
1082 else if ((stepsize > 0) && (stepsize < interval_g))
1083 WARNING ("rrdtool plugin: Your `stepsize' is "
1084 "smaller than your `interval'. This will "
1085 "create needlessly big RRD-files.");
1087 /* Set the cache up */
1088 pthread_mutex_lock (&cache_lock);
1090 cache = avl_create ((int (*) (const void *, const void *)) strcmp);
1093 ERROR ("rrdtool plugin: avl_create failed.");
1097 cache_flush_last = time (NULL);
1098 if (cache_timeout < 2)
1101 cache_flush_timeout = 0;
1103 else if (cache_flush_timeout < cache_timeout)
1104 cache_flush_timeout = 10 * cache_timeout;
1106 pthread_mutex_unlock (&cache_lock);
1108 status = pthread_create (&queue_thread, NULL, rrd_queue_thread, NULL);
1111 ERROR ("rrdtool plugin: Cannot create queue-thread.");
1115 DEBUG ("rrdtool plugin: rrd_init: datadir = %s; stepsize = %i;"
1116 " heartbeat = %i; rrarows = %i; xff = %lf;",
1117 (datadir == NULL) ? "(null)" : datadir,
1118 stepsize, heartbeat, rrarows, xff);
1121 } /* int rrd_init */
1123 void module_register (void)
1125 plugin_register_config ("rrdtool", rrd_config,
1126 config_keys, config_keys_num);
1127 plugin_register_init ("rrdtool", rrd_init);
1128 plugin_register_write ("rrdtool", rrd_write);
1129 plugin_register_shutdown ("rrdtool", rrd_shutdown);