src/utils_format_graphite.c

   1 /**
   2  * collectd - src/utils_format_graphite.c
   3  * Copyright (C) 2012  Thomas Meson
   4  * Copyright (C) 2012  Florian octo Forster
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License as published by the
   8  * Free Software Foundation; only version 2 of the License is applicable.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  18  *
  19  * Authors:
  20  *   Thomas Meson <zllak at hycik.org>
  21  *   Florian octo Forster <octo at collectd.org>
  22  **/
  23
  24 #include "collectd.h"
  25
  26 #include "plugin.h"
  27 #include "common.h"
  28
  29 #include "utils_format_graphite.h"
  30 #include "utils_cache.h"
  31
  32 #define GRAPHITE_FORBIDDEN " \t\"\\:!/()\n\r"
  33
  34 /* Utils functions to format data sets in graphite format.
  35  * Largely taken from write_graphite.c as it remains the same formatting */
  36
  37 static int gr_format_values (char *ret, size_t ret_len,
  38         int ds_num, const data_set_t *ds, const value_list_t *vl,
  39         gauge_t const *rates)
  40 {
  41     size_t offset = 0;
  42     int status;
  43
  44     assert (0 == strcmp (ds->type, vl->type));
  45
  46     memset (ret, 0, ret_len);
  47
  48 #define BUFFER_ADD(...) do { \
  49     status = ssnprintf (ret + offset, ret_len - offset, \
  50             __VA_ARGS__); \
  51     if (status < 1) \
  52     { \
  53         return (-1); \
  54     } \
  55     else if (((size_t) status) >= (ret_len - offset)) \
  56     { \
  57         return (-1); \
  58     } \
  59     else \
  60     offset += ((size_t) status); \
  61 } while (0)
  62
  63     if (ds->ds[ds_num].type == DS_TYPE_GAUGE)
  64         BUFFER_ADD (GAUGE_FORMAT, vl->values[ds_num].gauge);
  65     else if (rates != NULL)
  66         BUFFER_ADD ("%f", rates[ds_num]);
  67     else if (ds->ds[ds_num].type == DS_TYPE_COUNTER)
  68         BUFFER_ADD ("%llu", vl->values[ds_num].counter);
  69     else if (ds->ds[ds_num].type == DS_TYPE_DERIVE)
  70         BUFFER_ADD ("%"PRIi64, vl->values[ds_num].derive);
  71     else if (ds->ds[ds_num].type == DS_TYPE_ABSOLUTE)
  72         BUFFER_ADD ("%"PRIu64, vl->values[ds_num].absolute);
  73     else
  74     {
  75         ERROR ("gr_format_values plugin: Unknown data source type: %i",
  76                 ds->ds[ds_num].type);
  77         return (-1);
  78     }
  79
  80 #undef BUFFER_ADD
  81
  82     return (0);
  83 }
  84
  85 static void gr_copy_escape_part (char *dst, const char *src, size_t dst_len,
  86     char escape_char)
  87 {
  88     memset (dst, 0, dst_len);
  89
  90     if (src == NULL)
  91         return;
  92
  93     for (size_t i = 0; i < dst_len; i++)
  94     {
  95         if (src[i] == 0)
  96         {
  97             dst[i] = 0;
  98             break;
  99         }
 100
 101         if ((src[i] == '.')
 102                 || isspace ((int) src[i])
 103                 || iscntrl ((int) src[i]))
 104             dst[i] = escape_char;
 105         else
 106             dst[i] = src[i];
 107     }
 108 }
 109
 110 static int gr_format_name (char *ret, int ret_len,
 111         value_list_t const *vl,
 112         char const *ds_name,
 113         char const *prefix,
 114         char const *postfix,
 115         char const escape_char,
 116         unsigned int flags)
 117 {
 118     char n_host[DATA_MAX_NAME_LEN];
 119     char n_plugin[DATA_MAX_NAME_LEN];
 120     char n_plugin_instance[DATA_MAX_NAME_LEN];
 121     char n_type[DATA_MAX_NAME_LEN];
 122     char n_type_instance[DATA_MAX_NAME_LEN];
 123
 124     char tmp_plugin[2 * DATA_MAX_NAME_LEN + 1];
 125     char tmp_type[2 * DATA_MAX_NAME_LEN + 1];
 126
 127     if (prefix == NULL)
 128         prefix = "";
 129
 130     if (postfix == NULL)
 131         postfix = "";
 132
 133     gr_copy_escape_part (n_host, vl->host,
 134             sizeof (n_host), escape_char);
 135     gr_copy_escape_part (n_plugin, vl->plugin,
 136             sizeof (n_plugin), escape_char);
 137     gr_copy_escape_part (n_plugin_instance, vl->plugin_instance,
 138             sizeof (n_plugin_instance), escape_char);
 139     gr_copy_escape_part (n_type, vl->type,
 140             sizeof (n_type), escape_char);
 141     gr_copy_escape_part (n_type_instance, vl->type_instance,
 142             sizeof (n_type_instance), escape_char);
 143
 144     if (n_plugin_instance[0] != '\0')
 145         ssnprintf (tmp_plugin, sizeof (tmp_plugin), "%s%c%s",
 146             n_plugin,
 147             (flags & GRAPHITE_SEPARATE_INSTANCES) ? '.' : '-',
 148             n_plugin_instance);
 149     else
 150         sstrncpy (tmp_plugin, n_plugin, sizeof (tmp_plugin));
 151
 152     if (n_type_instance[0] != '\0')
 153         ssnprintf (tmp_type, sizeof (tmp_type), "%s%c%s",
 154             n_type,
 155             (flags & GRAPHITE_SEPARATE_INSTANCES) ? '.' : '-',
 156             n_type_instance);
 157     else
 158         sstrncpy (tmp_type, n_type, sizeof (tmp_type));
 159
 160     /* Assert always_append_ds -> ds_name */
 161     assert (!(flags & GRAPHITE_ALWAYS_APPEND_DS) || (ds_name != NULL));
 162     if (ds_name != NULL)
 163         ssnprintf (ret, ret_len, "%s%s%s.%s.%s.%s",
 164             prefix, n_host, postfix, tmp_plugin, tmp_type, ds_name);
 165     else
 166         ssnprintf (ret, ret_len, "%s%s%s.%s.%s",
 167             prefix, n_host, postfix, tmp_plugin, tmp_type);
 168
 169     return (0);
 170 }
 171
 172 static void escape_graphite_string (char *buffer, char escape_char)
 173 {
 174         assert (strchr(GRAPHITE_FORBIDDEN, escape_char) == NULL);
 175
 176         for (char *head = buffer + strcspn(buffer, GRAPHITE_FORBIDDEN);
 177              *head != '\0';
 178              head += strcspn(head, GRAPHITE_FORBIDDEN))
 179                 *head = escape_char;
 180 }
 181
 182 int format_graphite (char *buffer, size_t buffer_size,
 183     data_set_t const *ds, value_list_t const *vl,
 184     char const *prefix, char const *postfix, char const escape_char,
 185     unsigned int flags)
 186 {
 187     int status = 0;
 188     int buffer_pos = 0;
 189
 190     gauge_t *rates = NULL;
 191     if (flags & GRAPHITE_STORE_RATES)
 192       rates = uc_get_rate (ds, vl);
 193
 194     for (size_t i = 0; i < ds->ds_num; i++)
 195     {
 196         char const *ds_name = NULL;
 197         char        key[10*DATA_MAX_NAME_LEN];
 198         char        values[512];
 199         size_t      message_len;
 200         char        message[1024];
 201
 202         if ((flags & GRAPHITE_ALWAYS_APPEND_DS)
 203             || (ds->ds_num > 1))
 204           ds_name = ds->ds[i].name;
 205
 206         /* Copy the identifier to `key' and escape it. */
 207         status = gr_format_name (key, sizeof (key), vl, ds_name,
 208                     prefix, postfix, escape_char, flags);
 209         if (status != 0)
 210         {
 211             ERROR ("format_graphite: error with gr_format_name");
 212             sfree (rates);
 213             return (status);
 214         }
 215
 216         escape_graphite_string (key, escape_char);
 217         /* Convert the values to an ASCII representation and put that into
 218          * `values'. */
 219         status = gr_format_values (values, sizeof (values), i, ds, vl, rates);
 220         if (status != 0)
 221         {
 222             ERROR ("format_graphite: error with gr_format_values");
 223             sfree (rates);
 224             return (status);
 225         }
 226
 227         /* Compute the graphite command */
 228         message_len = (size_t) ssnprintf (message, sizeof (message),
 229                 "%s %s %u\r\n",
 230                 key,
 231                 values,
 232                 (unsigned int) CDTIME_T_TO_TIME_T (vl->time));
 233         if (message_len >= sizeof (message)) {
 234             ERROR ("format_graphite: message buffer too small: "
 235                     "Need %zu bytes.", message_len + 1);
 236             sfree (rates);
 237             return (-ENOMEM);
 238         }
 239
 240         /* Append it in case we got multiple data set */
 241         if ((buffer_pos + message_len) >= buffer_size)
 242         {
 243             ERROR ("format_graphite: target buffer too small");
 244             sfree (rates);
 245             return (-ENOMEM);
 246         }
 247         memcpy((void *) (buffer + buffer_pos), message, message_len);
 248         buffer_pos += message_len;
 249         buffer[buffer_pos] = '\0';
 250     }
 251     sfree (rates);
 252     return (status);
 253 } /* int format_graphite */
 254
 255 /* vim: set sw=2 sts=2 et fdm=marker : */