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"
47 #include "configfile.h"
49 #include "utils_cache.h"
50 #include "utils_parse_option.h"
53 #include <sys/socket.h>
56 #ifndef WT_DEFAULT_NODE
57 # define WT_DEFAULT_NODE "localhost"
60 #ifndef WT_DEFAULT_SERVICE
61 # define WT_DEFAULT_SERVICE "4242"
64 #ifndef WT_DEFAULT_ESCAPE
65 # define WT_DEFAULT_ESCAPE '.'
68 /* Ethernet - (IPv6 + TCP) = 1500 - (40 + 32) = 1428 */
69 #ifndef WT_SEND_BUF_SIZE
70 # define WT_SEND_BUF_SIZE 1428
85 _Bool always_append_ds;
87 char send_buf[WT_SEND_BUF_SIZE];
90 cdtime_t send_buf_init_time;
92 pthread_mutex_t send_lock;
99 static void wt_reset_buffer(struct wt_callback *cb)
101 memset(cb->send_buf, 0, sizeof(cb->send_buf));
102 cb->send_buf_free = sizeof(cb->send_buf);
103 cb->send_buf_fill = 0;
104 cb->send_buf_init_time = cdtime();
107 static int wt_send_buffer(struct wt_callback *cb)
111 status = swrite(cb->sock_fd, cb->send_buf, strlen(cb->send_buf));
115 ERROR("write_tsdb plugin: send failed with status %zi (%s)",
116 status, sstrerror (errno, errbuf, sizeof (errbuf)));
127 /* NOTE: You must hold cb->send_lock when calling this function! */
128 static int wt_flush_nolock(cdtime_t timeout, struct wt_callback *cb)
132 DEBUG("write_tsdb plugin: wt_flush_nolock: timeout = %.3f; "
133 "send_buf_fill = %zu;",
137 /* timeout == 0 => flush unconditionally */
143 if ((cb->send_buf_init_time + timeout) > now)
147 if (cb->send_buf_fill <= 0)
149 cb->send_buf_init_time = cdtime();
153 status = wt_send_buffer(cb);
159 static int wt_callback_init(struct wt_callback *cb)
161 struct addrinfo ai_hints;
162 struct addrinfo *ai_list;
163 struct addrinfo *ai_ptr;
166 const char *node = cb->node ? cb->node : WT_DEFAULT_NODE;
167 const char *service = cb->service ? cb->service : WT_DEFAULT_SERVICE;
172 memset(&ai_hints, 0, sizeof(ai_hints));
174 ai_hints.ai_flags |= AI_ADDRCONFIG;
176 ai_hints.ai_family = AF_UNSPEC;
177 ai_hints.ai_socktype = SOCK_STREAM;
181 status = getaddrinfo(node, service, &ai_hints, &ai_list);
184 ERROR("write_tsdb plugin: getaddrinfo (%s, %s) failed: %s",
185 node, service, gai_strerror (status));
189 assert (ai_list != NULL);
190 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
192 cb->sock_fd = socket(ai_ptr->ai_family, ai_ptr->ai_socktype,
193 ai_ptr->ai_protocol);
197 status = connect(cb->sock_fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
208 freeaddrinfo(ai_list);
213 ERROR("write_tsdb plugin: Connecting to %s:%s failed. "
214 "The last error was: %s", node, service,
215 sstrerror (errno, errbuf, sizeof(errbuf)));
225 static void wt_callback_free(void *data)
227 struct wt_callback *cb;
234 pthread_mutex_lock(&cb->send_lock);
236 wt_flush_nolock(0, cb);
243 sfree(cb->host_tags);
245 pthread_mutex_destroy(&cb->send_lock);
250 static int wt_flush(cdtime_t timeout,
251 const char *identifier __attribute__((unused)),
252 user_data_t *user_data)
254 struct wt_callback *cb;
257 if (user_data == NULL)
260 cb = user_data->data;
262 pthread_mutex_lock(&cb->send_lock);
266 status = wt_callback_init(cb);
269 ERROR("write_tsdb plugin: wt_callback_init failed.");
270 pthread_mutex_unlock(&cb->send_lock);
275 status = wt_flush_nolock(timeout, cb);
276 pthread_mutex_unlock(&cb->send_lock);
281 static int wt_format_values(char *ret, size_t ret_len,
282 int ds_num, const data_set_t *ds,
283 const value_list_t *vl,
288 gauge_t *rates = NULL;
290 assert(0 == strcmp (ds->type, vl->type));
292 memset(ret, 0, ret_len);
294 #define BUFFER_ADD(...) do { \
295 status = ssnprintf (ret + offset, ret_len - offset, \
302 else if (((size_t) status) >= (ret_len - offset)) \
308 offset += ((size_t) status); \
311 if (ds->ds[ds_num].type == DS_TYPE_GAUGE)
312 BUFFER_ADD("%f", vl->values[ds_num].gauge);
313 else if (store_rates)
316 rates = uc_get_rate (ds, vl);
319 WARNING("format_values: "
320 "uc_get_rate failed.");
323 BUFFER_ADD("%f", rates[ds_num]);
325 else if (ds->ds[ds_num].type == DS_TYPE_COUNTER)
326 BUFFER_ADD("%llu", vl->values[ds_num].counter);
327 else if (ds->ds[ds_num].type == DS_TYPE_DERIVE)
328 BUFFER_ADD("%" PRIi64, vl->values[ds_num].derive);
329 else if (ds->ds[ds_num].type == DS_TYPE_ABSOLUTE)
330 BUFFER_ADD("%" PRIu64, vl->values[ds_num].absolute);
333 ERROR("format_values plugin: Unknown data source type: %i",
334 ds->ds[ds_num].type);
345 static int wt_format_name(char *ret, int ret_len,
346 const value_list_t *vl,
347 const struct wt_callback *cb,
353 const char *meta_prefix = "tsdb_prefix";
356 status = meta_data_get_string(vl->meta, meta_prefix, &temp);
357 if (status == -ENOENT) {
358 /* defaults to empty string */
359 } else if (status < 0) {
367 if (ds_name != NULL) {
368 if (vl->plugin_instance[0] == '\0') {
369 ssnprintf(ret, ret_len, "%s%s.%s",
370 prefix, vl->plugin, ds_name);
371 } else if (vl->type_instance == '\0') {
372 ssnprintf(ret, ret_len, "%s%s.%s.%s.%s",
373 prefix, vl->plugin, vl->plugin_instance,
374 vl->type_instance, ds_name);
376 ssnprintf(ret, ret_len, "%s%s.%s.%s.%s",
377 prefix, vl->plugin, vl->plugin_instance, vl->type,
380 } else if (vl->plugin_instance[0] == '\0') {
381 if (vl->type_instance[0] == '\0')
382 ssnprintf(ret, ret_len, "%s%s.%s",
383 prefix, vl->plugin, vl->type);
385 ssnprintf(ret, ret_len, "%s%s.%s",
386 prefix, vl->plugin, vl->type_instance);
387 } else if (vl->type_instance[0] == '\0') {
388 ssnprintf(ret, ret_len, "%s%s.%s.%s",
389 prefix, vl->plugin, vl->plugin_instance, vl->type);
391 ssnprintf(ret, ret_len, "%s%s.%s.%s",
392 prefix, vl->plugin, vl->plugin_instance, vl->type_instance);
399 static int wt_send_message (const char* key, const char* value,
400 cdtime_t time, struct wt_callback *cb,
401 const char* host, meta_data_t *md)
408 char *host_tags = cb->host_tags ? cb->host_tags : "";
409 const char *meta_tsdb = "tsdb_tags";
411 /* skip if value is NaN */
416 status = meta_data_get_string(md, meta_tsdb, &temp);
417 if (status == -ENOENT) {
418 /* defaults to empty string */
419 } else if (status < 0) {
420 ERROR("write_tsdb plugin: tags metadata get failure");
422 pthread_mutex_unlock(&cb->send_lock);
429 message_len = ssnprintf (message,
431 "put %s %.0f %s fqdn=%s %s %s\r\n",
433 CDTIME_T_TO_DOUBLE(time),
441 if (message_len >= sizeof(message)) {
442 ERROR("write_tsdb plugin: message buffer too small: "
443 "Need %d bytes.", message_len + 1);
447 pthread_mutex_lock(&cb->send_lock);
451 status = wt_callback_init(cb);
454 ERROR("write_tsdb plugin: wt_callback_init failed.");
455 pthread_mutex_unlock(&cb->send_lock);
460 if (message_len >= cb->send_buf_free)
462 status = wt_flush_nolock(0, cb);
465 pthread_mutex_unlock(&cb->send_lock);
470 /* Assert that we have enough space for this message. */
471 assert(message_len < cb->send_buf_free);
473 /* `message_len + 1' because `message_len' does not include the
474 * trailing null byte. Neither does `send_buffer_fill'. */
475 memcpy(cb->send_buf + cb->send_buf_fill,
476 message, message_len + 1);
477 cb->send_buf_fill += message_len;
478 cb->send_buf_free -= message_len;
480 DEBUG("write_tsdb plugin: [%s]:%s buf %zu/%zu (%.1f %%) \"%s\"",
483 cb->send_buf_fill, sizeof(cb->send_buf),
484 100.0 * ((double) cb->send_buf_fill) /
485 ((double) sizeof(cb->send_buf)),
488 pthread_mutex_unlock(&cb->send_lock);
493 static int wt_write_messages(const data_set_t *ds, const value_list_t *vl,
494 struct wt_callback *cb)
496 char key[10*DATA_MAX_NAME_LEN];
501 if (0 != strcmp(ds->type, vl->type))
503 ERROR("write_tsdb plugin: DS type does not match "
508 for (i = 0; i < ds->ds_num; i++)
510 const char *ds_name = NULL;
512 if (cb->always_append_ds || (ds->ds_num > 1))
513 ds_name = ds->ds[i].name;
515 /* Copy the identifier to 'key' and escape it. */
516 status = wt_format_name(key, sizeof(key), vl, cb, ds_name);
519 ERROR("write_tsdb plugin: error with format_name");
523 escape_string(key, sizeof(key));
524 /* Convert the values to an ASCII representation and put that into
526 status = wt_format_values(values, sizeof(values), i, ds, vl,
530 ERROR("write_tsdb plugin: error with "
535 /* Send the message to tsdb */
536 status = wt_send_message(key, values, vl->time, cb, vl->host, vl->meta);
539 ERROR("write_tsdb plugin: error with "
548 static int wt_write(const data_set_t *ds, const value_list_t *vl,
549 user_data_t *user_data)
551 struct wt_callback *cb;
554 if (user_data == NULL)
557 cb = user_data->data;
559 status = wt_write_messages(ds, vl, cb);
564 static int wt_config_tsd(oconfig_item_t *ci)
566 struct wt_callback *cb;
567 user_data_t user_data;
568 char callback_name[DATA_MAX_NAME_LEN];
571 cb = malloc(sizeof(*cb));
574 ERROR("write_tsdb plugin: malloc failed.");
577 memset(cb, 0, sizeof(*cb));
581 cb->host_tags = NULL;
584 pthread_mutex_init (&cb->send_lock, NULL);
586 for (i = 0; i < ci->children_num; i++)
588 oconfig_item_t *child = ci->children + i;
590 if (strcasecmp("Host", child->key) == 0)
591 cf_util_get_string(child, &cb->node);
592 else if (strcasecmp("Port", child->key) == 0)
593 cf_util_get_service(child, &cb->service);
594 else if (strcasecmp("HostTags", child->key) == 0)
595 cf_util_get_string(child, &cb->host_tags);
596 else if (strcasecmp("StoreRates", child->key) == 0)
597 cf_util_get_boolean(child, &cb->store_rates);
598 else if (strcasecmp("AlwaysAppendDS", child->key) == 0)
599 cf_util_get_boolean(child, &cb->always_append_ds);
602 ERROR("write_tsdb plugin: Invalid configuration "
603 "option: %s.", child->key);
607 ssnprintf(callback_name, sizeof(callback_name), "write_tsdb/%s/%s",
608 cb->node != NULL ? cb->node : WT_DEFAULT_NODE,
609 cb->service != NULL ? cb->service : WT_DEFAULT_SERVICE);
611 memset(&user_data, 0, sizeof(user_data));
613 user_data.free_func = wt_callback_free;
614 plugin_register_write(callback_name, wt_write, &user_data);
616 user_data.free_func = NULL;
617 plugin_register_flush(callback_name, wt_flush, &user_data);
622 static int wt_config(oconfig_item_t *ci)
626 for (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 : */