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"
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_hints;
160 struct addrinfo *ai_list;
161 struct addrinfo *ai_ptr;
164 const char *node = cb->node ? cb->node : WT_DEFAULT_NODE;
165 const char *service = cb->service ? cb->service : WT_DEFAULT_SERVICE;
170 memset(&ai_hints, 0, sizeof(ai_hints));
172 ai_hints.ai_flags |= AI_ADDRCONFIG;
174 ai_hints.ai_family = AF_UNSPEC;
175 ai_hints.ai_socktype = SOCK_STREAM;
179 status = getaddrinfo(node, service, &ai_hints, &ai_list);
182 ERROR("write_tsdb plugin: getaddrinfo (%s, %s) failed: %s",
183 node, service, gai_strerror (status));
187 assert (ai_list != NULL);
188 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
190 cb->sock_fd = socket(ai_ptr->ai_family, ai_ptr->ai_socktype,
191 ai_ptr->ai_protocol);
195 status = connect(cb->sock_fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
206 freeaddrinfo(ai_list);
211 ERROR("write_tsdb plugin: Connecting to %s:%s failed. "
212 "The last error was: %s", node, service,
213 sstrerror (errno, errbuf, sizeof(errbuf)));
223 static void wt_callback_free(void *data)
225 struct wt_callback *cb;
232 pthread_mutex_lock(&cb->send_lock);
234 wt_flush_nolock(0, cb);
241 sfree(cb->host_tags);
243 pthread_mutex_destroy(&cb->send_lock);
248 static int wt_flush(cdtime_t timeout,
249 const char *identifier __attribute__((unused)),
250 user_data_t *user_data)
252 struct wt_callback *cb;
255 if (user_data == NULL)
258 cb = user_data->data;
260 pthread_mutex_lock(&cb->send_lock);
264 status = wt_callback_init(cb);
267 ERROR("write_tsdb plugin: wt_callback_init failed.");
268 pthread_mutex_unlock(&cb->send_lock);
273 status = wt_flush_nolock(timeout, cb);
274 pthread_mutex_unlock(&cb->send_lock);
279 static int wt_format_values(char *ret, size_t ret_len,
280 int ds_num, const data_set_t *ds,
281 const value_list_t *vl,
286 gauge_t *rates = NULL;
288 assert(0 == strcmp (ds->type, vl->type));
290 memset(ret, 0, ret_len);
292 #define BUFFER_ADD(...) do { \
293 status = ssnprintf (ret + offset, ret_len - offset, \
300 else if (((size_t) status) >= (ret_len - offset)) \
306 offset += ((size_t) status); \
309 if (ds->ds[ds_num].type == DS_TYPE_GAUGE)
310 BUFFER_ADD(GAUGE_FORMAT, vl->values[ds_num].gauge);
311 else if (store_rates)
314 rates = uc_get_rate (ds, vl);
317 WARNING("format_values: "
318 "uc_get_rate failed.");
321 BUFFER_ADD(GAUGE_FORMAT, rates[ds_num]);
323 else if (ds->ds[ds_num].type == DS_TYPE_COUNTER)
324 BUFFER_ADD("%llu", vl->values[ds_num].counter);
325 else if (ds->ds[ds_num].type == DS_TYPE_DERIVE)
326 BUFFER_ADD("%" PRIi64, vl->values[ds_num].derive);
327 else if (ds->ds[ds_num].type == DS_TYPE_ABSOLUTE)
328 BUFFER_ADD("%" PRIu64, vl->values[ds_num].absolute);
331 ERROR("format_values plugin: Unknown data source type: %i",
332 ds->ds[ds_num].type);
343 static int wt_format_name(char *ret, int ret_len,
344 const value_list_t *vl,
345 const struct wt_callback *cb,
351 const char *meta_prefix = "tsdb_prefix";
354 status = meta_data_get_string(vl->meta, meta_prefix, &temp);
355 if (status == -ENOENT) {
356 /* defaults to empty string */
357 } else if (status < 0) {
365 if (ds_name != NULL) {
366 if (vl->plugin_instance[0] == '\0') {
367 if (vl->type_instance[0] == '\0') {
368 ssnprintf(ret, ret_len, "%s%s.%s.%s", prefix, vl->plugin,
371 ssnprintf(ret, ret_len, "%s%s.%s.%s.%s", prefix, vl->plugin,
372 vl->type, vl->type_instance, ds_name);
374 } else { /* vl->plugin_instance != "" */
375 if (vl->type_instance[0] == '\0') {
376 ssnprintf(ret, ret_len, "%s%s.%s.%s.%s", prefix, vl->plugin,
377 vl->plugin_instance, vl->type, ds_name);
379 ssnprintf(ret, ret_len, "%s%s.%s.%s.%s.%s", prefix,
380 vl->plugin, vl->plugin_instance, vl->type,
381 vl->type_instance, ds_name);
384 } else { /* ds_name == NULL */
385 if (vl->plugin_instance[0] == '\0') {
386 if (vl->type_instance[0] == '\0') {
387 ssnprintf(ret, ret_len, "%s%s.%s", prefix, vl->plugin,
390 ssnprintf(ret, ret_len, "%s%s.%s.%s", prefix, vl->plugin,
391 vl->type_instance, vl->type);
393 } else { /* vl->plugin_instance != "" */
394 if (vl->type_instance[0] == '\0') {
395 ssnprintf(ret, ret_len, "%s%s.%s.%s", prefix, vl->plugin,
396 vl->plugin_instance, vl->type);
398 ssnprintf(ret, ret_len, "%s%s.%s.%s.%s", prefix, vl->plugin,
399 vl->plugin_instance, vl->type, vl->type_instance);
408 static int wt_send_message (const char* key, const char* value,
409 cdtime_t time, struct wt_callback *cb,
410 const char* host, meta_data_t *md)
417 char *host_tags = cb->host_tags ? cb->host_tags : "";
418 const char *meta_tsdb = "tsdb_tags";
420 /* skip if value is NaN */
425 status = meta_data_get_string(md, meta_tsdb, &temp);
426 if (status == -ENOENT) {
427 /* defaults to empty string */
428 } else if (status < 0) {
429 ERROR("write_tsdb plugin: tags metadata get failure");
431 pthread_mutex_unlock(&cb->send_lock);
438 status = ssnprintf (message,
440 "put %s %.0f %s fqdn=%s %s %s\r\n",
442 CDTIME_T_TO_DOUBLE(time),
450 message_len = (size_t) status;
452 if (message_len >= sizeof(message)) {
453 ERROR("write_tsdb plugin: message buffer too small: "
454 "Need %zu bytes.", message_len + 1);
458 pthread_mutex_lock(&cb->send_lock);
462 status = wt_callback_init(cb);
465 ERROR("write_tsdb plugin: wt_callback_init failed.");
466 pthread_mutex_unlock(&cb->send_lock);
471 if (message_len >= cb->send_buf_free)
473 status = wt_flush_nolock(0, cb);
476 pthread_mutex_unlock(&cb->send_lock);
481 /* Assert that we have enough space for this message. */
482 assert(message_len < cb->send_buf_free);
484 /* `message_len + 1' because `message_len' does not include the
485 * trailing null byte. Neither does `send_buffer_fill'. */
486 memcpy(cb->send_buf + cb->send_buf_fill,
487 message, message_len + 1);
488 cb->send_buf_fill += message_len;
489 cb->send_buf_free -= message_len;
491 DEBUG("write_tsdb plugin: [%s]:%s buf %zu/%zu (%.1f %%) \"%s\"",
494 cb->send_buf_fill, sizeof(cb->send_buf),
495 100.0 * ((double) cb->send_buf_fill) /
496 ((double) sizeof(cb->send_buf)),
499 pthread_mutex_unlock(&cb->send_lock);
504 static int wt_write_messages(const data_set_t *ds, const value_list_t *vl,
505 struct wt_callback *cb)
507 char key[10*DATA_MAX_NAME_LEN];
513 if (0 != strcmp(ds->type, vl->type))
515 ERROR("write_tsdb plugin: DS type does not match "
520 for (i = 0; i < ds->ds_num; i++)
522 const char *ds_name = NULL;
524 if (cb->always_append_ds || (ds->ds_num > 1))
525 ds_name = ds->ds[i].name;
527 /* Copy the identifier to 'key' and escape it. */
528 status = wt_format_name(key, sizeof(key), vl, cb, ds_name);
531 ERROR("write_tsdb plugin: error with format_name");
535 escape_string(key, sizeof(key));
536 /* Convert the values to an ASCII representation and put that into
538 status = wt_format_values(values, sizeof(values), i, ds, vl,
542 ERROR("write_tsdb plugin: error with "
547 /* Send the message to tsdb */
548 status = wt_send_message(key, values, vl->time, cb, vl->host, vl->meta);
551 ERROR("write_tsdb plugin: error with "
560 static int wt_write(const data_set_t *ds, const value_list_t *vl,
561 user_data_t *user_data)
563 struct wt_callback *cb;
566 if (user_data == NULL)
569 cb = user_data->data;
571 status = wt_write_messages(ds, vl, cb);
576 static int wt_config_tsd(oconfig_item_t *ci)
578 struct wt_callback *cb;
579 user_data_t user_data;
580 char callback_name[DATA_MAX_NAME_LEN];
583 cb = malloc(sizeof(*cb));
586 ERROR("write_tsdb plugin: malloc failed.");
589 memset(cb, 0, sizeof(*cb));
593 cb->host_tags = NULL;
596 pthread_mutex_init (&cb->send_lock, NULL);
598 for (i = 0; i < ci->children_num; i++)
600 oconfig_item_t *child = ci->children + i;
602 if (strcasecmp("Host", child->key) == 0)
603 cf_util_get_string(child, &cb->node);
604 else if (strcasecmp("Port", child->key) == 0)
605 cf_util_get_service(child, &cb->service);
606 else if (strcasecmp("HostTags", child->key) == 0)
607 cf_util_get_string(child, &cb->host_tags);
608 else if (strcasecmp("StoreRates", child->key) == 0)
609 cf_util_get_boolean(child, &cb->store_rates);
610 else if (strcasecmp("AlwaysAppendDS", child->key) == 0)
611 cf_util_get_boolean(child, &cb->always_append_ds);
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 : */