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"
49 #include "utils_cache.h"
53 #ifndef WT_DEFAULT_NODE
54 #define WT_DEFAULT_NODE "localhost"
57 #ifndef WT_DEFAULT_SERVICE
58 #define WT_DEFAULT_SERVICE "4242"
61 #ifndef WT_DEFAULT_ESCAPE
62 #define WT_DEFAULT_ESCAPE '.'
65 /* Ethernet - (IPv6 + TCP) = 1500 - (40 + 32) = 1428 */
66 #ifndef WT_SEND_BUF_SIZE
67 #define WT_SEND_BUF_SIZE 1428
81 _Bool always_append_ds;
83 char send_buf[WT_SEND_BUF_SIZE];
86 cdtime_t send_buf_init_time;
88 pthread_mutex_t send_lock;
94 static void wt_reset_buffer(struct wt_callback *cb) {
95 memset(cb->send_buf, 0, sizeof(cb->send_buf));
96 cb->send_buf_free = sizeof(cb->send_buf);
97 cb->send_buf_fill = 0;
98 cb->send_buf_init_time = cdtime();
101 static int wt_send_buffer(struct wt_callback *cb) {
104 status = swrite(cb->sock_fd, cb->send_buf, strlen(cb->send_buf));
107 ERROR("write_tsdb plugin: send failed with status %zi (%s)", status,
108 sstrerror(errno, errbuf, sizeof(errbuf)));
119 /* NOTE: You must hold cb->send_lock when calling this function! */
120 static int wt_flush_nolock(cdtime_t timeout, struct wt_callback *cb) {
123 DEBUG("write_tsdb plugin: wt_flush_nolock: timeout = %.3f; "
124 "send_buf_fill = %zu;",
125 (double)timeout, cb->send_buf_fill);
127 /* timeout == 0 => flush unconditionally */
132 if ((cb->send_buf_init_time + timeout) > now)
136 if (cb->send_buf_fill == 0) {
137 cb->send_buf_init_time = cdtime();
141 status = wt_send_buffer(cb);
147 static int wt_callback_init(struct wt_callback *cb) {
148 struct addrinfo *ai_list;
151 const char *node = cb->node ? cb->node : WT_DEFAULT_NODE;
152 const char *service = cb->service ? cb->service : WT_DEFAULT_SERVICE;
157 struct addrinfo ai_hints = {.ai_family = AF_UNSPEC,
158 .ai_flags = AI_ADDRCONFIG,
159 .ai_socktype = SOCK_STREAM};
161 status = getaddrinfo(node, service, &ai_hints, &ai_list);
163 ERROR("write_tsdb plugin: getaddrinfo (%s, %s) failed: %s", node, service,
164 gai_strerror(status));
168 assert(ai_list != NULL);
169 for (struct addrinfo *ai_ptr = ai_list; ai_ptr != NULL;
170 ai_ptr = ai_ptr->ai_next) {
172 socket(ai_ptr->ai_family, ai_ptr->ai_socktype, ai_ptr->ai_protocol);
176 set_sock_opts(cb->sock_fd);
178 status = connect(cb->sock_fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
188 freeaddrinfo(ai_list);
190 if (cb->sock_fd < 0) {
192 ERROR("write_tsdb plugin: Connecting to %s:%s failed. "
193 "The last error was: %s",
194 node, service, sstrerror(errno, errbuf, sizeof(errbuf)));
203 static void wt_callback_free(void *data) {
204 struct wt_callback *cb;
211 pthread_mutex_lock(&cb->send_lock);
213 wt_flush_nolock(0, cb);
220 sfree(cb->host_tags);
222 pthread_mutex_destroy(&cb->send_lock);
227 static int wt_flush(cdtime_t timeout,
228 const char *identifier __attribute__((unused)),
229 user_data_t *user_data) {
230 struct wt_callback *cb;
233 if (user_data == NULL)
236 cb = user_data->data;
238 pthread_mutex_lock(&cb->send_lock);
240 if (cb->sock_fd < 0) {
241 status = wt_callback_init(cb);
243 ERROR("write_tsdb plugin: wt_callback_init failed.");
244 pthread_mutex_unlock(&cb->send_lock);
249 status = wt_flush_nolock(timeout, cb);
250 pthread_mutex_unlock(&cb->send_lock);
255 static int wt_format_values(char *ret, size_t ret_len, int ds_num,
256 const data_set_t *ds, const value_list_t *vl,
260 gauge_t *rates = NULL;
262 assert(0 == strcmp(ds->type, vl->type));
264 memset(ret, 0, ret_len);
266 #define BUFFER_ADD(...) \
268 status = ssnprintf(ret + offset, ret_len - offset, __VA_ARGS__); \
272 } else if (((size_t)status) >= (ret_len - offset)) { \
276 offset += ((size_t)status); \
279 if (ds->ds[ds_num].type == DS_TYPE_GAUGE)
280 BUFFER_ADD(GAUGE_FORMAT, vl->values[ds_num].gauge);
281 else if (store_rates) {
283 rates = uc_get_rate(ds, vl);
285 WARNING("format_values: "
286 "uc_get_rate failed.");
289 BUFFER_ADD(GAUGE_FORMAT, rates[ds_num]);
290 } else if (ds->ds[ds_num].type == DS_TYPE_COUNTER)
291 BUFFER_ADD("%llu", vl->values[ds_num].counter);
292 else if (ds->ds[ds_num].type == DS_TYPE_DERIVE)
293 BUFFER_ADD("%" PRIi64, vl->values[ds_num].derive);
294 else if (ds->ds[ds_num].type == DS_TYPE_ABSOLUTE)
295 BUFFER_ADD("%" PRIu64, vl->values[ds_num].absolute);
297 ERROR("format_values plugin: Unknown data source type: %i",
298 ds->ds[ds_num].type);
309 static int wt_format_name(char *ret, int ret_len, const value_list_t *vl,
310 const struct wt_callback *cb, const char *ds_name) {
313 const char *prefix = "";
314 const char *meta_prefix = "tsdb_prefix";
317 status = meta_data_get_string(vl->meta, meta_prefix, &temp);
318 if (status == -ENOENT) {
319 /* defaults to empty string */
320 } else if (status < 0) {
328 if (ds_name != NULL) {
329 if (vl->plugin_instance[0] == '\0') {
330 if (vl->type_instance[0] == '\0') {
331 ssnprintf(ret, ret_len, "%s%s.%s.%s", prefix, vl->plugin, vl->type,
334 ssnprintf(ret, ret_len, "%s%s.%s.%s.%s", prefix, vl->plugin, vl->type,
335 vl->type_instance, ds_name);
337 } else { /* vl->plugin_instance != "" */
338 if (vl->type_instance[0] == '\0') {
339 ssnprintf(ret, ret_len, "%s%s.%s.%s.%s", prefix, vl->plugin,
340 vl->plugin_instance, vl->type, ds_name);
342 ssnprintf(ret, ret_len, "%s%s.%s.%s.%s.%s", prefix, vl->plugin,
343 vl->plugin_instance, vl->type, vl->type_instance, ds_name);
346 } else { /* ds_name == NULL */
347 if (vl->plugin_instance[0] == '\0') {
348 if (vl->type_instance[0] == '\0') {
349 ssnprintf(ret, ret_len, "%s%s.%s", prefix, vl->plugin, vl->type);
351 ssnprintf(ret, ret_len, "%s%s.%s.%s", prefix, vl->plugin,
352 vl->type_instance, vl->type);
354 } else { /* vl->plugin_instance != "" */
355 if (vl->type_instance[0] == '\0') {
356 ssnprintf(ret, ret_len, "%s%s.%s.%s", prefix, vl->plugin,
357 vl->plugin_instance, vl->type);
359 ssnprintf(ret, ret_len, "%s%s.%s.%s.%s", prefix, vl->plugin,
360 vl->plugin_instance, vl->type, vl->type_instance);
369 static int wt_send_message(const char *key, const char *value, cdtime_t time,
370 struct wt_callback *cb, const char *host,
375 const char *tags = "";
377 const char *host_tags = cb->host_tags ? cb->host_tags : "";
378 const char *meta_tsdb = "tsdb_tags";
380 /* skip if value is NaN */
385 status = meta_data_get_string(md, meta_tsdb, &temp);
386 if (status == -ENOENT) {
387 /* defaults to empty string */
388 } else if (status < 0) {
389 ERROR("write_tsdb plugin: tags metadata get failure");
391 pthread_mutex_unlock(&cb->send_lock);
399 ssnprintf(message, sizeof(message), "put %s %.0f %s fqdn=%s %s %s\r\n",
400 key, CDTIME_T_TO_DOUBLE(time), value, host, tags, host_tags);
404 message_len = (size_t)status;
406 if (message_len >= sizeof(message)) {
407 ERROR("write_tsdb plugin: message buffer too small: "
413 pthread_mutex_lock(&cb->send_lock);
415 if (cb->sock_fd < 0) {
416 status = wt_callback_init(cb);
418 ERROR("write_tsdb plugin: wt_callback_init failed.");
419 pthread_mutex_unlock(&cb->send_lock);
424 if (message_len >= cb->send_buf_free) {
425 status = wt_flush_nolock(0, cb);
427 pthread_mutex_unlock(&cb->send_lock);
432 /* Assert that we have enough space for this message. */
433 assert(message_len < cb->send_buf_free);
435 /* `message_len + 1' because `message_len' does not include the
436 * trailing null byte. Neither does `send_buffer_fill'. */
437 memcpy(cb->send_buf + cb->send_buf_fill, message, message_len + 1);
438 cb->send_buf_fill += message_len;
439 cb->send_buf_free -= message_len;
441 DEBUG("write_tsdb plugin: [%s]:%s buf %zu/%zu (%.1f %%) \"%s\"", cb->node,
442 cb->service, cb->send_buf_fill, sizeof(cb->send_buf),
443 100.0 * ((double)cb->send_buf_fill) / ((double)sizeof(cb->send_buf)),
446 pthread_mutex_unlock(&cb->send_lock);
451 static int wt_write_messages(const data_set_t *ds, const value_list_t *vl,
452 struct wt_callback *cb) {
453 char key[10 * DATA_MAX_NAME_LEN];
458 if (0 != strcmp(ds->type, vl->type)) {
459 ERROR("write_tsdb plugin: DS type does not match "
464 for (size_t i = 0; i < ds->ds_num; i++) {
465 const char *ds_name = NULL;
467 if (cb->always_append_ds || (ds->ds_num > 1))
468 ds_name = ds->ds[i].name;
470 /* Copy the identifier to 'key' and escape it. */
471 status = wt_format_name(key, sizeof(key), vl, cb, ds_name);
473 ERROR("write_tsdb plugin: error with format_name");
477 escape_string(key, sizeof(key));
478 /* Convert the values to an ASCII representation and put that into
481 wt_format_values(values, sizeof(values), i, ds, vl, cb->store_rates);
483 ERROR("write_tsdb plugin: error with "
488 /* Send the message to tsdb */
489 status = wt_send_message(key, values, vl->time, cb, vl->host, vl->meta);
491 ERROR("write_tsdb plugin: error with "
500 static int wt_write(const data_set_t *ds, const value_list_t *vl,
501 user_data_t *user_data) {
502 struct wt_callback *cb;
505 if (user_data == NULL)
508 cb = user_data->data;
510 status = wt_write_messages(ds, vl, cb);
515 static int wt_config_tsd(oconfig_item_t *ci) {
516 struct wt_callback *cb;
517 char callback_name[DATA_MAX_NAME_LEN];
519 cb = calloc(1, sizeof(*cb));
521 ERROR("write_tsdb plugin: calloc failed.");
527 cb->host_tags = NULL;
530 pthread_mutex_init(&cb->send_lock, NULL);
532 for (int i = 0; i < ci->children_num; i++) {
533 oconfig_item_t *child = ci->children + i;
535 if (strcasecmp("Host", child->key) == 0)
536 cf_util_get_string(child, &cb->node);
537 else if (strcasecmp("Port", child->key) == 0)
538 cf_util_get_service(child, &cb->service);
539 else if (strcasecmp("HostTags", child->key) == 0)
540 cf_util_get_string(child, &cb->host_tags);
541 else if (strcasecmp("StoreRates", child->key) == 0)
542 cf_util_get_boolean(child, &cb->store_rates);
543 else if (strcasecmp("AlwaysAppendDS", child->key) == 0)
544 cf_util_get_boolean(child, &cb->always_append_ds);
546 ERROR("write_tsdb plugin: Invalid configuration "
552 ssnprintf(callback_name, sizeof(callback_name), "write_tsdb/%s/%s",
553 cb->node != NULL ? cb->node : WT_DEFAULT_NODE,
554 cb->service != NULL ? cb->service : WT_DEFAULT_SERVICE);
556 user_data_t user_data = {.data = cb, .free_func = wt_callback_free};
558 plugin_register_write(callback_name, wt_write, &user_data);
560 user_data.free_func = NULL;
561 plugin_register_flush(callback_name, wt_flush, &user_data);
566 static int wt_config(oconfig_item_t *ci) {
567 for (int i = 0; i < ci->children_num; i++) {
568 oconfig_item_t *child = ci->children + i;
570 if (strcasecmp("Node", child->key) == 0)
571 wt_config_tsd(child);
573 ERROR("write_tsdb plugin: Invalid configuration "
582 void module_register(void) {
583 plugin_register_complex_config("write_tsdb", wt_config);
586 /* vim: set sw=4 ts=4 sts=4 tw=78 et : */