2 * collectd - src/write_tsdb.c
3 * Copyright (C) 2012 Pierre-Yves Ritschard
4 * Copyright (C) 2011 Scott Sanders
5 * Copyright (C) 2009 Paul Sadauskas
6 * Copyright (C) 2009 Doug MacEachern
7 * Copyright (C) 2007-2012 Florian octo Forster
8 * Copyright (C) 2013-2014 Limelight Networks, Inc.
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU General Public License as published by the
11 * Free Software Foundation; only version 2 of the License is applicable.
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 * Based on the write_graphite plugin. Authors:
23 * Florian octo Forster <octo at collectd.org>
24 * Doug MacEachern <dougm at hyperic.com>
25 * Paul Sadauskas <psadauskas at gmail.com>
26 * Scott Sanders <scott at jssjr.com>
27 * Pierre-Yves Ritschard <pyr at spootnik.org>
29 * Brett Hawn <bhawn at llnw.com>
30 * Kevin Bowling <kbowling@llnw.com>
33 /* write_tsdb plugin configuation example
40 * HostTags "status=production deviceclass=www"
48 #include "configfile.h"
50 #include "utils_cache.h"
51 #include "utils_parse_option.h"
54 #include <sys/socket.h>
57 #ifndef WT_DEFAULT_NODE
58 # define WT_DEFAULT_NODE "localhost"
61 #ifndef WT_DEFAULT_SERVICE
62 # define WT_DEFAULT_SERVICE "4242"
65 #ifndef WT_DEFAULT_ESCAPE
66 # define WT_DEFAULT_ESCAPE '.'
69 /* Ethernet - (IPv6 + TCP) = 1500 - (40 + 32) = 1428 */
70 #ifndef WT_SEND_BUF_SIZE
71 # define WT_SEND_BUF_SIZE 1428
88 _Bool separate_instances;
89 _Bool always_append_ds;
91 char send_buf[WT_SEND_BUF_SIZE];
94 cdtime_t send_buf_init_time;
96 pthread_mutex_t send_lock;
103 static void wt_reset_buffer(struct wt_callback *cb)
105 memset(cb->send_buf, 0, sizeof(cb->send_buf));
106 cb->send_buf_free = sizeof(cb->send_buf);
107 cb->send_buf_fill = 0;
108 cb->send_buf_init_time = cdtime();
111 static int wt_send_buffer(struct wt_callback *cb)
115 status = swrite(cb->sock_fd, cb->send_buf, strlen(cb->send_buf));
119 ERROR("write_tsdb plugin: send failed with status %zi (%s)",
120 status, sstrerror (errno, errbuf, sizeof (errbuf)));
131 /* NOTE: You must hold cb->send_lock when calling this function! */
132 static int wt_flush_nolock(cdtime_t timeout, struct wt_callback *cb)
136 DEBUG("write_tsdb plugin: wt_flush_nolock: timeout = %.3f; "
137 "send_buf_fill = %zu;",
141 /* timeout == 0 => flush unconditionally */
147 if ((cb->send_buf_init_time + timeout) > now)
151 if (cb->send_buf_fill <= 0)
153 cb->send_buf_init_time = cdtime();
157 status = wt_send_buffer(cb);
163 static int wt_callback_init(struct wt_callback *cb)
165 struct addrinfo ai_hints;
166 struct addrinfo *ai_list;
167 struct addrinfo *ai_ptr;
170 const char *node = cb->node ? cb->node : WT_DEFAULT_NODE;
171 const char *service = cb->service ? cb->service : WT_DEFAULT_SERVICE;
176 memset(&ai_hints, 0, sizeof(ai_hints));
178 ai_hints.ai_flags |= AI_ADDRCONFIG;
180 ai_hints.ai_family = AF_UNSPEC;
181 ai_hints.ai_socktype = SOCK_STREAM;
185 status = getaddrinfo(node, service, &ai_hints, &ai_list);
188 ERROR("write_tsdb plugin: getaddrinfo (%s, %s) failed: %s",
189 node, service, gai_strerror (status));
193 assert (ai_list != NULL);
194 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
196 cb->sock_fd = socket(ai_ptr->ai_family, ai_ptr->ai_socktype,
197 ai_ptr->ai_protocol);
201 status = connect(cb->sock_fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
212 freeaddrinfo(ai_list);
217 ERROR("write_tsdb plugin: Connecting to %s:%s failed. "
218 "The last error was: %s", node, service,
219 sstrerror (errno, errbuf, sizeof(errbuf)));
229 static void wt_callback_free(void *data)
231 struct wt_callback *cb;
238 pthread_mutex_lock(&cb->send_lock);
240 wt_flush_nolock(0, cb);
248 sfree(cb->host_tags);
250 pthread_mutex_destroy(&cb->send_lock);
255 static int wt_flush(cdtime_t timeout,
256 const char *identifier __attribute__((unused)),
257 user_data_t *user_data)
259 struct wt_callback *cb;
262 if (user_data == NULL)
265 cb = user_data->data;
267 pthread_mutex_lock(&cb->send_lock);
271 status = wt_callback_init(cb);
274 ERROR("write_tsdb plugin: wt_callback_init failed.");
275 pthread_mutex_unlock(&cb->send_lock);
280 status = wt_flush_nolock(timeout, cb);
281 pthread_mutex_unlock(&cb->send_lock);
286 static int wt_format_values(char *ret, size_t ret_len,
287 int ds_num, const data_set_t *ds,
288 const value_list_t *vl,
293 gauge_t *rates = NULL;
295 assert(0 == strcmp (ds->type, vl->type));
297 memset(ret, 0, ret_len);
299 #define BUFFER_ADD(...) do { \
300 status = ssnprintf (ret + offset, ret_len - offset, \
307 else if (((size_t) status) >= (ret_len - offset)) \
313 offset += ((size_t) status); \
316 if (ds->ds[ds_num].type == DS_TYPE_GAUGE)
317 BUFFER_ADD("%f", vl->values[ds_num].gauge);
318 else if (store_rates)
321 rates = uc_get_rate (ds, vl);
324 WARNING("format_values: "
325 "uc_get_rate failed.");
328 BUFFER_ADD("%f", rates[ds_num]);
330 else if (ds->ds[ds_num].type == DS_TYPE_COUNTER)
331 BUFFER_ADD("%llu", vl->values[ds_num].counter);
332 else if (ds->ds[ds_num].type == DS_TYPE_DERIVE)
333 BUFFER_ADD("%" PRIi64, vl->values[ds_num].derive);
334 else if (ds->ds[ds_num].type == DS_TYPE_ABSOLUTE)
335 BUFFER_ADD("%" PRIu64, vl->values[ds_num].absolute);
338 ERROR("format_values plugin: Unknown data source type: %i",
339 ds->ds[ds_num].type);
350 static int wt_format_name(char *ret, int ret_len,
351 const value_list_t *vl,
352 const struct wt_callback *cb,
361 if (ds_name != NULL) {
362 if (vl->plugin_instance[0] == '\0') {
363 ssnprintf(ret, ret_len, "%s.%s.%s",
364 prefix, vl->plugin, ds_name);
365 } else if (vl->type_instance == '\0') {
366 ssnprintf(ret, ret_len, "%s.%s.%s.%s.%s",
367 prefix, vl->plugin, vl->plugin_instance,
368 vl->type_instance, ds_name);
370 ssnprintf(ret, ret_len, "%s.%s.%s.%s.%s",
371 prefix, vl->plugin, vl->plugin_instance, vl->type,
374 } else if (vl->plugin_instance[0] == '\0') {
375 if (vl->type_instance[0] == '\0')
376 ssnprintf(ret, ret_len, "%s.%s.%s",
377 prefix, vl->plugin, vl->type);
379 ssnprintf(ret, ret_len, "%s.%s.%s",
380 prefix, vl->plugin, vl->type_instance);
381 } else if (vl->type_instance[0] == '\0') {
382 ssnprintf(ret, ret_len, "%s.%s.%s.%s",
383 prefix, vl->plugin, vl->plugin_instance, vl->type);
385 ssnprintf(ret, ret_len, "%s.%s.%s.%s",
386 prefix, vl->plugin, vl->plugin_instance, vl->type_instance);
392 static int wt_send_message (const char* key, const char* value,
393 cdtime_t time, struct wt_callback *cb,
398 const char *message_fmt;
401 /* skip if value is NaN */
405 message_fmt = "put %s %u %s fqdn=%s %s\r\n";
406 message_len = ssnprintf (message, sizeof(message),
409 (unsigned int)CDTIME_T_TO_TIME_T(
414 if (message_len >= sizeof(message)) {
415 ERROR("write_tsdb plugin: message buffer too small: "
416 "Need %d bytes.", message_len + 1);
420 pthread_mutex_lock(&cb->send_lock);
424 status = wt_callback_init(cb);
427 ERROR("write_tsdb plugin: wt_callback_init failed.");
428 pthread_mutex_unlock(&cb->send_lock);
433 if (message_len >= cb->send_buf_free)
435 status = wt_flush_nolock(0, cb);
438 pthread_mutex_unlock(&cb->send_lock);
443 /* Assert that we have enough space for this message. */
444 assert(message_len < cb->send_buf_free);
446 /* `message_len + 1' because `message_len' does not include the
447 * trailing null byte. Neither does `send_buffer_fill'. */
448 memcpy(cb->send_buf + cb->send_buf_fill,
449 message, message_len + 1);
450 cb->send_buf_fill += message_len;
451 cb->send_buf_free -= message_len;
453 DEBUG("write_tsdb plugin: [%s]:%s buf %zu/%zu (%.1f %%) \"%s\"",
456 cb->send_buf_fill, sizeof(cb->send_buf),
457 100.0 * ((double) cb->send_buf_fill) /
458 ((double) sizeof(cb->send_buf)),
461 pthread_mutex_unlock(&cb->send_lock);
466 static int wt_write_messages(const data_set_t *ds, const value_list_t *vl,
467 struct wt_callback *cb)
469 char key[10*DATA_MAX_NAME_LEN];
474 if (0 != strcmp(ds->type, vl->type))
476 ERROR("write_tsdb plugin: DS type does not match "
481 for (i = 0; i < ds->ds_num; i++)
483 const char *ds_name = NULL;
485 if (cb->always_append_ds || (ds->ds_num > 1))
486 ds_name = ds->ds[i].name;
488 /* Copy the identifier to 'key' and escape it. */
489 status = wt_format_name(key, sizeof(key), vl, cb, ds_name);
492 ERROR("write_tsdb plugin: error with format_name");
496 escape_string(key, sizeof(key));
497 /* Convert the values to an ASCII representation and put that into
499 status = wt_format_values(values, sizeof(values), i, ds, vl,
503 ERROR("write_tsdb plugin: error with "
508 /* Send the message to tsdb */
509 status = wt_send_message(key, values, vl->time, cb, vl->host);
512 ERROR("write_tsdb plugin: error with "
521 static int wt_write(const data_set_t *ds, const value_list_t *vl,
522 user_data_t *user_data)
524 struct wt_callback *cb;
527 if (user_data == NULL)
530 cb = user_data->data;
532 status = wt_write_messages(ds, vl, cb);
537 static int config_set_char(char *dest,
543 memset(buffer, 0, sizeof(buffer));
545 status = cf_util_get_string_buffer(ci, buffer, sizeof(buffer));
551 ERROR("write_tsdb plugin: Cannot use an empty string for the "
552 "\"EscapeCharacter\" option.");
558 WARNING("write_tsdb plugin: Only the first character of the "
559 "\"EscapeCharacter\" option ('%c') will be used.",
568 static int wt_config_tsd(oconfig_item_t *ci)
570 struct wt_callback *cb;
571 user_data_t user_data;
572 char callback_name[DATA_MAX_NAME_LEN];
575 cb = malloc(sizeof(*cb));
578 ERROR("write_tsdb plugin: malloc failed.");
581 memset(cb, 0, sizeof(*cb));
586 cb->host_tags = NULL;
587 cb->escape_char = WT_DEFAULT_ESCAPE;
590 pthread_mutex_init (&cb->send_lock, NULL);
592 for (i = 0; i < ci->children_num; i++)
594 oconfig_item_t *child = ci->children + i;
596 if (strcasecmp("Host", child->key) == 0)
597 cf_util_get_string(child, &cb->node);
598 else if (strcasecmp("Port", child->key) == 0)
599 cf_util_get_service(child, &cb->service);
600 else if (strcasecmp("Prefix", child->key) == 0)
601 cf_util_get_string(child, &cb->prefix);
602 else if (strcasecmp("HostTags", child->key) == 0)
603 cf_util_get_string(child, &cb->host_tags);
604 else if (strcasecmp("StoreRates", child->key) == 0)
605 cf_util_get_boolean(child, &cb->store_rates);
606 else if (strcasecmp("SeparateInstances", child->key) == 0)
607 cf_util_get_boolean(child, &cb->separate_instances);
608 else if (strcasecmp("AlwaysAppendDS", child->key) == 0)
609 cf_util_get_boolean(child, &cb->always_append_ds);
610 else if (strcasecmp("EscapeCharacter", child->key) == 0)
611 config_set_char(&cb->escape_char, child);
614 ERROR("write_tsdb plugin: Invalid configuration "
615 "option: %s.", child->key);
619 ssnprintf(callback_name, sizeof(callback_name), "write_tsdb/%s/%s",
620 cb->node != NULL ? cb->node : WT_DEFAULT_NODE,
621 cb->service != NULL ? cb->service : WT_DEFAULT_SERVICE);
623 memset(&user_data, 0, sizeof(user_data));
625 user_data.free_func = wt_callback_free;
626 plugin_register_write(callback_name, wt_write, &user_data);
628 user_data.free_func = NULL;
629 plugin_register_flush(callback_name, wt_flush, &user_data);
634 static int wt_config(oconfig_item_t *ci)
638 for (i = 0; i < ci->children_num; i++)
640 oconfig_item_t *child = ci->children + i;
642 if (strcasecmp("Node", child->key) == 0)
643 wt_config_tsd(child);
646 ERROR("write_tsdb plugin: Invalid configuration "
647 "option: %s.", child->key);
654 void module_register(void)
656 plugin_register_complex_config("write_tsdb", wt_config);
659 /* vim: set sw=4 ts=4 sts=4 tw=78 et : */