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>
26 #include "common.h" /* auxiliary functions */
27 #include "plugin.h" /* plugin_register_*, plugin_dispatch_values */
28 #include "utils_tail.h"
36 struct metric_definition_s {
42 struct metric_definition_s *next;
44 typedef struct metric_definition_s metric_definition_t;
46 struct instance_definition_s {
51 metric_definition_t **metric_list;
52 size_t metric_list_len;
55 struct instance_definition_s *next;
57 typedef struct instance_definition_s instance_definition_t;
60 static metric_definition_t *metric_head = NULL;
62 static int tcsv_submit(instance_definition_t *id, metric_definition_t *md,
63 value_t v, cdtime_t t) {
64 /* Registration variables */
65 value_list_t vl = VALUE_LIST_INIT;
71 sstrncpy(vl.plugin, (id->plugin_name != NULL) ? id->plugin_name : "tail_csv",
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) {
90 t = strtod(tbuf, &endptr);
91 if ((errno != 0) || (endptr == NULL) || (endptr[0] != 0))
94 return DOUBLE_TO_CDTIME_T(t);
97 static int tcsv_read_metric(instance_definition_t *id, metric_definition_t *md,
98 char **fields, size_t fields_num) {
103 if (md->data_source_type == -1)
106 assert(md->value_from >= 0);
107 if (((size_t)md->value_from) >= fields_num)
110 status = parse_value(fields[md->value_from], &v, md->data_source_type);
114 if (id->time_from >= 0) {
115 if (((size_t)id->time_from) >= fields_num)
117 t = parse_time(fields[id->time_from]);
120 return tcsv_submit(id, md, v, t);
123 static _Bool tcsv_check_index(ssize_t index, size_t fields_num,
127 else if (((size_t)index) < fields_num)
130 ERROR("tail_csv plugin: Metric \"%s\": Request for index %zd when "
131 "only %zu fields are available.",
132 name, index, fields_num);
136 static int tcsv_read_buffer(instance_definition_t *id, char *buffer,
137 size_t buffer_size) {
144 /* Remove newlines at the end of line. */
145 while (buffer_size > 0) {
146 if ((buffer[buffer_size - 1] == '\n') ||
147 (buffer[buffer_size - 1] == '\r')) {
148 buffer[buffer_size - 1] = 0;
155 /* Ignore empty lines. */
156 if ((buffer_size == 0) || (buffer[0] == '#'))
159 /* Count the number of fields. */
161 for (i = 0; i < buffer_size; i++) {
162 if (buffer[i] == ',')
166 if (metrics_num == 1) {
167 ERROR("tail_csv plugin: last line of `%s' does not contain "
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) {
214 id->tail = cu_tail_create(id->path);
215 if (id->tail == NULL) {
216 ERROR("tail_csv plugin: cu_tail_create (\"%s\") failed.", id->path);
226 status = cu_tail_readline(id->tail, buffer, (int)sizeof(buffer));
228 ERROR("tail_csv plugin: File \"%s\": cu_tail_readline failed "
234 buffer_len = strlen(buffer);
238 tcsv_read_buffer(id, buffer, buffer_len);
244 static void tcsv_metric_definition_destroy(void *arg) {
245 metric_definition_t *md;
246 metric_definition_t *next;
260 tcsv_metric_definition_destroy(next);
263 static int tcsv_config_get_index(oconfig_item_t *ci, ssize_t *ret_index) {
264 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER)) {
265 WARNING("tail_csv plugin: The \"%s\" config option needs exactly one "
271 if (ci->values[0].value.number < 0) {
272 WARNING("tail_csv plugin: The \"%s\" config option must be positive "
278 *ret_index = (ssize_t)ci->values[0].value.number;
283 static int tcsv_config_add_metric(oconfig_item_t *ci) {
284 metric_definition_t *md;
287 md = calloc(1, sizeof(*md));
293 md->data_source_type = -1;
297 status = cf_util_get_string(ci, &md->name);
303 for (int i = 0; i < ci->children_num; ++i) {
304 oconfig_item_t *option = ci->children + i;
306 if (strcasecmp("Type", option->key) == 0)
307 status = cf_util_get_string(option, &md->type);
308 else if (strcasecmp("Instance", option->key) == 0)
309 status = cf_util_get_string(option, &md->instance);
310 else if (strcasecmp("ValueFrom", option->key) == 0)
311 status = tcsv_config_get_index(option, &md->value_from);
313 WARNING("tail_csv plugin: Option `%s' not allowed here.", option->key);
322 tcsv_metric_definition_destroy(md);
326 /* Verify all necessary options have been set. */
327 if (md->type == NULL) {
328 WARNING("tail_csv plugin: Option `Type' must be set.");
330 } else if (md->value_from < 0) {
331 WARNING("tail_csv plugin: Option `ValueFrom' must be set.");
335 tcsv_metric_definition_destroy(md);
339 if (metric_head == NULL)
342 metric_definition_t *last;
344 while (last->next != NULL)
352 static void tcsv_instance_definition_destroy(void *arg) {
353 instance_definition_t *id;
359 if (id->tail != NULL)
360 cu_tail_destroy(id->tail);
363 sfree(id->plugin_name);
366 sfree(id->metric_list);
370 static int tcsv_config_add_instance_collect(instance_definition_t *id,
371 oconfig_item_t *ci) {
372 metric_definition_t *metric;
373 metric_definition_t **metric_list;
374 size_t metric_list_size;
376 if (ci->values_num < 1) {
377 WARNING("tail_csv plugin: The `Collect' config option needs at least one "
382 metric_list_size = id->metric_list_len + (size_t)ci->values_num;
384 realloc(id->metric_list, sizeof(*id->metric_list) * metric_list_size);
385 if (metric_list == NULL)
387 id->metric_list = metric_list;
389 for (int i = 0; i < ci->values_num; i++) {
392 if (ci->values[i].type != OCONFIG_TYPE_STRING) {
393 WARNING("tail_csv plugin: All arguments to `Collect' must be strings.");
396 metric_name = ci->values[i].value.string;
398 for (metric = metric_head; metric != NULL; metric = metric->next)
399 if (strcasecmp(metric_name, metric->name) == 0)
402 if (metric == NULL) {
403 WARNING("tail_csv plugin: `Collect' argument not found `%s'.",
408 id->metric_list[id->metric_list_len] = metric;
409 id->metric_list_len++;
416 static int tcsv_config_add_file(oconfig_item_t *ci) {
417 instance_definition_t *id;
420 /* Registration variables */
421 char cb_name[DATA_MAX_NAME_LEN];
423 id = calloc(1, sizeof(*id));
426 id->plugin_name = NULL;
429 id->metric_list = NULL;
433 status = cf_util_get_string(ci, &id->path);
439 /* Use default interval. */
440 id->interval = plugin_get_interval();
442 for (int i = 0; i < ci->children_num; ++i) {
443 oconfig_item_t *option = ci->children + i;
446 if (strcasecmp("Instance", option->key) == 0)
447 status = cf_util_get_string(option, &id->instance);
448 else if (strcasecmp("Collect", option->key) == 0)
449 status = tcsv_config_add_instance_collect(id, option);
450 else if (strcasecmp("Interval", option->key) == 0)
451 cf_util_get_cdtime(option, &id->interval);
452 else if (strcasecmp("TimeFrom", option->key) == 0)
453 status = tcsv_config_get_index(option, &id->time_from);
454 else if (strcasecmp("Plugin", option->key) == 0)
455 status = cf_util_get_string(option, &id->plugin_name);
457 WARNING("tail_csv plugin: Option `%s' not allowed here.", option->key);
466 tcsv_instance_definition_destroy(id);
470 /* Verify all necessary options have been set. */
471 if (id->path == NULL) {
472 WARNING("tail_csv plugin: Option `Path' must be set.");
474 } else if (id->metric_list == NULL) {
475 WARNING("tail_csv plugin: Option `Collect' must be set.");
480 tcsv_instance_definition_destroy(id);
484 snprintf(cb_name, sizeof(cb_name), "tail_csv/%s", id->path);
486 status = plugin_register_complex_read(
487 NULL, cb_name, tcsv_read, id->interval,
489 .data = id, .free_func = tcsv_instance_definition_destroy,
492 ERROR("tail_csv plugin: Registering complex read function failed.");
500 static int tcsv_config(oconfig_item_t *ci) {
501 for (int i = 0; i < ci->children_num; ++i) {
502 oconfig_item_t *child = ci->children + i;
503 if (strcasecmp("Metric", child->key) == 0)
504 tcsv_config_add_metric(child);
505 else if (strcasecmp("File", child->key) == 0)
506 tcsv_config_add_file(child);
508 WARNING("tail_csv plugin: Ignore unknown config option `%s'.",
513 } /* int tcsv_config */
515 static int tcsv_init(void) { /* {{{ */
516 static _Bool have_init = 0;
517 metric_definition_t *md;
522 for (md = metric_head; md != NULL; md = md->next) {
523 data_set_t const *ds;
525 /* Retrieve the data source type from the types db. */
526 ds = plugin_get_ds(md->type);
528 ERROR("tail_csv plugin: Failed to look up type \"%s\" for "
529 "metric \"%s\". It may not be defined in the types.db "
530 "file. Please read the types.db(5) manual page for more "
534 } else if (ds->ds_num != 1) {
535 ERROR("tail_csv plugin: The type \"%s\" has %zu data sources. "
536 "Only types with a single data source are supported.",
537 ds->type, ds->ds_num);
541 md->data_source_type = ds->ds->type;
545 } /* }}} int tcsv_init */
547 static int tcsv_shutdown(void) {
548 tcsv_metric_definition_destroy(metric_head);
554 void module_register(void) {
555 plugin_register_complex_config("tail_csv", tcsv_config);
556 plugin_register_init("tail_csv", tcsv_init);
557 plugin_register_shutdown("tail_csv", tcsv_shutdown);