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
39 * HostTags "status=production deviceclass=www"
48 #include "configfile.h"
50 #include "utils_cache.h"
54 #ifndef WT_DEFAULT_NODE
55 # define WT_DEFAULT_NODE "localhost"
58 #ifndef WT_DEFAULT_SERVICE
59 # define WT_DEFAULT_SERVICE "4242"
62 #ifndef WT_DEFAULT_ESCAPE
63 # define WT_DEFAULT_ESCAPE '.'
66 /* Ethernet - (IPv6 + TCP) = 1500 - (40 + 32) = 1428 */
67 #ifndef WT_SEND_BUF_SIZE
68 # define WT_SEND_BUF_SIZE 1428
83 _Bool always_append_ds;
85 char send_buf[WT_SEND_BUF_SIZE];
88 cdtime_t send_buf_init_time;
90 pthread_mutex_t send_lock;
97 static void wt_reset_buffer(struct wt_callback *cb)
99 memset(cb->send_buf, 0, sizeof(cb->send_buf));
100 cb->send_buf_free = sizeof(cb->send_buf);
101 cb->send_buf_fill = 0;
102 cb->send_buf_init_time = cdtime();
105 static int wt_send_buffer(struct wt_callback *cb)
109 status = swrite(cb->sock_fd, cb->send_buf, strlen(cb->send_buf));
113 ERROR("write_tsdb plugin: send failed with status %zi (%s)",
114 status, sstrerror (errno, errbuf, sizeof (errbuf)));
125 /* NOTE: You must hold cb->send_lock when calling this function! */
126 static int wt_flush_nolock(cdtime_t timeout, struct wt_callback *cb)
130 DEBUG("write_tsdb plugin: wt_flush_nolock: timeout = %.3f; "
131 "send_buf_fill = %zu;",
135 /* timeout == 0 => flush unconditionally */
141 if ((cb->send_buf_init_time + timeout) > now)
145 if (cb->send_buf_fill == 0)
147 cb->send_buf_init_time = cdtime();
151 status = wt_send_buffer(cb);
157 static int wt_callback_init(struct wt_callback *cb)
159 struct addrinfo *ai_list;
162 const char *node = cb->node ? cb->node : WT_DEFAULT_NODE;
163 const char *service = cb->service ? cb->service : WT_DEFAULT_SERVICE;
168 struct addrinfo ai_hints = {
169 .ai_family = AF_UNSPEC,
170 .ai_flags = AI_ADDRCONFIG,
171 .ai_socktype = SOCK_STREAM
174 status = getaddrinfo(node, service, &ai_hints, &ai_list);
177 ERROR("write_tsdb plugin: getaddrinfo (%s, %s) failed: %s",
178 node, service, gai_strerror (status));
182 assert (ai_list != NULL);
183 for (struct addrinfo *ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
185 cb->sock_fd = socket(ai_ptr->ai_family, ai_ptr->ai_socktype,
186 ai_ptr->ai_protocol);
190 status = connect(cb->sock_fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
201 freeaddrinfo(ai_list);
206 ERROR("write_tsdb plugin: Connecting to %s:%s failed. "
207 "The last error was: %s", node, service,
208 sstrerror (errno, errbuf, sizeof(errbuf)));
217 static void wt_callback_free(void *data)
219 struct wt_callback *cb;
226 pthread_mutex_lock(&cb->send_lock);
228 wt_flush_nolock(0, cb);
235 sfree(cb->host_tags);
237 pthread_mutex_destroy(&cb->send_lock);
242 static int wt_flush(cdtime_t timeout,
243 const char *identifier __attribute__((unused)),
244 user_data_t *user_data)
246 struct wt_callback *cb;
249 if (user_data == NULL)
252 cb = user_data->data;
254 pthread_mutex_lock(&cb->send_lock);
258 status = wt_callback_init(cb);
261 ERROR("write_tsdb plugin: wt_callback_init failed.");
262 pthread_mutex_unlock(&cb->send_lock);
267 status = wt_flush_nolock(timeout, cb);
268 pthread_mutex_unlock(&cb->send_lock);
273 static int wt_format_values(char *ret, size_t ret_len,
274 int ds_num, const data_set_t *ds,
275 const value_list_t *vl,
280 gauge_t *rates = NULL;
282 assert(0 == strcmp (ds->type, vl->type));
284 memset(ret, 0, ret_len);
286 #define BUFFER_ADD(...) do { \
287 status = ssnprintf (ret + offset, ret_len - offset, \
294 else if (((size_t) status) >= (ret_len - offset)) \
300 offset += ((size_t) status); \
303 if (ds->ds[ds_num].type == DS_TYPE_GAUGE)
304 BUFFER_ADD(GAUGE_FORMAT, vl->values[ds_num].gauge);
305 else if (store_rates)
308 rates = uc_get_rate (ds, vl);
311 WARNING("format_values: "
312 "uc_get_rate failed.");
315 BUFFER_ADD(GAUGE_FORMAT, rates[ds_num]);
317 else if (ds->ds[ds_num].type == DS_TYPE_COUNTER)
318 BUFFER_ADD("%llu", vl->values[ds_num].counter);
319 else if (ds->ds[ds_num].type == DS_TYPE_DERIVE)
320 BUFFER_ADD("%" PRIi64, vl->values[ds_num].derive);
321 else if (ds->ds[ds_num].type == DS_TYPE_ABSOLUTE)
322 BUFFER_ADD("%" PRIu64, vl->values[ds_num].absolute);
325 ERROR("format_values plugin: Unknown data source type: %i",
326 ds->ds[ds_num].type);
337 static int wt_format_name(char *ret, int ret_len,
338 const value_list_t *vl,
339 const struct wt_callback *cb,
344 const char *prefix = "";
345 const char *meta_prefix = "tsdb_prefix";
348 status = meta_data_get_string(vl->meta, meta_prefix, &temp);
349 if (status == -ENOENT) {
350 /* defaults to empty string */
351 } else if (status < 0) {
359 if (ds_name != NULL) {
360 if (vl->plugin_instance[0] == '\0') {
361 if (vl->type_instance[0] == '\0') {
362 ssnprintf(ret, ret_len, "%s%s.%s.%s", prefix, vl->plugin,
365 ssnprintf(ret, ret_len, "%s%s.%s.%s.%s", prefix, vl->plugin,
366 vl->type, vl->type_instance, ds_name);
368 } else { /* vl->plugin_instance != "" */
369 if (vl->type_instance[0] == '\0') {
370 ssnprintf(ret, ret_len, "%s%s.%s.%s.%s", prefix, vl->plugin,
371 vl->plugin_instance, vl->type, ds_name);
373 ssnprintf(ret, ret_len, "%s%s.%s.%s.%s.%s", prefix,
374 vl->plugin, vl->plugin_instance, vl->type,
375 vl->type_instance, ds_name);
378 } else { /* ds_name == NULL */
379 if (vl->plugin_instance[0] == '\0') {
380 if (vl->type_instance[0] == '\0') {
381 ssnprintf(ret, ret_len, "%s%s.%s", prefix, vl->plugin,
384 ssnprintf(ret, ret_len, "%s%s.%s.%s", prefix, vl->plugin,
385 vl->type_instance, vl->type);
387 } else { /* vl->plugin_instance != "" */
388 if (vl->type_instance[0] == '\0') {
389 ssnprintf(ret, ret_len, "%s%s.%s.%s", prefix, vl->plugin,
390 vl->plugin_instance, vl->type);
392 ssnprintf(ret, ret_len, "%s%s.%s.%s.%s", prefix, vl->plugin,
393 vl->plugin_instance, vl->type, vl->type_instance);
402 static int wt_send_message (const char* key, const char* value,
403 cdtime_t time, struct wt_callback *cb,
404 const char* host, meta_data_t *md)
409 const char *tags = "";
411 const char *host_tags = cb->host_tags ? cb->host_tags : "";
412 const char *meta_tsdb = "tsdb_tags";
414 /* skip if value is NaN */
419 status = meta_data_get_string(md, meta_tsdb, &temp);
420 if (status == -ENOENT) {
421 /* defaults to empty string */
422 } else if (status < 0) {
423 ERROR("write_tsdb plugin: tags metadata get failure");
425 pthread_mutex_unlock(&cb->send_lock);
432 status = ssnprintf (message,
434 "put %s %.0f %s fqdn=%s %s %s\r\n",
436 CDTIME_T_TO_DOUBLE(time),
444 message_len = (size_t) status;
446 if (message_len >= sizeof(message)) {
447 ERROR("write_tsdb plugin: message buffer too small: "
448 "Need %zu bytes.", message_len + 1);
452 pthread_mutex_lock(&cb->send_lock);
456 status = wt_callback_init(cb);
459 ERROR("write_tsdb plugin: wt_callback_init failed.");
460 pthread_mutex_unlock(&cb->send_lock);
465 if (message_len >= cb->send_buf_free)
467 status = wt_flush_nolock(0, cb);
470 pthread_mutex_unlock(&cb->send_lock);
475 /* Assert that we have enough space for this message. */
476 assert(message_len < cb->send_buf_free);
478 /* `message_len + 1' because `message_len' does not include the
479 * trailing null byte. Neither does `send_buffer_fill'. */
480 memcpy(cb->send_buf + cb->send_buf_fill,
481 message, message_len + 1);
482 cb->send_buf_fill += message_len;
483 cb->send_buf_free -= message_len;
485 DEBUG("write_tsdb plugin: [%s]:%s buf %zu/%zu (%.1f %%) \"%s\"",
488 cb->send_buf_fill, sizeof(cb->send_buf),
489 100.0 * ((double) cb->send_buf_fill) /
490 ((double) sizeof(cb->send_buf)),
493 pthread_mutex_unlock(&cb->send_lock);
498 static int wt_write_messages(const data_set_t *ds, const value_list_t *vl,
499 struct wt_callback *cb)
501 char key[10*DATA_MAX_NAME_LEN];
506 if (0 != strcmp(ds->type, vl->type))
508 ERROR("write_tsdb plugin: DS type does not match "
513 for (size_t i = 0; i < ds->ds_num; i++)
515 const char *ds_name = NULL;
517 if (cb->always_append_ds || (ds->ds_num > 1))
518 ds_name = ds->ds[i].name;
520 /* Copy the identifier to 'key' and escape it. */
521 status = wt_format_name(key, sizeof(key), vl, cb, ds_name);
524 ERROR("write_tsdb plugin: error with format_name");
528 escape_string(key, sizeof(key));
529 /* Convert the values to an ASCII representation and put that into
531 status = wt_format_values(values, sizeof(values), i, ds, vl,
535 ERROR("write_tsdb plugin: error with "
540 /* Send the message to tsdb */
541 status = wt_send_message(key, values, vl->time, cb, vl->host, vl->meta);
544 ERROR("write_tsdb plugin: error with "
553 static int wt_write(const data_set_t *ds, const value_list_t *vl,
554 user_data_t *user_data)
556 struct wt_callback *cb;
559 if (user_data == NULL)
562 cb = user_data->data;
564 status = wt_write_messages(ds, vl, cb);
569 static int wt_config_tsd(oconfig_item_t *ci)
571 struct wt_callback *cb;
572 user_data_t user_data = { 0 };
573 char callback_name[DATA_MAX_NAME_LEN];
575 cb = calloc(1, sizeof(*cb));
578 ERROR("write_tsdb plugin: calloc failed.");
584 cb->host_tags = NULL;
587 pthread_mutex_init (&cb->send_lock, NULL);
589 for (int i = 0; i < ci->children_num; i++)
591 oconfig_item_t *child = ci->children + i;
593 if (strcasecmp("Host", child->key) == 0)
594 cf_util_get_string(child, &cb->node);
595 else if (strcasecmp("Port", child->key) == 0)
596 cf_util_get_service(child, &cb->service);
597 else if (strcasecmp("HostTags", child->key) == 0)
598 cf_util_get_string(child, &cb->host_tags);
599 else if (strcasecmp("StoreRates", child->key) == 0)
600 cf_util_get_boolean(child, &cb->store_rates);
601 else if (strcasecmp("AlwaysAppendDS", child->key) == 0)
602 cf_util_get_boolean(child, &cb->always_append_ds);
605 ERROR("write_tsdb plugin: Invalid configuration "
606 "option: %s.", child->key);
610 ssnprintf(callback_name, sizeof(callback_name), "write_tsdb/%s/%s",
611 cb->node != NULL ? cb->node : WT_DEFAULT_NODE,
612 cb->service != NULL ? cb->service : WT_DEFAULT_SERVICE);
615 user_data.free_func = wt_callback_free;
616 plugin_register_write(callback_name, wt_write, &user_data);
618 user_data.free_func = NULL;
619 plugin_register_flush(callback_name, wt_flush, &user_data);
624 static int wt_config(oconfig_item_t *ci)
626 for (int i = 0; i < ci->children_num; i++)
628 oconfig_item_t *child = ci->children + i;
630 if (strcasecmp("Node", child->key) == 0)
631 wt_config_tsd(child);
634 ERROR("write_tsdb plugin: Invalid configuration "
635 "option: %s.", child->key);
642 void module_register(void)
644 plugin_register_complex_config("write_tsdb", wt_config);
647 /* vim: set sw=4 ts=4 sts=4 tw=78 et : */