1 /**
2 * collectd - src/rrdcached.c
3 * Copyright (C) 2008 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_rrdcreate.h"
27 #undef HAVE_CONFIG_H
28 #include <rrd.h>
29 #include <rrd_client.h>
31 /*
32 * Private variables
33 */
34 static char *datadir = NULL;
35 static char *daemon_address = NULL;
36 static int config_create_files = 1;
37 static int config_collect_stats = 1;
38 static rrdcreate_config_t rrdcreate_config =
39 {
40 /* stepsize = */ 0,
41 /* heartbeat = */ 0,
42 /* rrarows = */ 1200,
43 /* xff = */ 0.1,
45 /* timespans = */ NULL,
46 /* timespans_num = */ 0,
48 /* consolidation_functions = */ NULL,
49 /* consolidation_functions_num = */ 0
50 };
52 /*
53 * Prototypes.
54 */
55 static int rc_write (const data_set_t *ds, const value_list_t *vl,
56 user_data_t __attribute__((unused)) *user_data);
57 static int rc_flush (__attribute__((unused)) cdtime_t timeout,
58 const char *identifier, __attribute__((unused)) user_data_t *ud);
60 static int value_list_to_string (char *buffer, int buffer_len,
61 const data_set_t *ds, const value_list_t *vl)
62 {
63 int offset;
64 int status;
65 int i;
66 time_t t;
68 assert (0 == strcmp (ds->type, vl->type));
70 memset (buffer, '\0', buffer_len);
72 t = CDTIME_T_TO_TIME_T (vl->time);
73 status = ssnprintf (buffer, buffer_len, "%lu", (unsigned long) t);
74 if ((status < 1) || (status >= buffer_len))
75 return (-1);
76 offset = status;
78 for (i = 0; i < ds->ds_num; i++)
79 {
80 if ((ds->ds[i].type != DS_TYPE_COUNTER)
81 && (ds->ds[i].type != DS_TYPE_GAUGE)
82 && (ds->ds[i].type != DS_TYPE_DERIVE)
83 && (ds->ds[i].type != DS_TYPE_ABSOLUTE))
84 return (-1);
86 if (ds->ds[i].type == DS_TYPE_COUNTER)
87 {
88 status = ssnprintf (buffer + offset, buffer_len - offset,
89 ":%llu", vl->values[i].counter);
90 }
91 else if (ds->ds[i].type == DS_TYPE_GAUGE)
92 {
93 status = ssnprintf (buffer + offset, buffer_len - offset,
94 ":%f", vl->values[i].gauge);
95 }
96 else if (ds->ds[i].type == DS_TYPE_DERIVE) {
97 status = ssnprintf (buffer + offset, buffer_len - offset,
98 ":%"PRIi64, vl->values[i].derive);
99 }
100 else /* if (ds->ds[i].type == DS_TYPE_ABSOLUTE) */ {
101 status = ssnprintf (buffer + offset, buffer_len - offset,
102 ":%"PRIu64, vl->values[i].absolute);
104 }
106 if ((status < 1) || (status >= (buffer_len - offset)))
107 return (-1);
109 offset += status;
110 } /* for ds->ds_num */
112 return (0);
113 } /* int value_list_to_string */
115 static int value_list_to_filename (char *buffer, int buffer_len,
116 const data_set_t *ds, const value_list_t *vl)
117 {
118 int offset = 0;
119 int status;
121 assert (0 == strcmp (ds->type, vl->type));
123 if (datadir != NULL)
124 {
125 status = ssnprintf (buffer + offset, buffer_len - offset,
126 "%s/", datadir);
127 if ((status < 1) || (status >= buffer_len - offset))
128 return (-1);
129 offset += status;
130 }
132 status = ssnprintf (buffer + offset, buffer_len - offset,
133 "%s/", vl->host);
134 if ((status < 1) || (status >= buffer_len - offset))
135 return (-1);
136 offset += status;
138 if (strlen (vl->plugin_instance) > 0)
139 status = ssnprintf (buffer + offset, buffer_len - offset,
140 "%s-%s/", vl->plugin, vl->plugin_instance);
141 else
142 status = ssnprintf (buffer + offset, buffer_len - offset,
143 "%s/", vl->plugin);
144 if ((status < 1) || (status >= buffer_len - offset))
145 return (-1);
146 offset += status;
148 if (strlen (vl->type_instance) > 0)
149 status = ssnprintf (buffer + offset, buffer_len - offset,
150 "%s-%s", vl->type, vl->type_instance);
151 else
152 status = ssnprintf (buffer + offset, buffer_len - offset,
153 "%s", vl->type);
154 if ((status < 1) || (status >= buffer_len - offset))
155 return (-1);
156 offset += status;
158 strncpy (buffer + offset, ".rrd", buffer_len - offset);
159 buffer[buffer_len - 1] = 0;
161 return (0);
162 } /* int value_list_to_filename */
164 static const char *config_get_string (oconfig_item_t *ci)
165 {
166 if ((ci->children_num != 0) || (ci->values_num != 1)
167 || ((ci->values[0].type != OCONFIG_TYPE_STRING)
168 && (ci->values[0].type != OCONFIG_TYPE_BOOLEAN)))
169 {
170 ERROR ("rrdcached plugin: %s expects a single string argument.",
171 ci->key);
172 return (NULL);
173 }
175 if (ci->values[0].type == OCONFIG_TYPE_BOOLEAN) {
176 if (ci->values[0].value.boolean)
177 return "true";
178 else
179 return "false";
180 }
181 return (ci->values[0].value.string);
182 } /* const char *config_get_string */
184 static int rc_config (oconfig_item_t *ci)
185 {
186 int i;
188 for (i = 0; i < ci->children_num; ++i) {
189 const char *key = ci->children[i].key;
190 const char *value = config_get_string (ci->children + i);
192 if (value == NULL) /* config_get_strings prints error message */
193 continue;
195 if (strcasecmp ("DataDir", key) == 0)
196 {
197 if (datadir != NULL)
198 free (datadir);
199 datadir = strdup (value);
200 if (datadir != NULL)
201 {
202 int len = strlen (datadir);
203 while ((len > 0) && (datadir[len - 1] == '/'))
204 {
205 len--;
206 datadir[len] = '\0';
207 }
208 if (len <= 0)
209 {
210 free (datadir);
211 datadir = NULL;
212 }
213 }
214 }
215 else if (strcasecmp ("DaemonAddress", key) == 0)
216 {
217 sfree (daemon_address);
218 daemon_address = strdup (value);
219 if (daemon_address == NULL)
220 {
221 ERROR ("rrdcached plugin: strdup failed.");
222 continue;
223 }
224 }
225 else if (strcasecmp ("CreateFiles", key) == 0)
226 {
227 if (IS_FALSE (value))
228 config_create_files = 0;
229 else
230 config_create_files = 1;
231 }
232 else if (strcasecmp ("CollectStatistics", key) == 0)
233 {
234 if (IS_FALSE (value))
235 config_collect_stats = 0;
236 else
237 config_collect_stats = 1;
238 }
239 else
240 {
241 WARNING ("rrdcached plugin: Ignoring invalid option %s.", key);
242 continue;
243 }
244 }
246 if (daemon_address != NULL) {
247 plugin_register_write ("rrdcached", rc_write, /* user_data = */ NULL);
248 plugin_register_flush ("rrdcached", rc_flush, /* user_data = */ NULL);
249 }
250 return (0);
251 } /* int rc_config */
253 static int rc_read (void)
254 {
255 int status;
256 rrdc_stats_t *head;
257 rrdc_stats_t *ptr;
259 value_t values[1];
260 value_list_t vl = VALUE_LIST_INIT;
262 if (daemon_address == NULL)
263 return (-1);
265 if (config_collect_stats == 0)
266 return (-1);
268 vl.values = values;
269 vl.values_len = 1;
271 if ((strncmp ("unix:", daemon_address, strlen ("unix:")) == 0)
272 || (daemon_address[0] == '/'))
273 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
274 else
275 sstrncpy (vl.host, daemon_address, sizeof (vl.host));
276 sstrncpy (vl.plugin, "rrdcached", sizeof (vl.plugin));
278 head = NULL;
279 status = rrdc_stats_get (&head);
280 if (status != 0)
281 {
282 ERROR ("rrdcached plugin: rrdc_stats_get failed with status %i.", status);
283 return (-1);
284 }
286 for (ptr = head; ptr != NULL; ptr = ptr->next)
287 {
288 if (ptr->type == RRDC_STATS_TYPE_GAUGE)
289 values[0].gauge = (gauge_t) ptr->value.gauge;
290 else if (ptr->type == RRDC_STATS_TYPE_COUNTER)
291 values[0].counter = (counter_t) ptr->value.counter;
292 else
293 continue;
295 if (strcasecmp ("QueueLength", ptr->name) == 0)
296 {
297 sstrncpy (vl.type, "queue_length", sizeof (vl.type));
298 sstrncpy (vl.type_instance, "", sizeof (vl.type_instance));
299 }
300 else if (strcasecmp ("UpdatesWritten", ptr->name) == 0)
301 {
302 sstrncpy (vl.type, "operations", sizeof (vl.type));
303 sstrncpy (vl.type_instance, "write-updates", sizeof (vl.type_instance));
304 }
305 else if (strcasecmp ("DataSetsWritten", ptr->name) == 0)
306 {
307 sstrncpy (vl.type, "operations", sizeof (vl.type));
308 sstrncpy (vl.type_instance, "write-data_sets",
309 sizeof (vl.type_instance));
310 }
311 else if (strcasecmp ("TreeNodesNumber", ptr->name) == 0)
312 {
313 sstrncpy (vl.type, "gauge", sizeof (vl.type));
314 sstrncpy (vl.type_instance, "tree_nodes", sizeof (vl.type_instance));
315 }
316 else if (strcasecmp ("TreeDepth", ptr->name) == 0)
317 {
318 sstrncpy (vl.type, "gauge", sizeof (vl.type));
319 sstrncpy (vl.type_instance, "tree_depth", sizeof (vl.type_instance));
320 }
321 else if (strcasecmp ("FlushesReceived", ptr->name) == 0)
322 {
323 sstrncpy (vl.type, "operations", sizeof (vl.type));
324 sstrncpy (vl.type_instance, "receive-flush", sizeof (vl.type_instance));
325 }
326 else if (strcasecmp ("JournalBytes", ptr->name) == 0)
327 {
328 sstrncpy (vl.type, "counter", sizeof (vl.type));
329 sstrncpy (vl.type_instance, "journal-bytes", sizeof (vl.type_instance));
330 }
331 else if (strcasecmp ("JournalRotate", ptr->name) == 0)
332 {
333 sstrncpy (vl.type, "counter", sizeof (vl.type));
334 sstrncpy (vl.type_instance, "journal-rotates", sizeof (vl.type_instance));
335 }
336 else if (strcasecmp ("UpdatesReceived", ptr->name) == 0)
337 {
338 sstrncpy (vl.type, "operations", sizeof (vl.type));
339 sstrncpy (vl.type_instance, "receive-update", sizeof (vl.type_instance));
340 }
341 else
342 {
343 DEBUG ("rrdcached plugin: rc_read: Unknown statistic `%s'.", ptr->name);
344 continue;
345 }
347 plugin_dispatch_values (&vl);
348 } /* for (ptr = head; ptr != NULL; ptr = ptr->next) */
350 rrdc_stats_free (head);
352 return (0);
353 } /* int rc_read */
355 static int rc_init (void)
356 {
357 if (config_collect_stats != 0)
358 plugin_register_read ("rrdcached", rc_read);
360 return (0);
361 } /* int rc_init */
363 static int rc_write (const data_set_t *ds, const value_list_t *vl,
364 user_data_t __attribute__((unused)) *user_data)
365 {
366 char filename[PATH_MAX];
367 char values[512];
368 char *values_array[2];
369 int status;
371 if (daemon_address == NULL)
372 {
373 ERROR ("rrdcached plugin: daemon_address == NULL.");
374 plugin_unregister_write ("rrdcached");
375 return (-1);
376 }
378 if (strcmp (ds->type, vl->type) != 0)
379 {
380 ERROR ("rrdcached plugin: DS type does not match value list type");
381 return (-1);
382 }
384 if (value_list_to_filename (filename, sizeof (filename), ds, vl) != 0)
385 {
386 ERROR ("rrdcached plugin: value_list_to_filename failed.");
387 return (-1);
388 }
390 if (value_list_to_string (values, sizeof (values), ds, vl) != 0)
391 {
392 ERROR ("rrdcached plugin: value_list_to_string failed.");
393 return (-1);
394 }
396 values_array[0] = values;
397 values_array[1] = NULL;
399 if (config_create_files != 0)
400 {
401 struct stat statbuf;
403 status = stat (filename, &statbuf);
404 if (status != 0)
405 {
406 if (errno != ENOENT)
407 {
408 char errbuf[1024];
409 ERROR ("rrdcached plugin: stat (%s) failed: %s",
410 filename, sstrerror (errno, errbuf, sizeof (errbuf)));
411 return (-1);
412 }
414 status = cu_rrd_create_file (filename, ds, vl, &rrdcreate_config);
415 if (status != 0)
416 {
417 ERROR ("rrdcached plugin: cu_rrd_create_file (%s) failed.",
418 filename);
419 return (-1);
420 }
421 }
422 }
424 status = rrdc_connect (daemon_address);
425 if (status != 0)
426 {
427 ERROR ("rrdcached plugin: rrdc_connect (%s) failed with status %i.",
428 daemon_address, status);
429 return (-1);
430 }
432 status = rrdc_update (filename, /* values_num = */ 1, (void *) values_array);
433 if (status != 0)
434 {
435 ERROR ("rrdcached plugin: rrdc_update (%s, [%s], 1) failed with "
436 "status %i.",
437 filename, values_array[0], status);
438 return (-1);
439 }
441 return (0);
442 } /* int rc_write */
444 static int rc_flush (__attribute__((unused)) cdtime_t timeout, /* {{{ */
445 const char *identifier,
446 __attribute__((unused)) user_data_t *ud)
447 {
448 char filename[PATH_MAX + 1];
449 int status;
451 if (identifier == NULL)
452 return (EINVAL);
454 if (datadir != NULL)
455 ssnprintf (filename, sizeof (filename), "%s/%s.rrd", datadir, identifier);
456 else
457 ssnprintf (filename, sizeof (filename), "%s.rrd", identifier);
459 status = rrdc_connect (daemon_address);
460 if (status != 0)
461 {
462 ERROR ("rrdcached plugin: rrdc_connect (%s) failed with status %i.",
463 daemon_address, status);
464 return (-1);
465 }
467 status = rrdc_flush (filename);
468 if (status != 0)
469 {
470 ERROR ("rrdcached plugin: rrdc_flush (%s) failed with status %i.",
471 filename, status);
472 return (-1);
473 }
474 DEBUG ("rrdcached plugin: rrdc_flush (%s): Success.", filename);
476 return (0);
477 } /* }}} int rc_flush */
479 static int rc_shutdown (void)
480 {
481 rrdc_disconnect ();
482 return (0);
483 } /* int rc_shutdown */
485 void module_register (void)
486 {
487 plugin_register_complex_config ("rrdcached", rc_config);
488 plugin_register_init ("rrdcached", rc_init);
489 plugin_register_shutdown ("rrdcached", rc_shutdown);
490 } /* void module_register */
492 /*
493 * vim: set sw=2 sts=2 et :
494 */