2 * collectd - src/tail_csv.c
3 * Copyright (C) 2013 Kris Nielander
4 * Copyright (C) 2013 Florian Forster
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.
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.
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
20 * Kris Nielander <nielander at fox-it.com>
21 * Florian Forster <octo at collectd.org>
25 #include "plugin.h" /* plugin_register_*, plugin_dispatch_values */
26 #include "common.h" /* auxiliary functions */
27 #include "utils_tail.h"
35 struct metric_definition_s {
41 struct metric_definition_s *next;
43 typedef struct metric_definition_s metric_definition_t;
45 struct instance_definition_s {
49 metric_definition_t **metric_list;
50 size_t metric_list_len;
53 struct instance_definition_s *next;
55 typedef struct instance_definition_s instance_definition_t;
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)
64 /* Registration variables */
65 value_list_t vl = VALUE_LIST_INIT;
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));
80 vl.interval = id->interval;
82 return (plugin_dispatch_values(&vl));
85 static cdtime_t parse_time (char const *tbuf)
91 t = strtod (tbuf, &endptr);
92 if ((errno != 0) || (endptr == NULL) || (endptr[0] != 0))
95 return (DOUBLE_TO_CDTIME_T (t));
98 static int tcsv_read_metric (instance_definition_t *id,
99 metric_definition_t *md,
100 char **fields, size_t fields_num)
106 if (md->data_source_type == -1)
109 if ((md->value_from >= fields_num) || (id->time_from >= fields_num))
113 if (id->time_from >= 0)
114 t = parse_time (fields[id->time_from]);
116 status = parse_value (fields[md->value_from], &v, md->data_source_type);
120 return (tcsv_submit (id, md, v, t));
123 static _Bool tcsv_check_index (int index, size_t fields_num, char const *name)
127 else if (((size_t) index) < fields_num)
130 ERROR ("tail_csv plugin: Metric \"%s\": Request for index %i when "
131 "only %zu fields are available.",
132 name, index, fields_num);
136 static int tcsv_read_buffer (instance_definition_t *id,
137 char *buffer, size_t buffer_size)
145 /* Remove newlines at the end of line. */
146 while (buffer_size > 0) {
147 if ((buffer[buffer_size - 1] == '\n')
148 || (buffer[buffer_size - 1] == '\r')) {
149 buffer[buffer_size - 1] = 0;
156 /* Ignore empty lines. */
157 if ((buffer_size == 0) || (buffer[0] == '#'))
160 /* Count the number of fields. */
162 for (i = 0; i < buffer_size; i++) {
163 if (buffer[i] == ',')
167 if (metrics_num == 1) {
168 ERROR("tail_csv plugin: last line of `%s' does not contain "
169 "enough values.", id->path);
173 /* Create a list of all values */
174 metrics = calloc (metrics_num, sizeof (*metrics));
175 if (metrics == NULL) {
176 ERROR ("tail_csv plugin: calloc failed.");
183 for (ptr = buffer; *ptr != 0; ptr++) {
188 metrics[i] = ptr + 1;
191 assert (i == metrics_num);
193 /* Register values */
194 for (i = 0; i < id->metric_list_len; ++i){
195 metric_definition_t *md = id->metric_list[i];
197 if (!tcsv_check_index (md->value_from, metrics_num, md->name)
198 || !tcsv_check_index (id->time_from, metrics_num, md->name))
201 tcsv_read_metric (id, md, metrics, metrics_num);
204 /* Free up resources */
209 static int tcsv_read (user_data_t *ud) {
210 instance_definition_t *id;
213 if (id->tail == NULL)
215 id->tail = cu_tail_create (id->path);
216 if (id->tail == NULL)
218 ERROR ("tail_csv plugin: cu_tail_create (\"%s\") failed.",
230 status = cu_tail_readline (id->tail, buffer, (int) sizeof (buffer));
233 ERROR ("tail_csv plugin: File \"%s\": cu_tail_readline failed "
234 "with status %i.", id->path, status);
238 buffer_len = strlen (buffer);
242 tcsv_read_buffer (id, buffer, buffer_len);
248 static void tcsv_metric_definition_destroy(void *arg){
249 metric_definition_t *md;
250 metric_definition_t *next;
264 tcsv_metric_definition_destroy (next);
267 static int tcsv_config_get_index(oconfig_item_t *ci, int *ret_index) {
270 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER)){
271 WARNING("tail_csv plugin: The \"%s\" config option needs exactly one "
272 "integer argument.", ci->key);
276 index = (int) ci->values[0].value.number;
278 WARNING("tail_csv plugin: The \"%s\" config option must be positive "
279 "(or zero).", ci->key);
288 static int tcsv_config_add_metric(oconfig_item_t *ci){
289 metric_definition_t *md;
293 md = (metric_definition_t *)malloc(sizeof(*md));
296 memset(md, 0, sizeof(*md));
300 md->data_source_type = -1;
304 status = cf_util_get_string (ci, &md->name);
310 for (i = 0; i < ci->children_num; ++i){
311 oconfig_item_t *option = ci->children + i;
314 if (strcasecmp("Type", option->key) == 0)
315 status = cf_util_get_string(option, &md->type);
316 else if (strcasecmp("Instance", option->key) == 0)
317 status = cf_util_get_string(option, &md->instance);
318 else if (strcasecmp("ValueFrom", option->key) == 0)
319 status = tcsv_config_get_index (option, &md->value_from);
321 WARNING("tail_csv plugin: Option `%s' not allowed here.", option->key);
330 tcsv_metric_definition_destroy(md);
334 /* Verify all necessary options have been set. */
335 if (md->type == NULL) {
336 WARNING("tail_csv plugin: Option `Type' must be set.");
338 } else if (md->value_from < 0) {
339 WARNING("tail_csv plugin: Option `ValueFrom' must be set.");
343 tcsv_metric_definition_destroy(md);
347 if (metric_head == NULL)
350 metric_definition_t *last;
352 while (last->next != NULL)
360 static void tcsv_instance_definition_destroy(void *arg){
361 instance_definition_t *id;
367 if (id->tail != NULL)
368 cu_tail_destroy (id->tail);
373 sfree(id->metric_list);
377 static int tcsv_config_add_instance_collect(instance_definition_t *id, oconfig_item_t *ci){
378 metric_definition_t *metric;
381 if (ci->values_num < 1){
382 WARNING("tail_csv plugin: The `Collect' config option needs at least one argument.");
386 /* Verify string arguments */
387 for (i = 0; i < ci->values_num; ++i)
388 if (ci->values[i].type != OCONFIG_TYPE_STRING){
389 WARNING("tail_csv plugin: All arguments to `Collect' must be strings.");
393 id->metric_list = (metric_definition_t **)malloc(sizeof(metric_definition_t *) * ci->values_num);
394 if (id->metric_list == NULL)
397 for (i = 0; i < ci->values_num; ++i){
398 for (metric = metric_head; metric != NULL; metric = metric->next)
399 if (strcasecmp(ci->values[i].value.string, metric->name) == 0)
403 WARNING("tail_csv plugin: `Collect' argument not found `%s'.", ci->values[i].value.string);
407 id->metric_list[i] = metric;
408 id->metric_list_len++;
415 static int tcsv_config_add_file(oconfig_item_t *ci)
417 instance_definition_t* id;
421 /* Registration variables */
422 char cb_name[DATA_MAX_NAME_LEN];
424 struct timespec cb_interval;
426 id = malloc(sizeof(*id));
429 memset(id, 0, sizeof(*id));
432 id->metric_list = NULL;
436 status = cf_util_get_string (ci, &id->path);
442 /* Use default interval. */
443 id->interval = plugin_get_interval();
445 for (i = 0; i < ci->children_num; ++i){
446 oconfig_item_t *option = ci->children + i;
449 if (strcasecmp("Instance", option->key) == 0)
450 status = cf_util_get_string(option, &id->instance);
451 else if (strcasecmp("Collect", option->key) == 0)
452 status = tcsv_config_add_instance_collect(id, option);
453 else if (strcasecmp("Interval", option->key) == 0)
454 cf_util_get_cdtime(option, &id->interval);
455 else if (strcasecmp("TimeFrom", option->key) == 0)
456 status = tcsv_config_get_index (option, &id->time_from);
458 WARNING("tail_csv plugin: Option `%s' not allowed here.", option->key);
467 tcsv_instance_definition_destroy(id);
471 /* Verify all necessary options have been set. */
472 if (id->path == NULL){
473 WARNING("tail_csv plugin: Option `Path' must be set.");
475 } else if (id->metric_list == NULL){
476 WARNING("tail_csv plugin: Option `Collect' must be set.");
481 tcsv_instance_definition_destroy(id);
485 ssnprintf (cb_name, sizeof (cb_name), "tail_csv/%s", id->path);
486 memset(&cb_data, 0, sizeof(cb_data));
488 cb_data.free_func = tcsv_instance_definition_destroy;
489 CDTIME_T_TO_TIMESPEC(id->interval, &cb_interval);
490 status = plugin_register_complex_read(NULL, cb_name, tcsv_read, &cb_interval, &cb_data);
493 ERROR("tail_csv plugin: Registering complex read function failed.");
494 tcsv_instance_definition_destroy(id);
502 static int tcsv_config(oconfig_item_t *ci){
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);
511 WARNING("tail_csv plugin: Ignore unknown config option `%s'.", child->key);
515 } /* int tcsv_config */
517 static int tcsv_init(void) { /* {{{ */
518 static _Bool have_init = 0;
519 metric_definition_t *md;
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);
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 "
538 else if (ds->ds_num != 1)
540 ERROR ("tail_csv plugin: The type \"%s\" has %i data sources. "
541 "Only types with a single data soure are supported.",
542 ds->type, ds->ds_num);
546 md->data_source_type = ds->ds->type;
550 } /* }}} int tcsv_init */
552 static int tcsv_shutdown (void) {
553 tcsv_metric_definition_destroy (metric_head);
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);
565 /* vim: set sw=4 sts=4 et : */