1 /**
2 * collectd - src/tail_csv.c
3 * Copyright (C) 2013 Kris Nielander
4 * Copyright (C) 2013 Florian Forster
5 *
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; only version 2 of the License is applicable.
9 *
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18 *
19 * Authors:
20 * Kris Nielander <nielander at fox-it.com>
21 * Florian Forster <octo at collectd.org>
22 **/
24 #include "collectd.h"
25 #include "plugin.h" /* plugin_register_*, plugin_dispatch_values */
26 #include "common.h" /* auxiliary functions */
27 #include "utils_tail.h"
29 #include <sys/mman.h>
30 #include <sys/stat.h>
31 #include <fcntl.h>
32 #include <stdlib.h>
33 #include <string.h>
35 struct metric_definition_s {
36 char *name;
37 char *type;
38 char *instance;
39 int data_source_type;
40 ssize_t value_from;
41 struct metric_definition_s *next;
42 };
43 typedef struct metric_definition_s metric_definition_t;
45 struct instance_definition_s {
46 char *instance;
47 char *path;
48 cu_tail_t *tail;
49 metric_definition_t **metric_list;
50 size_t metric_list_len;
51 cdtime_t interval;
52 ssize_t time_from;
53 struct instance_definition_s *next;
54 };
55 typedef struct instance_definition_s instance_definition_t;
57 /* Private */
58 static metric_definition_t *metric_head = NULL;
60 static int tcsv_submit (instance_definition_t *id,
61 metric_definition_t *md,
62 value_t v, cdtime_t t)
63 {
64 /* Registration variables */
65 value_list_t vl = VALUE_LIST_INIT;
67 /* Register */
68 vl.values_len = 1;
69 vl.values = &v;
71 sstrncpy(vl.host, hostname_g, sizeof (vl.host));
72 sstrncpy(vl.plugin, "tail_csv", sizeof(vl.plugin));
73 if (id->instance != NULL)
74 sstrncpy(vl.plugin_instance, id->instance, sizeof(vl.plugin_instance));
75 sstrncpy(vl.type, md->type, sizeof(vl.type));
76 if (md->instance != NULL)
77 sstrncpy(vl.type_instance, md->instance, sizeof(vl.type_instance));
79 vl.time = t;
80 vl.interval = id->interval;
82 return (plugin_dispatch_values(&vl));
83 }
85 static cdtime_t parse_time (char const *tbuf)
86 {
87 double t;
88 char *endptr = 0;
90 errno = 0;
91 t = strtod (tbuf, &endptr);
92 if ((errno != 0) || (endptr == NULL) || (endptr[0] != 0))
93 return (cdtime ());
95 return (DOUBLE_TO_CDTIME_T (t));
96 }
98 static int tcsv_read_metric (instance_definition_t *id,
99 metric_definition_t *md,
100 char **fields, size_t fields_num)
101 {
102 value_t v;
103 cdtime_t t = 0;
104 int status;
106 if (md->data_source_type == -1)
107 return (EINVAL);
109 assert (md->value_from >= 0);
110 if (((size_t) md->value_from) >= fields_num)
111 return (EINVAL);
113 status = parse_value (fields[md->value_from], &v, md->data_source_type);
114 if (status != 0)
115 return (status);
117 if (id->time_from >= 0) {
118 if (((size_t) id->time_from) >= fields_num)
119 return (EINVAL);
120 t = parse_time (fields[id->time_from]);
121 }
123 return (tcsv_submit (id, md, v, t));
124 }
126 static _Bool tcsv_check_index (ssize_t index, size_t fields_num, char const *name)
127 {
128 if (index < 0)
129 return 1;
130 else if (((size_t) index) < fields_num)
131 return 1;
133 ERROR ("tail_csv plugin: Metric \"%s\": Request for index %zd when "
134 "only %zu fields are available.",
135 name, index, fields_num);
136 return (0);
137 }
139 static int tcsv_read_buffer (instance_definition_t *id,
140 char *buffer, size_t buffer_size)
141 {
142 char **metrics;
143 size_t metrics_num;
145 char *ptr;
146 size_t i;
148 /* Remove newlines at the end of line. */
149 while (buffer_size > 0) {
150 if ((buffer[buffer_size - 1] == '\n')
151 || (buffer[buffer_size - 1] == '\r')) {
152 buffer[buffer_size - 1] = 0;
153 buffer_size--;
154 } else {
155 break;
156 }
157 }
159 /* Ignore empty lines. */
160 if ((buffer_size == 0) || (buffer[0] == '#'))
161 return (0);
163 /* Count the number of fields. */
164 metrics_num = 1;
165 for (i = 0; i < buffer_size; i++) {
166 if (buffer[i] == ',')
167 metrics_num++;
168 }
170 if (metrics_num == 1) {
171 ERROR("tail_csv plugin: last line of `%s' does not contain "
172 "enough values.", id->path);
173 return (-1);
174 }
176 /* Create a list of all values */
177 metrics = calloc (metrics_num, sizeof (*metrics));
178 if (metrics == NULL) {
179 ERROR ("tail_csv plugin: calloc failed.");
180 return (ENOMEM);
181 }
183 ptr = buffer;
184 metrics[0] = ptr;
185 i = 1;
186 for (ptr = buffer; *ptr != 0; ptr++) {
187 if (*ptr != ',')
188 continue;
190 *ptr = 0;
191 metrics[i] = ptr + 1;
192 i++;
193 }
194 assert (i == metrics_num);
196 /* Register values */
197 for (i = 0; i < id->metric_list_len; ++i){
198 metric_definition_t *md = id->metric_list[i];
200 if (!tcsv_check_index (md->value_from, metrics_num, md->name)
201 || !tcsv_check_index (id->time_from, metrics_num, md->name))
202 continue;
204 tcsv_read_metric (id, md, metrics, metrics_num);
205 }
207 /* Free up resources */
208 sfree (metrics);
209 return (0);
210 }
212 static int tcsv_read (user_data_t *ud) {
213 instance_definition_t *id;
214 id = ud->data;
216 if (id->tail == NULL)
217 {
218 id->tail = cu_tail_create (id->path);
219 if (id->tail == NULL)
220 {
221 ERROR ("tail_csv plugin: cu_tail_create (\"%s\") failed.",
222 id->path);
223 return (-1);
224 }
225 }
227 while (42)
228 {
229 char buffer[1024];
230 size_t buffer_len;
231 int status;
233 status = cu_tail_readline (id->tail, buffer, (int) sizeof (buffer));
234 if (status != 0)
235 {
236 ERROR ("tail_csv plugin: File \"%s\": cu_tail_readline failed "
237 "with status %i.", id->path, status);
238 return (-1);
239 }
241 buffer_len = strlen (buffer);
242 if (buffer_len == 0)
243 break;
245 tcsv_read_buffer (id, buffer, buffer_len);
246 }
248 return (0);
249 }
251 static void tcsv_metric_definition_destroy(void *arg){
252 metric_definition_t *md;
253 metric_definition_t *next;
255 md = arg;
256 if (md == NULL)
257 return;
259 next = md->next;
260 md->next = NULL;
262 sfree(md->name);
263 sfree(md->type);
264 sfree(md->instance);
265 sfree(md);
267 tcsv_metric_definition_destroy (next);
268 }
270 static int tcsv_config_get_index(oconfig_item_t *ci, ssize_t *ret_index) {
271 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER)){
272 WARNING("tail_csv plugin: The \"%s\" config option needs exactly one "
273 "integer argument.", ci->key);
274 return (-1);
275 }
277 if (ci->values[0].value.number < 0) {
278 WARNING("tail_csv plugin: The \"%s\" config option must be positive "
279 "(or zero).", ci->key);
280 return (-1);
281 }
283 *ret_index = (ssize_t) ci->values[0].value.number;
284 return (0);
285 }
287 /* Parse metric */
288 static int tcsv_config_add_metric(oconfig_item_t *ci){
289 metric_definition_t *md;
290 int status;
291 int i;
293 md = calloc(1, sizeof(*md));
294 if (md == NULL)
295 return (-1);
296 md->name = NULL;
297 md->type = NULL;
298 md->instance = NULL;
299 md->data_source_type = -1;
300 md->value_from = -1;
301 md->next = NULL;
303 status = cf_util_get_string (ci, &md->name);
304 if (status != 0) {
305 sfree (md);
306 return (-1);
307 }
309 for (i = 0; i < ci->children_num; ++i){
310 oconfig_item_t *option = ci->children + i;
312 if (strcasecmp("Type", option->key) == 0)
313 status = cf_util_get_string(option, &md->type);
314 else if (strcasecmp("Instance", option->key) == 0)
315 status = cf_util_get_string(option, &md->instance);
316 else if (strcasecmp("ValueFrom", option->key) == 0)
317 status = tcsv_config_get_index (option, &md->value_from);
318 else {
319 WARNING("tail_csv plugin: Option `%s' not allowed here.", option->key);
320 status = -1;
321 }
323 if (status != 0)
324 break;
325 }
327 if (status != 0){
328 tcsv_metric_definition_destroy(md);
329 return (-1);
330 }
332 /* Verify all necessary options have been set. */
333 if (md->type == NULL) {
334 WARNING("tail_csv plugin: Option `Type' must be set.");
335 status = -1;
336 } else if (md->value_from < 0) {
337 WARNING("tail_csv plugin: Option `ValueFrom' must be set.");
338 status = -1;
339 }
340 if (status != 0) {
341 tcsv_metric_definition_destroy(md);
342 return (status);
343 }
345 if (metric_head == NULL)
346 metric_head = md;
347 else {
348 metric_definition_t *last;
349 last = metric_head;
350 while (last->next != NULL)
351 last = last->next;
352 last->next = md;
353 }
355 return (0);
356 }
358 static void tcsv_instance_definition_destroy(void *arg){
359 instance_definition_t *id;
361 id = arg;
362 if (id == NULL)
363 return;
365 if (id->tail != NULL)
366 cu_tail_destroy (id->tail);
367 id->tail = NULL;
369 sfree(id->instance);
370 sfree(id->path);
371 sfree(id->metric_list);
372 sfree(id);
373 }
375 static int tcsv_config_add_instance_collect(instance_definition_t *id, oconfig_item_t *ci) {
376 metric_definition_t *metric;
377 metric_definition_t **metric_list;
378 size_t metric_list_size;
379 int i;
381 if (ci->values_num < 1) {
382 WARNING("tail_csv plugin: The `Collect' config option needs at least one argument.");
383 return (-1);
384 }
386 metric_list_size = id->metric_list_len + (size_t) ci->values_num;
387 metric_list = realloc (id->metric_list, sizeof (*id->metric_list) * metric_list_size);
388 if (metric_list == NULL)
389 return (-1);
390 id->metric_list = metric_list;
392 for (i = 0; i < ci->values_num; i++) {
393 char *metric_name;
395 if (ci->values[i].type != OCONFIG_TYPE_STRING) {
396 WARNING("tail_csv plugin: All arguments to `Collect' must be strings.");
397 continue;
398 }
399 metric_name = ci->values[i].value.string;
401 for (metric = metric_head; metric != NULL; metric = metric->next)
402 if (strcasecmp(metric_name, metric->name) == 0)
403 break;
405 if (metric == NULL) {
406 WARNING ("tail_csv plugin: `Collect' argument not found `%s'.", metric_name);
407 continue;
408 }
410 id->metric_list[id->metric_list_len] = metric;
411 id->metric_list_len++;
412 }
414 return (0);
415 }
417 /* <File /> block */
418 static int tcsv_config_add_file(oconfig_item_t *ci)
419 {
420 instance_definition_t* id;
421 int status = 0;
422 int i;
424 /* Registration variables */
425 char cb_name[DATA_MAX_NAME_LEN];
426 user_data_t cb_data;
428 id = calloc(1, sizeof(*id));
429 if (id == NULL)
430 return (-1);
431 id->instance = NULL;
432 id->path = NULL;
433 id->metric_list = NULL;
434 id->time_from = -1;
435 id->next = NULL;
437 status = cf_util_get_string (ci, &id->path);
438 if (status != 0) {
439 sfree (id);
440 return (status);
441 }
443 /* Use default interval. */
444 id->interval = plugin_get_interval();
446 for (i = 0; i < ci->children_num; ++i){
447 oconfig_item_t *option = ci->children + i;
448 status = 0;
450 if (strcasecmp("Instance", option->key) == 0)
451 status = cf_util_get_string(option, &id->instance);
452 else if (strcasecmp("Collect", option->key) == 0)
453 status = tcsv_config_add_instance_collect(id, option);
454 else if (strcasecmp("Interval", option->key) == 0)
455 cf_util_get_cdtime(option, &id->interval);
456 else if (strcasecmp("TimeFrom", option->key) == 0)
457 status = tcsv_config_get_index (option, &id->time_from);
458 else {
459 WARNING("tail_csv plugin: Option `%s' not allowed here.", option->key);
460 status = -1;
461 }
463 if (status != 0)
464 break;
465 }
467 if (status != 0){
468 tcsv_instance_definition_destroy(id);
469 return (-1);
470 }
472 /* Verify all necessary options have been set. */
473 if (id->path == NULL){
474 WARNING("tail_csv plugin: Option `Path' must be set.");
475 status = -1;
476 } else if (id->metric_list == NULL){
477 WARNING("tail_csv plugin: Option `Collect' must be set.");
478 status = -1;
479 }
481 if (status != 0){
482 tcsv_instance_definition_destroy(id);
483 return (-1);
484 }
486 ssnprintf (cb_name, sizeof (cb_name), "tail_csv/%s", id->path);
487 memset(&cb_data, 0, sizeof(cb_data));
488 cb_data.data = id;
489 cb_data.free_func = tcsv_instance_definition_destroy;
490 status = plugin_register_complex_read(NULL, cb_name, tcsv_read, id->interval, &cb_data);
492 if (status != 0){
493 ERROR("tail_csv plugin: Registering complex read function failed.");
494 tcsv_instance_definition_destroy(id);
495 return (-1);
496 }
498 return (0);
499 }
501 /* Parse blocks */
502 static int tcsv_config(oconfig_item_t *ci){
503 int i;
504 for (i = 0; i < ci->children_num; ++i){
505 oconfig_item_t *child = ci->children + i;
506 if (strcasecmp("Metric", child->key) == 0)
507 tcsv_config_add_metric(child);
508 else if (strcasecmp("File", child->key) == 0)
509 tcsv_config_add_file(child);
510 else
511 WARNING("tail_csv plugin: Ignore unknown config option `%s'.", child->key);
512 }
514 return (0);
515 } /* int tcsv_config */
517 static int tcsv_init(void) { /* {{{ */
518 static _Bool have_init = 0;
519 metric_definition_t *md;
521 if (have_init)
522 return (0);
524 for (md = metric_head; md != NULL; md = md->next) {
525 data_set_t const *ds;
527 /* Retrieve the data source type from the types db. */
528 ds = plugin_get_ds(md->type);
529 if (ds == NULL)
530 {
531 ERROR ("tail_csv plugin: Failed to look up type \"%s\" for "
532 "metric \"%s\". It may not be defined in the types.db "
533 "file. Please read the types.db(5) manual page for more "
534 "details.",
535 md->type, md->name);
536 continue;
537 }
538 else if (ds->ds_num != 1)
539 {
540 ERROR ("tail_csv plugin: The type \"%s\" has %zu data sources. "
541 "Only types with a single data soure are supported.",
542 ds->type, ds->ds_num);
543 continue;
544 }
546 md->data_source_type = ds->ds->type;
547 }
549 return (0);
550 } /* }}} int tcsv_init */
552 static int tcsv_shutdown (void) {
553 tcsv_metric_definition_destroy (metric_head);
554 metric_head = NULL;
556 return (0);
557 }
559 void module_register(void){
560 plugin_register_complex_config("tail_csv", tcsv_config);
561 plugin_register_init("tail_csv", tcsv_init);
562 plugin_register_shutdown("tail_csv", tcsv_shutdown);
563 }
565 /* vim: set sw=4 sts=4 et : */