1 /**
2 * collectd - src/rrdtool.c
3 * Copyright (C) 2006 Florian octo Forster
4 *
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.
8 *
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.
13 *
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
17 *
18 * Authors:
19 * Florian octo Forster <octo at verplant.org>
20 **/
22 #include "collectd.h"
23 #include "plugin.h"
24 #include "common.h"
25 #include "utils_avltree.h"
26 #include "utils_debug.h"
28 /*
29 * This weird macro cascade forces the glibc to define `NAN'. I don't know
30 * another way to solve this, so more intelligent solutions are welcome. -octo
31 */
32 #ifndef __USE_ISOC99
33 # define DISABLE__USE_ISOC99 1
34 # define __USE_ISOC99 1
35 #endif
36 #include <math.h>
37 #ifdef DISABLE__USE_ISOC99
38 # undef DISABLE__USE_ISOC99
39 # undef __USE_ISOC99
40 #endif
42 /*
43 * Private types
44 */
45 struct rrd_cache_s
46 {
47 int values_num;
48 char **values;
49 time_t first_value;
50 };
51 typedef struct rrd_cache_s rrd_cache_t;
53 /*
54 * Private variables
55 */
56 static int rra_timespans[] =
57 {
58 3600,
59 86400,
60 604800,
61 2678400,
62 31622400,
63 0
64 };
65 static int rra_timespans_num = 5;
67 static char *rra_types[] =
68 {
69 "AVERAGE",
70 "MIN",
71 "MAX",
72 NULL
73 };
74 static int rra_types_num = 3;
76 static const char *config_keys[] =
77 {
78 "CacheTimeout",
79 "CacheFlush",
80 "DataDir",
81 NULL
82 };
83 static int config_keys_num = 3;
85 static char *datadir = NULL;
87 static int cache_timeout = 0;
88 static int cache_flush_timeout = 0;
89 static time_t cache_flush_last;
90 static avl_tree_t *cache = NULL;
92 /* * * * * * * * * *
93 * WARNING: Magic *
94 * * * * * * * * * */
95 static int rra_get (char ***ret)
96 {
97 static char **rra_def = NULL;
98 static int rra_num = 0;
100 int rra_max = rra_timespans_num * rra_types_num;
102 int step;
103 int rows;
104 int span;
106 int cdp_num;
107 int cdp_len;
108 int i, j;
110 char buffer[64];
112 if ((rra_num != 0) && (rra_def != NULL))
113 {
114 *ret = rra_def;
115 return (rra_num);
116 }
118 if ((rra_def = (char **) malloc ((rra_max + 1) * sizeof (char *))) == NULL)
119 return (-1);
120 memset (rra_def, '\0', (rra_max + 1) * sizeof (char *));
122 step = atoi (COLLECTD_STEP);
123 rows = atoi (COLLECTD_ROWS);
125 if ((step <= 0) || (rows <= 0))
126 {
127 *ret = NULL;
128 return (-1);
129 }
131 cdp_len = 0;
132 for (i = 0; i < rra_timespans_num; i++)
133 {
134 span = rra_timespans[i];
136 if ((span / step) < rows)
137 continue;
139 if (cdp_len == 0)
140 cdp_len = 1;
141 else
142 cdp_len = (int) floor (((double) span) / ((double) (rows * step)));
144 cdp_num = (int) ceil (((double) span) / ((double) (cdp_len * step)));
146 for (j = 0; j < rra_types_num; j++)
147 {
148 if (rra_num >= rra_max)
149 break;
151 if (snprintf (buffer, sizeof(buffer), "RRA:%s:%3.1f:%u:%u",
152 rra_types[j], COLLECTD_XFF,
153 cdp_len, cdp_num) >= sizeof (buffer))
154 {
155 syslog (LOG_ERR, "rra_get: Buffer would have been truncated.");
156 continue;
157 }
159 rra_def[rra_num++] = sstrdup (buffer);
160 }
161 }
163 #if COLLECT_DEBUG
164 DBG ("rra_num = %i", rra_num);
165 for (i = 0; i < rra_num; i++)
166 DBG (" %s", rra_def[i]);
167 #endif
169 *ret = rra_def;
170 return (rra_num);
171 }
173 static void ds_free (int ds_num, char **ds_def)
174 {
175 int i;
177 for (i = 0; i < ds_num; i++)
178 if (ds_def[i] != NULL)
179 free (ds_def[i]);
180 free (ds_def);
181 }
183 static int ds_get (char ***ret, const data_set_t *ds)
184 {
185 char **ds_def;
186 int ds_num;
188 char min[32];
189 char max[32];
190 char buffer[128];
192 DBG ("ds->ds_num = %i", ds->ds_num);
194 ds_def = (char **) malloc (ds->ds_num * sizeof (char *));
195 if (ds_def == NULL)
196 {
197 syslog (LOG_ERR, "rrdtool plugin: malloc failed: %s",
198 strerror (errno));
199 return (-1);
200 }
201 memset (ds_def, '\0', ds->ds_num * sizeof (char *));
203 for (ds_num = 0; ds_num < ds->ds_num; ds_num++)
204 {
205 data_source_t *d = ds->ds + ds_num;
206 char *type;
207 int status;
209 ds_def[ds_num] = NULL;
211 if (d->type == DS_TYPE_COUNTER)
212 type = "COUNTER";
213 else if (d->type == DS_TYPE_GAUGE)
214 type = "GAUGE";
215 else
216 {
217 syslog (LOG_ERR, "rrdtool plugin: Unknown DS type: %i",
218 d->type);
219 break;
220 }
222 if (d->min == NAN)
223 {
224 strcpy (min, "U");
225 }
226 else
227 {
228 snprintf (min, sizeof (min), "%lf", d->min);
229 min[sizeof (min) - 1] = '\0';
230 }
232 if (d->max == NAN)
233 {
234 strcpy (max, "U");
235 }
236 else
237 {
238 snprintf (max, sizeof (max), "%lf", d->max);
239 max[sizeof (max) - 1] = '\0';
240 }
242 status = snprintf (buffer, sizeof (buffer),
243 "DS:%s:%s:%s:%s:%s",
244 d->name, type, COLLECTD_HEARTBEAT,
245 min, max);
246 if ((status < 1) || (status >= sizeof (buffer)))
247 break;
249 ds_def[ds_num] = sstrdup (buffer);
250 } /* for ds_num = 0 .. ds->ds_num */
252 #if COLLECT_DEBUG
253 {
254 int i;
255 DBG ("ds_num = %i", ds_num);
256 for (i = 0; i < ds_num; i++)
257 DBG (" %s", ds_def[i]);
258 }
259 #endif
261 if (ds_num != ds->ds_num)
262 {
263 ds_free (ds_num, ds_def);
264 return (-1);
265 }
267 *ret = ds_def;
268 return (ds_num);
269 }
271 static int rrd_create_file (char *filename, const data_set_t *ds)
272 {
273 char **argv;
274 int argc;
275 char **rra_def;
276 int rra_num;
277 char **ds_def;
278 int ds_num;
279 int i, j;
280 int status = 0;
282 if (check_create_dir (filename))
283 return (-1);
285 if ((rra_num = rra_get (&rra_def)) < 1)
286 {
287 syslog (LOG_ERR, "rrd_create_file failed: Could not calculate RRAs");
288 return (-1);
289 }
291 if ((ds_num = ds_get (&ds_def, ds)) < 1)
292 {
293 syslog (LOG_ERR, "rrd_create_file failed: Could not calculate DSes");
294 return (-1);
295 }
297 argc = ds_num + rra_num + 4;
299 if ((argv = (char **) malloc (sizeof (char *) * (argc + 1))) == NULL)
300 {
301 syslog (LOG_ERR, "rrd_create failed: %s", strerror (errno));
302 return (-1);
303 }
305 argv[0] = "create";
306 argv[1] = filename;
307 argv[2] = "-s";
308 argv[3] = COLLECTD_STEP;
310 j = 4;
311 for (i = 0; i < ds_num; i++)
312 argv[j++] = ds_def[i];
313 for (i = 0; i < rra_num; i++)
314 argv[j++] = rra_def[i];
315 argv[j] = NULL;
317 optind = 0; /* bug in librrd? */
318 rrd_clear_error ();
319 if (rrd_create (argc, argv) == -1)
320 {
321 syslog (LOG_ERR, "rrd_create failed: %s: %s", filename, rrd_get_error ());
322 status = -1;
323 }
325 free (argv);
326 ds_free (ds_num, ds_def);
328 return (status);
329 }
331 static int value_list_to_string (char *buffer, int buffer_len,
332 const data_set_t *ds, const value_list_t *vl)
333 {
334 int offset;
335 int status;
336 int i;
338 memset (buffer, '\0', sizeof (buffer_len));
340 status = snprintf (buffer, buffer_len, "%u", (unsigned int) vl->time);
341 if ((status < 1) || (status >= buffer_len))
342 return (-1);
343 offset = status;
345 for (i = 0; i < ds->ds_num; i++)
346 {
347 if ((ds->ds[i].type != DS_TYPE_COUNTER)
348 && (ds->ds[i].type != DS_TYPE_GAUGE))
349 return (-1);
351 if (ds->ds[i].type == DS_TYPE_COUNTER)
352 status = snprintf (buffer + offset, buffer_len - offset,
353 ":%llu", vl->values[i].counter);
354 else
355 status = snprintf (buffer + offset, buffer_len - offset,
356 ":%lf", vl->values[i].gauge);
358 if ((status < 1) || (status >= (buffer_len - offset)))
359 return (-1);
361 offset += status;
362 } /* for ds->ds_num */
364 return (0);
365 } /* int value_list_to_string */
367 static int value_list_to_filename (char *buffer, int buffer_len,
368 const data_set_t *ds, const value_list_t *vl)
369 {
370 int offset = 0;
371 int status;
373 if (datadir != NULL)
374 {
375 status = snprintf (buffer + offset, buffer_len - offset,
376 "%s/", datadir);
377 if ((status < 1) || (status >= buffer_len - offset))
378 return (-1);
379 offset += status;
380 }
382 status = snprintf (buffer + offset, buffer_len - offset,
383 "%s/", vl->host);
384 if ((status < 1) || (status >= buffer_len - offset))
385 return (-1);
386 offset += status;
388 if (strlen (vl->plugin_instance) > 0)
389 status = snprintf (buffer + offset, buffer_len - offset,
390 "%s-%s/", vl->plugin, vl->plugin_instance);
391 else
392 status = snprintf (buffer + offset, buffer_len - offset,
393 "%s/", vl->plugin);
394 if ((status < 1) || (status >= buffer_len - offset))
395 return (-1);
396 offset += status;
398 if (strlen (vl->type_instance) > 0)
399 status = snprintf (buffer + offset, buffer_len - offset,
400 "%s-%s.rrd", ds->type, vl->type_instance);
401 else
402 status = snprintf (buffer + offset, buffer_len - offset,
403 "%s.rrd", ds->type);
404 if ((status < 1) || (status >= buffer_len - offset))
405 return (-1);
406 offset += status;
408 return (0);
409 } /* int value_list_to_filename */
411 static rrd_cache_t *rrd_cache_insert (const char *filename,
412 const char *value)
413 {
414 rrd_cache_t *rc = NULL;
415 int new_rc = 0;
417 if (cache != NULL)
418 avl_get (cache, filename, (void *) &rc);
420 if (rc == NULL)
421 {
422 rc = (rrd_cache_t *) malloc (sizeof (rrd_cache_t));
423 if (rc == NULL)
424 return (NULL);
425 rc->values_num = 0;
426 rc->values = NULL;
427 rc->first_value = 0;
428 new_rc = 1;
429 }
431 rc->values = (char **) realloc ((void *) rc->values,
432 (rc->values_num + 1) * sizeof (char *));
433 if (rc->values == NULL)
434 {
435 syslog (LOG_ERR, "rrdtool plugin: realloc failed: %s",
436 strerror (errno));
437 if (cache != NULL)
438 {
439 void *cache_key = NULL;
440 avl_remove (cache, filename, &cache_key, NULL);
441 sfree (cache_key);
442 }
443 free (rc);
444 return (NULL);
445 }
447 rc->values[rc->values_num] = strdup (value);
448 if (rc->values[rc->values_num] != NULL)
449 rc->values_num++;
451 if (rc->values_num == 1)
452 rc->first_value = time (NULL);
454 /* Insert if this is the first value */
455 if ((cache != NULL) && (new_rc == 1))
456 {
457 void *cache_key = strdup (filename);
459 if (cache_key == NULL)
460 {
461 syslog (LOG_ERR, "rrdtool plugin: strdup failed: %s",
462 strerror (errno));
463 sfree (rc->values[0]);
464 sfree (rc->values);
465 sfree (rc);
466 return (NULL);
467 }
469 avl_insert (cache, cache_key, rc);
470 }
472 DBG ("rrd_cache_insert (%s, %s) = %p", filename, value, (void *) rc);
474 return (rc);
475 } /* rrd_cache_t *rrd_cache_insert */
477 static int rrd_write_cache_entry (const char *filename, rrd_cache_t *rc)
478 {
479 char **argv;
480 int argc;
482 char *fn;
483 int status;
485 int i;
487 argc = rc->values_num + 2;
488 argv = (char **) malloc ((argc + 1) * sizeof (char *));
489 if (argv == NULL)
490 return (-1);
492 fn = strdup (filename);
493 if (fn == NULL)
494 {
495 free (argv);
496 return (-1);
497 }
499 argv[0] = "update";
500 argv[1] = fn;
501 memcpy (argv + 2, rc->values, rc->values_num * sizeof (char *));
502 argv[argc] = NULL;
504 DBG ("rrd_update (argc = %i, argv = %p)", argc, (void *) argv);
506 optind = 0; /* bug in librrd? */
507 rrd_clear_error ();
508 status = rrd_update (argc, argv);
510 free (argv);
511 free (fn);
513 /* Free the value list of `rc' */
514 for (i = 0; i < rc->values_num; i++)
515 free (rc->values[i]);
516 free (rc->values);
517 rc->values = NULL;
518 rc->values_num = 0;
520 if (status != 0)
521 {
522 syslog (LOG_WARNING, "rrd_update failed: %s: %s",
523 filename, rrd_get_error ());
524 return (-1);
525 }
527 return (0);
528 } /* int rrd_write_cache_entry */
530 static void rrd_cache_flush (int timeout)
531 {
532 rrd_cache_t *rc;
533 time_t now;
535 char **keys = NULL;
536 int keys_num = 0;
538 char *key;
539 avl_iterator_t *iter;
540 int i;
542 if (cache == NULL)
543 return;
545 DBG ("Flushing cache, timeout = %i", timeout);
547 now = time (NULL);
549 /* Build a list of entries to be flushed */
550 iter = avl_get_iterator (cache);
551 while (avl_iterator_next (iter, (void *) &key, (void *) &rc) == 0)
552 {
553 DBG ("key = %s; age = %i;", key, now - rc->first_value);
554 if ((now - rc->first_value) >= timeout)
555 {
556 keys = (char **) realloc ((void *) keys,
557 (keys_num + 1) * sizeof (char *));
558 if (keys == NULL)
559 {
560 DBG ("realloc failed: %s", strerror (errno));
561 syslog (LOG_ERR, "rrdtool plugin: "
562 "realloc failed: %s",
563 strerror (errno));
564 avl_iterator_destroy (iter);
565 return;
566 }
567 keys[keys_num] = key;
568 keys_num++;
569 }
570 } /* while (avl_iterator_next) */
571 avl_iterator_destroy (iter);
573 for (i = 0; i < keys_num; i++)
574 {
575 if (avl_remove (cache, keys[i], (void *) &key, (void *) &rc) != 0)
576 {
577 DBG ("avl_remove (%s) failed.", keys[i]);
578 continue;
579 }
581 rrd_write_cache_entry (keys[i], rc);
582 /* rc's value-list is free's by `rrd_write_cache_entry' */
583 sfree (rc);
584 sfree (key);
585 keys[i] = NULL;
586 } /* for (i = 0..keys_num) */
588 free (keys);
589 DBG ("Flushed %i value(s)", keys_num);
591 cache_flush_last = now;
592 } /* void rrd_cache_flush */
594 static int rrd_write (const data_set_t *ds, const value_list_t *vl)
595 {
596 struct stat statbuf;
597 char filename[512];
598 char values[512];
599 rrd_cache_t *rc;
600 time_t now;
602 if (value_list_to_filename (filename, sizeof (filename), ds, vl) != 0)
603 return (-1);
605 if (value_list_to_string (values, sizeof (values), ds, vl) != 0)
606 return (-1);
608 if (stat (filename, &statbuf) == -1)
609 {
610 if (errno == ENOENT)
611 {
612 if (rrd_create_file (filename, ds))
613 return (-1);
614 }
615 else
616 {
617 syslog (LOG_ERR, "stat(%s) failed: %s",
618 filename, strerror (errno));
619 return (-1);
620 }
621 }
622 else if (!S_ISREG (statbuf.st_mode))
623 {
624 syslog (LOG_ERR, "stat(%s): Not a regular file!",
625 filename);
626 return (-1);
627 }
629 rc = rrd_cache_insert (filename, values);
630 if (rc == NULL)
631 return (-1);
633 if (cache == NULL)
634 {
635 rrd_write_cache_entry (filename, rc);
636 /* rc's value-list is free's by `rrd_write_cache_entry' */
637 sfree (rc);
638 return (0);
639 }
641 now = time (NULL);
643 DBG ("age (%s) = %i", filename, now - rc->first_value);
645 /* `rc' is not free'd here, because we'll likely reuse it. If not, then
646 * the next flush will remove this entry. */
647 if ((now - rc->first_value) >= cache_timeout)
648 rrd_write_cache_entry (filename, rc);
650 if ((now - cache_flush_last) >= cache_flush_timeout)
651 rrd_cache_flush (cache_flush_timeout);
653 return (0);
654 } /* int rrd_write */
656 static int rrd_config (const char *key, const char *val)
657 {
658 if (strcasecmp ("CacheTimeout", key) == 0)
659 {
660 int tmp = atoi (val);
661 if (tmp < 0)
662 {
663 fprintf (stderr, "rrdtool: `CacheTimeout' must "
664 "be greater than 0.\n");
665 return (1);
666 }
667 cache_timeout = tmp;
668 }
669 else if (strcasecmp ("CacheFlush", key) == 0)
670 {
671 int tmp = atoi (val);
672 if (tmp < 0)
673 {
674 fprintf (stderr, "rrdtool: `CacheFlush' must "
675 "be greater than 0.\n");
676 return (1);
677 }
678 cache_flush_timeout = tmp;
679 }
680 else if (strcasecmp ("DataDir", key) == 0)
681 {
682 if (datadir != NULL)
683 free (datadir);
684 datadir = strdup (val);
685 if (datadir != NULL)
686 {
687 int len = strlen (datadir);
688 while ((len > 0) && (datadir[len - 1] == '/'))
689 {
690 len--;
691 datadir[len] = '\0';
692 }
693 if (len <= 0)
694 {
695 free (datadir);
696 datadir = NULL;
697 }
698 }
699 }
700 else
701 {
702 return (-1);
703 }
704 return (0);
705 } /* int rrd_config */
707 static int rrd_shutdown (void)
708 {
709 rrd_cache_flush (-1);
710 if (cache != NULL)
711 avl_destroy (cache);
712 cache = NULL;
714 return (0);
715 } /* int rrd_shutdown */
717 static int rrd_init (void)
718 {
719 if (cache_timeout < 2)
720 {
721 cache_timeout = 0;
722 cache_flush_timeout = 0;
723 }
724 else
725 {
726 if (cache_flush_timeout < cache_timeout)
727 cache_flush_timeout = 10 * cache_timeout;
729 cache = avl_create ((int (*) (const void *, const void *)) strcmp);
730 cache_flush_last = time (NULL);
731 plugin_register_shutdown ("rrdtool", rrd_shutdown);
732 }
733 return (0);
734 } /* int rrd_init */
736 void module_register (void)
737 {
738 plugin_register_config ("rrdtool", rrd_config,
739 config_keys, config_keys_num);
740 plugin_register_init ("rrdtool", rrd_init);
741 plugin_register_write ("rrdtool", rrd_write);
742 }