Merge branch 'collectd-5.2'
[collectd.git] / src / write_riemann.c
index c184429..df0c373 100644 (file)
@@ -1,7 +1,8 @@
-/*
- * collectd - src/riemann.c
+/**
+ * collectd - src/write_riemann.c
  *
- * Copyright (C) 2012  Pierre-Yves Ritschard <pyr@spootnik.org>
+ * Copyright (C) 2012,2013  Pierre-Yves Ritschard
+ * Copyright (C) 2013       Florian octo Forster
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
@@ -15,6 +16,9 @@
  * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
  * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  *
+ * Authors:
+ *   Pierre-Yves Ritschard <pyr at spootnik.org>
+ *   Florian octo Forster <octo at collectd.org>
  */
 
 #include "collectd.h"
 #include <inttypes.h>
 #include <pthread.h>
 
-#define RIEMANN_DELAY          1
+#define RIEMANN_HOST           "localhost"
 #define RIEMANN_PORT           "5555"
-#define RIEMANN_MAX_TAGS       37
-#define RIEMANN_EXTRA_TAGS     32
 
 struct riemann_host {
+       char                    *name;
 #define F_CONNECT               0x01
        uint8_t                  flags;
        pthread_mutex_t          lock;
-       int                      delay;
        _Bool                    store_rates;
+       _Bool                    always_append_ds;
        char                    *node;
        char                    *service;
+       _Bool                    use_tcp;
        int                      s;
 
        int                      reference_count;
@@ -58,7 +62,7 @@ static int    riemann_write(const data_set_t *, const value_list_t *, user_data_t *
 static int     riemann_connect(struct riemann_host *);
 static int     riemann_disconnect (struct riemann_host *host);
 static void    riemann_free(void *);
-static int     riemann_config_host(oconfig_item_t *);
+static int     riemann_config_node(oconfig_item_t *);
 static int     riemann_config(oconfig_item_t *);
 void   module_register(void);
 
@@ -115,15 +119,27 @@ riemann_send(struct riemann_host *host, Msg const *msg)
        }
 
        buffer_len = msg__get_packed_size(msg);
+       if (host->use_tcp)
+               buffer_len += 4;
+
        buffer = malloc (buffer_len);
        if (buffer == NULL) {
                pthread_mutex_unlock (&host->lock);
-               ERROR ("riemann plugin: malloc failed.");
+               ERROR ("write_riemann plugin: malloc failed.");
                return ENOMEM;
        }
        memset (buffer, 0, buffer_len);
 
-       msg__pack(msg, buffer);
+       if (host->use_tcp)
+       {
+               uint32_t length = htonl ((uint32_t) (buffer_len - 4));
+               memcpy (buffer, &length, 4);
+               msg__pack(msg, buffer + 4);
+       }
+       else
+       {
+               msg__pack(msg, buffer);
+       }
 
        status = (int) swrite (host->s, buffer, buffer_len);
        if (status != 0)
@@ -133,8 +149,8 @@ riemann_send(struct riemann_host *host, Msg const *msg)
                riemann_disconnect (host);
                pthread_mutex_unlock (&host->lock);
 
-               ERROR ("riemann plugin: Sending to Riemann at %s:%s failed: %s",
-                               host->node,
+               ERROR ("write_riemann plugin: Sending to Riemann at %s:%s failed: %s",
+                               (host->node != NULL) ? host->node : RIEMANN_HOST,
                                (host->service != NULL) ? host->service : RIEMANN_PORT,
                                sstrerror (errno, errbuf, sizeof (errbuf)));
                sfree (buffer);
@@ -176,7 +192,7 @@ static Msg *riemann_notification_to_protobuf (struct riemann_host *host, /* {{{
        msg = malloc (sizeof (*msg));
        if (msg == NULL)
        {
-               ERROR ("riemann plugin: malloc failed.");
+               ERROR ("write_riemann plugin: malloc failed.");
                return (NULL);
        }
        memset (msg, 0, sizeof (*msg));
@@ -185,7 +201,7 @@ static Msg *riemann_notification_to_protobuf (struct riemann_host *host, /* {{{
        msg->events = malloc (sizeof (*msg->events));
        if (msg->events == NULL)
        {
-               ERROR ("riemann plugin: malloc failed.");
+               ERROR ("write_riemann plugin: malloc failed.");
                sfree (msg);
                return (NULL);
        }
@@ -193,7 +209,7 @@ static Msg *riemann_notification_to_protobuf (struct riemann_host *host, /* {{{
        event = malloc (sizeof (*event));
        if (event == NULL)
        {
-               ERROR ("riemann plugin: malloc failed.");
+               ERROR ("write_riemann plugin: malloc failed.");
                sfree (msg->events);
                sfree (msg);
                return (NULL);
@@ -233,11 +249,10 @@ static Msg *riemann_notification_to_protobuf (struct riemann_host *host, /* {{{
        for (i = 0; i < riemann_tags_num; i++)
                riemann_event_add_tag (event, "%s", riemann_tags[i]);
 
-       /* TODO: Use FORMAT_VL() here. */
-       ssnprintf (service_buffer, sizeof(service_buffer),
-                       "%s-%s-%s-%s", n->plugin, n->plugin_instance,
+       format_name (service_buffer, sizeof (service_buffer),
+                       /* host = */ "", n->plugin, n->plugin_instance,
                        n->type, n->type_instance);
-       event->service = strdup (service_buffer);
+       event->service = strdup (&service_buffer[1]);
 
        /* Pull in values from threshold */
        for (meta = n->meta; meta != NULL; meta = meta->next)
@@ -250,7 +265,7 @@ static Msg *riemann_notification_to_protobuf (struct riemann_host *host, /* {{{
                break;
        }
 
-       DEBUG ("riemann plugin: Successfully created protobuf for notification: "
+       DEBUG ("write_riemann plugin: Successfully created protobuf for notification: "
                        "host = \"%s\", service = \"%s\", state = \"%s\"",
                        event->host, event->service, event->state);
        return (msg);
@@ -262,13 +277,14 @@ static Event *riemann_value_to_protobuf (struct riemann_host const *host, /* {{{
                gauge_t const *rates)
 {
        Event *event;
+       char name_buffer[5 * DATA_MAX_NAME_LEN];
        char service_buffer[6 * DATA_MAX_NAME_LEN];
        int i;
 
        event = malloc (sizeof (*event));
        if (event == NULL)
        {
-               ERROR ("riemann plugin: malloc failed.");
+               ERROR ("write_riemann plugin: malloc failed.");
                return (NULL);
        }
        memset (event, 0, sizeof (*event));
@@ -277,7 +293,7 @@ static Event *riemann_value_to_protobuf (struct riemann_host const *host, /* {{{
        event->host = strdup (vl->host);
        event->time = CDTIME_T_TO_TIME_T (vl->time);
        event->has_time = 1;
-       event->ttl = CDTIME_T_TO_TIME_T (vl->interval) + host->delay;
+       event->ttl = CDTIME_T_TO_TIME_T (2 * vl->interval);
        event->has_ttl = 1;
 
        riemann_event_add_tag (event, "plugin:%s", vl->plugin);
@@ -327,13 +343,19 @@ static Event *riemann_value_to_protobuf (struct riemann_host const *host, /* {{{
                        event->metric_sint64 = (int64_t) vl->values[index].counter;
        }
 
-       /* TODO: Use FORMAT_VL() here. */
-       ssnprintf (service_buffer, sizeof(service_buffer),
-                       "%s-%s-%s-%s-%s", vl->plugin, vl->plugin_instance,
-                       vl->type, vl->type_instance, ds->ds[index].name);
+       format_name (name_buffer, sizeof (name_buffer),
+                       /* host = */ "", vl->plugin, vl->plugin_instance,
+                       vl->type, vl->type_instance);
+       if (host->always_append_ds || (ds->ds_num > 1))
+               ssnprintf (service_buffer, sizeof (service_buffer),
+                               "%s/%s", &name_buffer[1], ds->ds[index].name);
+       else
+               sstrncpy (service_buffer, &name_buffer[1],
+                               sizeof (service_buffer));
+
        event->service = strdup (service_buffer);
 
-       DEBUG ("riemann plugin: Successfully created protobuf for metric: "
+       DEBUG ("write_riemann plugin: Successfully created protobuf for metric: "
                        "host = \"%s\", service = \"%s\"",
                        event->host, event->service);
        return (event);
@@ -351,7 +373,7 @@ static Msg *riemann_value_list_to_protobuf (struct riemann_host const *host, /*
        msg = malloc (sizeof (*msg));
        if (msg == NULL)
        {
-               ERROR ("riemann plugin: malloc failed.");
+               ERROR ("write_riemann plugin: malloc failed.");
                return (NULL);
        }
        memset (msg, 0, sizeof (*msg));
@@ -362,7 +384,7 @@ static Msg *riemann_value_list_to_protobuf (struct riemann_host const *host, /*
        msg->events = calloc (msg->n_events, sizeof (*msg->events));
        if (msg->events == NULL)
        {
-               ERROR ("riemann plugin: calloc failed.");
+               ERROR ("write_riemann plugin: calloc failed.");
                riemann_msg_protobuf_free (msg);
                return (NULL);
        }
@@ -372,7 +394,7 @@ static Msg *riemann_value_list_to_protobuf (struct riemann_host const *host, /*
                rates = uc_get_rate (ds, vl);
                if (rates == NULL)
                {
-                       ERROR ("riemann plugin: uc_get_rate failed.");
+                       ERROR ("write_riemann plugin: uc_get_rate failed.");
                        riemann_msg_protobuf_free (msg);
                        return (NULL);
                }
@@ -407,7 +429,7 @@ riemann_notification(const notification_t *n, user_data_t *ud)
 
        status = riemann_send (host, msg);
        if (status != 0)
-               ERROR ("riemann plugin: riemann_send failed with status %i",
+               ERROR ("write_riemann plugin: riemann_send failed with status %i",
                                status);
 
        riemann_msg_protobuf_free (msg);
@@ -429,7 +451,7 @@ riemann_write(const data_set_t *ds,
 
        status = riemann_send (host, msg);
        if (status != 0)
-               ERROR ("riemann plugin: riemann_send failed with status %i",
+               ERROR ("write_riemann plugin: riemann_send failed with status %i",
                                status);
 
        riemann_msg_protobuf_free (msg);
@@ -442,6 +464,7 @@ riemann_connect(struct riemann_host *host)
 {
        int                      e;
        struct addrinfo         *ai, *res, hints;
+       char const              *node;
        char const              *service;
 
        if (host->flags & F_CONNECT)
@@ -449,18 +472,18 @@ riemann_connect(struct riemann_host *host)
 
        memset(&hints, 0, sizeof(hints));
        memset(&service, 0, sizeof(service));
-       hints.ai_family = PF_UNSPEC;
-       hints.ai_socktype = SOCK_DGRAM;
+       hints.ai_family = AF_UNSPEC;
+       hints.ai_socktype = host->use_tcp ? SOCK_STREAM : SOCK_DGRAM;
 #ifdef AI_ADDRCONFIG
        hints.ai_flags |= AI_ADDRCONFIG;
 #endif
 
-       assert (host->node != NULL);
+       node = (host->node != NULL) ? host->node : RIEMANN_HOST;
        service = (host->service != NULL) ? host->service : RIEMANN_PORT;
 
-       if ((e = getaddrinfo(host->node, service, &hints, &res)) != 0) {
-               ERROR ("riemann plugin: Unable to resolve host \"%s\": %s",
-                       host->node, gai_strerror(e));
+       if ((e = getaddrinfo(node, service, &hints, &res)) != 0) {
+               ERROR ("write_riemann plugin: Unable to resolve host \"%s\": %s",
+                       node, gai_strerror(e));
                return -1;
        }
 
@@ -479,16 +502,16 @@ riemann_connect(struct riemann_host *host)
                }
 
                host->flags |= F_CONNECT;
-               DEBUG("riemann plugin: got a succesful connection for: %s:%s",
-                               host->node, service);
+               DEBUG("write_riemann plugin: got a succesful connection for: %s:%s",
+                               node, service);
                break;
        }
 
        freeaddrinfo(res);
 
        if (host->s < 0) {
-               WARNING("riemann plugin: Unable to connect to Riemann at %s:%s",
-                               host->node, service);
+               WARNING("write_riemann plugin: Unable to connect to Riemann at %s:%s",
+                               node, service);
                return -1;
        }
        return 0;
@@ -533,35 +556,30 @@ riemann_free(void *p)
 }
 
 static int
-riemann_config_host(oconfig_item_t *ci)
+riemann_config_node(oconfig_item_t *ci)
 {
        struct riemann_host     *host = NULL;
        int                      status = 0;
        int                      i;
        oconfig_item_t          *child;
-       char                     w_cb_name[DATA_MAX_NAME_LEN];
-       char                     n_cb_name[DATA_MAX_NAME_LEN];
+       char                     callback_name[DATA_MAX_NAME_LEN];
        user_data_t              ud;
 
-       if (ci->values_num != 1 ||
-           ci->values[0].type != OCONFIG_TYPE_STRING) {
-               WARNING("riemann hosts need one string argument");
-               return -1;
-       }
-
        if ((host = calloc(1, sizeof (*host))) == NULL) {
-               WARNING("riemann host allocation failed");
+               ERROR ("write_riemann plugin: calloc failed.");
                return ENOMEM;
        }
        pthread_mutex_init (&host->lock, NULL);
        host->reference_count = 1;
        host->node = NULL;
        host->service = NULL;
-       host->delay = RIEMANN_DELAY;
+       host->store_rates = 1;
+       host->always_append_ds = 0;
+       host->use_tcp = 0;
 
-       status = cf_util_get_string (ci, &host->node);
+       status = cf_util_get_string (ci, &host->name);
        if (status != 0) {
-               WARNING("riemann plugin: Required host name is missing.");
+               WARNING("write_riemann plugin: Required host name is missing.");
                riemann_free (host);
                return -1;
        }
@@ -574,23 +592,51 @@ riemann_config_host(oconfig_item_t *ci)
                child = &ci->children[i];
                status = 0;
 
-               if (strcasecmp(child->key, "port") == 0) {
+               if (strcasecmp ("Host", child->key) == 0) {
+                       status = cf_util_get_string (child, &host->node);
+                       if (status != 0)
+                               break;
+               } else if (strcasecmp ("Port", child->key) == 0) {
                        status = cf_util_get_service (child, &host->service);
                        if (status != 0) {
-                               ERROR ("riemann plugin: Invalid argument "
+                               ERROR ("write_riemann plugin: Invalid argument "
                                                "configured for the \"Port\" "
                                                "option.");
                                break;
                        }
-               } else if (strcasecmp(child->key, "delay") == 0) {
-                       if ((status = cf_util_get_int(ci, &host->delay)) != 0)
+               } else if (strcasecmp ("Protocol", child->key) == 0) {
+                       char tmp[16];
+                       status = cf_util_get_string_buffer (child,
+                                       tmp, sizeof (tmp));
+                       if (status != 0)
+                       {
+                               ERROR ("write_riemann plugin: cf_util_get_"
+                                               "string_buffer failed with "
+                                               "status %i.", status);
                                break;
+                       }
+
+                       if (strcasecmp ("UDP", tmp) == 0)
+                               host->use_tcp = 0;
+                       else if (strcasecmp ("TCP", tmp) == 0)
+                               host->use_tcp = 1;
+                       else
+                               WARNING ("write_riemann plugin: The value "
+                                               "\"%s\" is not valid for the "
+                                               "\"Protocol\" option. Use "
+                                               "either \"UDP\" or \"TCP\".",
+                                               tmp);
                } else if (strcasecmp ("StoreRates", child->key) == 0) {
-                       status = cf_util_get_boolean (ci, &host->store_rates);
+                       status = cf_util_get_boolean (child, &host->store_rates);
+                       if (status != 0)
+                               break;
+               } else if (strcasecmp ("AlwaysAppendDS", child->key) == 0) {
+                       status = cf_util_get_boolean (child,
+                                       &host->always_append_ds);
                        if (status != 0)
                                break;
                } else {
-                       WARNING("riemann plugin: ignoring unknown config "
+                       WARNING("write_riemann plugin: ignoring unknown config "
                                "option: \"%s\"", child->key);
                }
        }
@@ -599,33 +645,27 @@ riemann_config_host(oconfig_item_t *ci)
                return status;
        }
 
-       ssnprintf(w_cb_name, sizeof(w_cb_name), "write-riemann/%s:%s",
-                 host->node,
-                 (host->service != NULL) ? host->service : RIEMANN_PORT);
-       ssnprintf(n_cb_name, sizeof(n_cb_name), "notification-riemann/%s:%s",
-                 host->node,
-                 (host->service != NULL) ? host->service : RIEMANN_PORT);
-       DEBUG("riemann w_cb_name: %s", w_cb_name);
-       DEBUG("riemann n_cb_name: %s", n_cb_name);
+       ssnprintf (callback_name, sizeof (callback_name), "write_riemann/%s",
+                       host->name);
        ud.data = host;
        ud.free_func = riemann_free;
 
        pthread_mutex_lock (&host->lock);
 
-       status = plugin_register_write (w_cb_name, riemann_write, &ud);
+       status = plugin_register_write (callback_name, riemann_write, &ud);
        if (status != 0)
-               WARNING ("riemann plugin: plugin_register_write (\"%s\") "
+               WARNING ("write_riemann plugin: plugin_register_write (\"%s\") "
                                "failed with status %i.",
-                               w_cb_name, status);
+                               callback_name, status);
        else /* success */
                host->reference_count++;
 
-       status = plugin_register_notification (n_cb_name,
+       status = plugin_register_notification (callback_name,
                        riemann_notification, &ud);
        if (status != 0)
-               WARNING ("riemann plugin: plugin_register_notification (\"%s\") "
+               WARNING ("write_riemann plugin: plugin_register_notification (\"%s\") "
                                "failed with status %i.",
-                               n_cb_name, status);
+                               callback_name, status);
        else /* success */
                host->reference_count++;
 
@@ -656,8 +696,8 @@ riemann_config(oconfig_item_t *ci)
        for (i = 0; i < ci->children_num; i++)  {
                child = &ci->children[i];
 
-               if (strcasecmp(child->key, "host") == 0) {
-                       riemann_config_host(child);
+               if (strcasecmp("Node", child->key) == 0) {
+                       riemann_config_node (child);
                } else if (strcasecmp(child->key, "tag") == 0) {
                        char *tmp = NULL;
                        status = cf_util_get_string(child, &tmp);
@@ -665,10 +705,10 @@ riemann_config(oconfig_item_t *ci)
                                continue;
 
                        strarray_add (&riemann_tags, &riemann_tags_num, tmp);
-                       DEBUG("riemann plugin: Got tag: %s", tmp);
+                       DEBUG("write_riemann plugin: Got tag: %s", tmp);
                        sfree (tmp);
                } else {
-                       WARNING ("riemann plugin: Ignoring unknown "
+                       WARNING ("write_riemann plugin: Ignoring unknown "
                                 "configuration option \"%s\" at top level.",
                                 child->key);
                }
@@ -679,9 +719,7 @@ riemann_config(oconfig_item_t *ci)
 void
 module_register(void)
 {
-       DEBUG("riemann: module_register");
-
-       plugin_register_complex_config ("riemann", riemann_config);
+       plugin_register_complex_config ("write_riemann", riemann_config);
 }
 
 /* vim: set sw=8 sts=8 ts=8 noet : */