Code

7a8f851f285398bfb504bb02e72bf78b0a4ad3c2
[collectd.git] / src / write_tsdb.c
1 /**
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.
12  *
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.
17  *
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
21  *
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>
28  * write_tsdb Authors:
29  *   Brett Hawn <bhawn at llnw.com>
30  *   Kevin Bowling <kbowling@llnw.com>
31  **/
33 /* write_tsdb plugin configuation example
34  *
35  * <Plugin write_tsdb>
36  *   <Node>
37  *     Host "localhost"
38  *     Port "4242"
39  *     HostTags "status=production deviceclass=www"
40  *   </Node>
41  * </Plugin>
42  */
44 #include "collectd.h"
45 #include "common.h"
46 #include "plugin.h"
47 #include "configfile.h"
49 #include "utils_cache.h"
51 #include <netdb.h>
53 #ifndef WT_DEFAULT_NODE
54 # define WT_DEFAULT_NODE "localhost"
55 #endif
57 #ifndef WT_DEFAULT_SERVICE
58 # define WT_DEFAULT_SERVICE "4242"
59 #endif
61 #ifndef WT_DEFAULT_ESCAPE
62 # define WT_DEFAULT_ESCAPE '.'
63 #endif
65 /* Ethernet - (IPv6 + TCP) = 1500 - (40 + 32) = 1428 */
66 #ifndef WT_SEND_BUF_SIZE
67 # define WT_SEND_BUF_SIZE 1428
68 #endif
70 /*
71  * Private variables
72  */
73 struct wt_callback
74 {
75     int      sock_fd;
77     char     *node;
78     char     *service;
79     char     *host_tags;
81     _Bool    store_rates;
82     _Bool    always_append_ds;
84     char     send_buf[WT_SEND_BUF_SIZE];
85     size_t   send_buf_free;
86     size_t   send_buf_fill;
87     cdtime_t send_buf_init_time;
89     pthread_mutex_t send_lock;
90 };
93 /*
94  * Functions
95  */
96 static void wt_reset_buffer(struct wt_callback *cb)
97 {
98     memset(cb->send_buf, 0, sizeof(cb->send_buf));
99     cb->send_buf_free = sizeof(cb->send_buf);
100     cb->send_buf_fill = 0;
101     cb->send_buf_init_time = cdtime();
104 static int wt_send_buffer(struct wt_callback *cb)
106     ssize_t status = 0;
108     status = swrite(cb->sock_fd, cb->send_buf, strlen(cb->send_buf));
109     if (status < 0)
110     {
111         char errbuf[1024];
112         ERROR("write_tsdb plugin: send failed with status %zi (%s)",
113               status, sstrerror (errno, errbuf, sizeof (errbuf)));
115         close (cb->sock_fd);
116         cb->sock_fd = -1;
118         return -1;
119     }
121     return 0;
124 /* NOTE: You must hold cb->send_lock when calling this function! */
125 static int wt_flush_nolock(cdtime_t timeout, struct wt_callback *cb)
127     int status;
129     DEBUG("write_tsdb plugin: wt_flush_nolock: timeout = %.3f; "
130           "send_buf_fill = %zu;",
131           (double)timeout,
132           cb->send_buf_fill);
134     /* timeout == 0  => flush unconditionally */
135     if (timeout > 0)
136     {
137         cdtime_t now;
139         now = cdtime();
140         if ((cb->send_buf_init_time + timeout) > now)
141             return 0;
142     }
144     if (cb->send_buf_fill == 0)
145     {
146         cb->send_buf_init_time = cdtime();
147         return 0;
148     }
150     status = wt_send_buffer(cb);
151     wt_reset_buffer(cb);
153     return status;
156 static int wt_callback_init(struct wt_callback *cb)
158     struct addrinfo ai_hints = { 0 };
159     struct addrinfo *ai_list;
160     struct addrinfo *ai_ptr;
161     int status;
163     const char *node = cb->node ? cb->node : WT_DEFAULT_NODE;
164     const char *service = cb->service ? cb->service : WT_DEFAULT_SERVICE;
166     if (cb->sock_fd > 0)
167         return 0;
169     ai_hints.ai_flags    = AI_ADDRCONFIG;
170     ai_hints.ai_family   = AF_UNSPEC;
171     ai_hints.ai_socktype = SOCK_STREAM;
173     ai_list = NULL;
175     status = getaddrinfo(node, service, &ai_hints, &ai_list);
176     if (status != 0)
177     {
178         ERROR("write_tsdb plugin: getaddrinfo (%s, %s) failed: %s",
179               node, service, gai_strerror (status));
180         return -1;
181     }
183     assert (ai_list != NULL);
184     for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
185     {
186         cb->sock_fd = socket(ai_ptr->ai_family, ai_ptr->ai_socktype,
187                              ai_ptr->ai_protocol);
188         if (cb->sock_fd < 0)
189             continue;
191         status = connect(cb->sock_fd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
192         if (status != 0)
193         {
194             close(cb->sock_fd);
195             cb->sock_fd = -1;
196             continue;
197         }
199         break;
200     }
202     freeaddrinfo(ai_list);
204     if (cb->sock_fd < 0)
205     {
206         char errbuf[1024];
207         ERROR("write_tsdb plugin: Connecting to %s:%s failed. "
208               "The last error was: %s", node, service,
209               sstrerror (errno, errbuf, sizeof(errbuf)));
210         return -1;
211     }
213     wt_reset_buffer(cb);
215     return 0;
218 static void wt_callback_free(void *data)
220     struct wt_callback *cb;
222     if (data == NULL)
223         return;
225     cb = data;
227     pthread_mutex_lock(&cb->send_lock);
229     wt_flush_nolock(0, cb);
231     close(cb->sock_fd);
232     cb->sock_fd = -1;
234     sfree(cb->node);
235     sfree(cb->service);
236     sfree(cb->host_tags);
238     pthread_mutex_destroy(&cb->send_lock);
240     sfree(cb);
243 static int wt_flush(cdtime_t timeout,
244                     const char *identifier __attribute__((unused)),
245                     user_data_t *user_data)
247     struct wt_callback *cb;
248     int status;
250     if (user_data == NULL)
251         return -EINVAL;
253     cb = user_data->data;
255     pthread_mutex_lock(&cb->send_lock);
257     if (cb->sock_fd < 0)
258     {
259         status = wt_callback_init(cb);
260         if (status != 0)
261         {
262             ERROR("write_tsdb plugin: wt_callback_init failed.");
263             pthread_mutex_unlock(&cb->send_lock);
264             return -1;
265         }
266     }
268     status = wt_flush_nolock(timeout, cb);
269     pthread_mutex_unlock(&cb->send_lock);
271     return status;
274 static int wt_format_values(char *ret, size_t ret_len,
275                             int ds_num, const data_set_t *ds,
276                             const value_list_t *vl,
277                             _Bool store_rates)
279     size_t offset = 0;
280     int status;
281     gauge_t *rates = NULL;
283     assert(0 == strcmp (ds->type, vl->type));
285     memset(ret, 0, ret_len);
287 #define BUFFER_ADD(...) do { \
288         status = ssnprintf (ret + offset, ret_len - offset, \
289                             __VA_ARGS__); \
290         if (status < 1) \
291         { \
292             sfree(rates); \
293             return -1; \
294         } \
295         else if (((size_t) status) >= (ret_len - offset)) \
296         { \
297             sfree(rates); \
298             return -1; \
299         } \
300         else \
301             offset += ((size_t) status); \
302 } while (0)
304     if (ds->ds[ds_num].type == DS_TYPE_GAUGE)
305         BUFFER_ADD(GAUGE_FORMAT, vl->values[ds_num].gauge);
306     else if (store_rates)
307     {
308         if (rates == NULL)
309             rates = uc_get_rate (ds, vl);
310         if (rates == NULL)
311         {
312             WARNING("format_values: "
313                     "uc_get_rate failed.");
314             return -1;
315         }
316         BUFFER_ADD(GAUGE_FORMAT, rates[ds_num]);
317     }
318     else if (ds->ds[ds_num].type == DS_TYPE_COUNTER)
319         BUFFER_ADD("%llu", vl->values[ds_num].counter);
320     else if (ds->ds[ds_num].type == DS_TYPE_DERIVE)
321         BUFFER_ADD("%" PRIi64, vl->values[ds_num].derive);
322     else if (ds->ds[ds_num].type == DS_TYPE_ABSOLUTE)
323         BUFFER_ADD("%" PRIu64, vl->values[ds_num].absolute);
324     else
325     {
326         ERROR("format_values plugin: Unknown data source type: %i",
327               ds->ds[ds_num].type);
328         sfree(rates);
329         return -1;
330     }
332 #undef BUFFER_ADD
334     sfree(rates);
335     return 0;
338 static int wt_format_name(char *ret, int ret_len,
339                           const value_list_t *vl,
340                           const struct wt_callback *cb,
341                           const char *ds_name)
343     int status;
344     char *temp = NULL;
345     const char *prefix = "";
346     const char *meta_prefix = "tsdb_prefix";
348     if (vl->meta) {
349         status = meta_data_get_string(vl->meta, meta_prefix, &temp);
350         if (status == -ENOENT) {
351             /* defaults to empty string */
352         } else if (status < 0) {
353             sfree(temp);
354             return status;
355         } else {
356             prefix = temp;
357         }
358     }
360     if (ds_name != NULL) {
361         if (vl->plugin_instance[0] == '\0') {
362             if (vl->type_instance[0] == '\0') {
363                 ssnprintf(ret, ret_len, "%s%s.%s.%s", prefix, vl->plugin,
364                         vl->type, ds_name);
365             } else {
366                 ssnprintf(ret, ret_len, "%s%s.%s.%s.%s", prefix, vl->plugin,
367                         vl->type, vl->type_instance, ds_name);
368             }
369         } else { /* vl->plugin_instance != "" */
370             if (vl->type_instance[0] == '\0') {
371                 ssnprintf(ret, ret_len, "%s%s.%s.%s.%s", prefix, vl->plugin,
372                         vl->plugin_instance, vl->type, ds_name);
373             } else {
374                 ssnprintf(ret, ret_len, "%s%s.%s.%s.%s.%s", prefix,
375                         vl->plugin, vl->plugin_instance, vl->type,
376                         vl->type_instance, ds_name);
377             }
378         }
379     } else { /* ds_name == NULL */
380         if (vl->plugin_instance[0] == '\0') {
381             if (vl->type_instance[0] == '\0') {
382                 ssnprintf(ret, ret_len, "%s%s.%s", prefix, vl->plugin,
383                         vl->type);
384             } else {
385                 ssnprintf(ret, ret_len, "%s%s.%s.%s", prefix, vl->plugin,
386                         vl->type_instance, vl->type);
387             }
388         } else { /* vl->plugin_instance != "" */
389             if (vl->type_instance[0] == '\0') {
390                 ssnprintf(ret, ret_len, "%s%s.%s.%s", prefix, vl->plugin,
391                         vl->plugin_instance, vl->type);
392             } else {
393                 ssnprintf(ret, ret_len, "%s%s.%s.%s.%s", prefix, vl->plugin,
394                         vl->plugin_instance, vl->type, vl->type_instance);
395             }
396         }
397     }
399     sfree(temp);
400     return 0;
403 static int wt_send_message (const char* key, const char* value,
404                             cdtime_t time, struct wt_callback *cb,
405                             const char* host, meta_data_t *md)
407     int status;
408     size_t message_len;
409     char *temp = NULL;
410     const char *tags = "";
411     char message[1024];
412     const char *host_tags = cb->host_tags ? cb->host_tags : "";
413     const char *meta_tsdb = "tsdb_tags";
415     /* skip if value is NaN */
416     if (value[0] == 'n')
417         return 0;
419     if (md) {
420         status = meta_data_get_string(md, meta_tsdb, &temp);
421         if (status == -ENOENT) {
422             /* defaults to empty string */
423         } else if (status < 0) {
424             ERROR("write_tsdb plugin: tags metadata get failure");
425             sfree(temp);
426             pthread_mutex_unlock(&cb->send_lock);
427             return status;
428         } else {
429             tags = temp;
430         }
431     }
433     status = ssnprintf (message,
434                              sizeof(message),
435                              "put %s %.0f %s fqdn=%s %s %s\r\n",
436                              key,
437                              CDTIME_T_TO_DOUBLE(time),
438                              value,
439                              host,
440                              tags,
441                              host_tags);
442     sfree(temp);
443     if (status < 0)
444         return -1;
445     message_len = (size_t) status;
447     if (message_len >= sizeof(message)) {
448         ERROR("write_tsdb plugin: message buffer too small: "
449               "Need %zu bytes.", message_len + 1);
450         return -1;
451     }
453     pthread_mutex_lock(&cb->send_lock);
455     if (cb->sock_fd < 0)
456     {
457         status = wt_callback_init(cb);
458         if (status != 0)
459         {
460             ERROR("write_tsdb plugin: wt_callback_init failed.");
461             pthread_mutex_unlock(&cb->send_lock);
462             return -1;
463         }
464     }
466     if (message_len >= cb->send_buf_free)
467     {
468         status = wt_flush_nolock(0, cb);
469         if (status != 0)
470         {
471             pthread_mutex_unlock(&cb->send_lock);
472             return status;
473         }
474     }
476     /* Assert that we have enough space for this message. */
477     assert(message_len < cb->send_buf_free);
479     /* `message_len + 1' because `message_len' does not include the
480      * trailing null byte. Neither does `send_buffer_fill'. */
481     memcpy(cb->send_buf + cb->send_buf_fill,
482             message, message_len + 1);
483     cb->send_buf_fill += message_len;
484     cb->send_buf_free -= message_len;
486     DEBUG("write_tsdb plugin: [%s]:%s buf %zu/%zu (%.1f %%) \"%s\"",
487           cb->node,
488           cb->service,
489           cb->send_buf_fill, sizeof(cb->send_buf),
490           100.0 * ((double) cb->send_buf_fill) /
491           ((double) sizeof(cb->send_buf)),
492           message);
494     pthread_mutex_unlock(&cb->send_lock);
496     return 0;
499 static int wt_write_messages(const data_set_t *ds, const value_list_t *vl,
500                              struct wt_callback *cb)
502     char key[10*DATA_MAX_NAME_LEN];
503     char values[512];
505     int status;
506     size_t i;
508     if (0 != strcmp(ds->type, vl->type))
509     {
510         ERROR("write_tsdb plugin: DS type does not match "
511               "value list type");
512         return -1;
513     }
515     for (i = 0; i < ds->ds_num; i++)
516     {
517         const char *ds_name = NULL;
519         if (cb->always_append_ds || (ds->ds_num > 1))
520             ds_name = ds->ds[i].name;
522         /* Copy the identifier to 'key' and escape it. */
523         status = wt_format_name(key, sizeof(key), vl, cb, ds_name);
524         if (status != 0)
525         {
526             ERROR("write_tsdb plugin: error with format_name");
527             return status;
528         }
530         escape_string(key, sizeof(key));
531         /* Convert the values to an ASCII representation and put that into
532          * 'values'. */
533         status = wt_format_values(values, sizeof(values), i, ds, vl,
534                                   cb->store_rates);
535         if (status != 0)
536         {
537             ERROR("write_tsdb plugin: error with "
538                   "wt_format_values");
539             return status;
540         }
542         /* Send the message to tsdb */
543         status = wt_send_message(key, values, vl->time, cb, vl->host, vl->meta);
544         if (status != 0)
545         {
546             ERROR("write_tsdb plugin: error with "
547                   "wt_send_message");
548             return status;
549         }
550     }
552     return 0;
555 static int wt_write(const data_set_t *ds, const value_list_t *vl,
556                     user_data_t *user_data)
558     struct wt_callback *cb;
559     int status;
561     if (user_data == NULL)
562         return EINVAL;
564     cb = user_data->data;
566     status = wt_write_messages(ds, vl, cb);
568     return status;
571 static int wt_config_tsd(oconfig_item_t *ci)
573     struct wt_callback *cb;
574     user_data_t user_data = { 0 };
575     char callback_name[DATA_MAX_NAME_LEN];
576     int i;
578     cb = calloc(1, sizeof(*cb));
579     if (cb == NULL)
580     {
581         ERROR("write_tsdb plugin: calloc failed.");
582         return -1;
583     }
584     cb->sock_fd = -1;
585     cb->node = NULL;
586     cb->service = NULL;
587     cb->host_tags = NULL;
588     cb->store_rates = 0;
590     pthread_mutex_init (&cb->send_lock, NULL);
592     for (i = 0; i < ci->children_num; i++)
593     {
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("HostTags", child->key) == 0)
601             cf_util_get_string(child, &cb->host_tags);
602         else if (strcasecmp("StoreRates", child->key) == 0)
603             cf_util_get_boolean(child, &cb->store_rates);
604         else if (strcasecmp("AlwaysAppendDS", child->key) == 0)
605             cf_util_get_boolean(child, &cb->always_append_ds);
606         else
607         {
608             ERROR("write_tsdb plugin: Invalid configuration "
609                   "option: %s.", child->key);
610         }
611     }
613     ssnprintf(callback_name, sizeof(callback_name), "write_tsdb/%s/%s",
614               cb->node != NULL ? cb->node : WT_DEFAULT_NODE,
615               cb->service != NULL ? cb->service : WT_DEFAULT_SERVICE);
617     user_data.data = cb;
618     user_data.free_func = wt_callback_free;
619     plugin_register_write(callback_name, wt_write, &user_data);
621     user_data.free_func = NULL;
622     plugin_register_flush(callback_name, wt_flush, &user_data);
624     return 0;
627 static int wt_config(oconfig_item_t *ci)
629     int i;
631     for (i = 0; i < ci->children_num; i++)
632     {
633         oconfig_item_t *child = ci->children + i;
635         if (strcasecmp("Node", child->key) == 0)
636             wt_config_tsd(child);
637         else
638         {
639             ERROR("write_tsdb plugin: Invalid configuration "
640                   "option: %s.", child->key);
641         }
642     }
644     return 0;
647 void module_register(void)
649     plugin_register_complex_config("write_tsdb", wt_config);
652 /* vim: set sw=4 ts=4 sts=4 tw=78 et : */