Merge branch 'collectd-5.7'
[collectd.git] / 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 "common.h"
27 #include "plugin.h"
28
29 #include "utils_cache.h"
30 #include "utils_format_graphite.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, int ds_num,
38                             const data_set_t *ds, const value_list_t *vl,
39                             gauge_t const *rates) {
40   size_t offset = 0;
41   int status;
42
43   assert(0 == strcmp(ds->type, vl->type));
44
45   memset(ret, 0, ret_len);
46
47 #define BUFFER_ADD(...)                                                        \
48   do {                                                                         \
49     status = ssnprintf(ret + offset, ret_len - offset, __VA_ARGS__);           \
50     if (status < 1) {                                                          \
51       return (-1);                                                             \
52     } else if (((size_t)status) >= (ret_len - offset)) {                       \
53       return (-1);                                                             \
54     } else                                                                     \
55       offset += ((size_t)status);                                              \
56   } while (0)
57
58   if (ds->ds[ds_num].type == DS_TYPE_GAUGE)
59     BUFFER_ADD(GAUGE_FORMAT, vl->values[ds_num].gauge);
60   else if (rates != NULL)
61     BUFFER_ADD("%f", rates[ds_num]);
62   else if (ds->ds[ds_num].type == DS_TYPE_COUNTER)
63     BUFFER_ADD("%llu", vl->values[ds_num].counter);
64   else if (ds->ds[ds_num].type == DS_TYPE_DERIVE)
65     BUFFER_ADD("%" PRIi64, vl->values[ds_num].derive);
66   else if (ds->ds[ds_num].type == DS_TYPE_ABSOLUTE)
67     BUFFER_ADD("%" PRIu64, vl->values[ds_num].absolute);
68   else {
69     ERROR("gr_format_values plugin: Unknown data source type: %i",
70           ds->ds[ds_num].type);
71     return (-1);
72   }
73
74 #undef BUFFER_ADD
75
76   return (0);
77 }
78
79 static void gr_copy_escape_part(char *dst, const char *src, size_t dst_len,
80                                 char escape_char, _Bool preserve_separator) {
81   memset(dst, 0, dst_len);
82
83   if (src == NULL)
84     return;
85
86   for (size_t i = 0; i < dst_len; i++) {
87     if (src[i] == 0) {
88       dst[i] = 0;
89       break;
90     }
91
92     if ((!preserve_separator && (src[i] == '.')) || isspace((int)src[i]) ||
93         iscntrl((int)src[i]))
94       dst[i] = escape_char;
95     else
96       dst[i] = src[i];
97   }
98 }
99
100 static int gr_format_name(char *ret, int ret_len, value_list_t const *vl,
101                           char const *ds_name, char const *prefix,
102                           char const *postfix, char const escape_char,
103                           unsigned int flags) {
104   char n_host[DATA_MAX_NAME_LEN];
105   char n_plugin[DATA_MAX_NAME_LEN];
106   char n_plugin_instance[DATA_MAX_NAME_LEN];
107   char n_type[DATA_MAX_NAME_LEN];
108   char n_type_instance[DATA_MAX_NAME_LEN];
109
110   char tmp_plugin[2 * DATA_MAX_NAME_LEN + 1];
111   char tmp_type[2 * DATA_MAX_NAME_LEN + 1];
112
113   if (prefix == NULL)
114     prefix = "";
115
116   if (postfix == NULL)
117     postfix = "";
118
119   _Bool preserve_separator = (flags & GRAPHITE_PRESERVE_SEPARATOR) ? 1 : 0;
120
121   gr_copy_escape_part(n_host, vl->host, sizeof(n_host), escape_char,
122                       preserve_separator);
123   gr_copy_escape_part(n_plugin, vl->plugin, sizeof(n_plugin), escape_char,
124                       preserve_separator);
125   gr_copy_escape_part(n_plugin_instance, vl->plugin_instance,
126                       sizeof(n_plugin_instance), escape_char,
127                       preserve_separator);
128   gr_copy_escape_part(n_type, vl->type, sizeof(n_type), escape_char,
129                       preserve_separator);
130   gr_copy_escape_part(n_type_instance, vl->type_instance,
131                       sizeof(n_type_instance), escape_char, preserve_separator);
132
133   if (n_plugin_instance[0] != '\0')
134     ssnprintf(tmp_plugin, sizeof(tmp_plugin), "%s%c%s", n_plugin,
135               (flags & GRAPHITE_SEPARATE_INSTANCES) ? '.' : '-',
136               n_plugin_instance);
137   else
138     sstrncpy(tmp_plugin, n_plugin, sizeof(tmp_plugin));
139
140   if (n_type_instance[0] != '\0') {
141     if ((flags & GRAPHITE_DROP_DUPE_FIELDS) && strcmp(n_plugin, n_type) == 0)
142       sstrncpy(tmp_type, n_type_instance, sizeof(tmp_type));
143     else
144       ssnprintf(tmp_type, sizeof(tmp_type), "%s%c%s", n_type,
145                 (flags & GRAPHITE_SEPARATE_INSTANCES) ? '.' : '-',
146                 n_type_instance);
147   } else
148     sstrncpy(tmp_type, n_type, sizeof(tmp_type));
149
150   /* Assert always_append_ds -> ds_name */
151   assert(!(flags & GRAPHITE_ALWAYS_APPEND_DS) || (ds_name != NULL));
152   if (ds_name != NULL) {
153     if ((flags & GRAPHITE_DROP_DUPE_FIELDS) &&
154         strcmp(tmp_plugin, tmp_type) == 0)
155       ssnprintf(ret, ret_len, "%s%s%s.%s.%s", prefix, n_host, postfix,
156                 tmp_plugin, ds_name);
157     else
158       ssnprintf(ret, ret_len, "%s%s%s.%s.%s.%s", prefix, n_host, postfix,
159                 tmp_plugin, tmp_type, ds_name);
160   } else
161     ssnprintf(ret, ret_len, "%s%s%s.%s.%s", prefix, n_host, postfix, tmp_plugin,
162               tmp_type);
163
164   return (0);
165 }
166
167 static void escape_graphite_string(char *buffer, char escape_char) {
168   assert(strchr(GRAPHITE_FORBIDDEN, escape_char) == NULL);
169
170   for (char *head = buffer + strcspn(buffer, GRAPHITE_FORBIDDEN); *head != '\0';
171        head += strcspn(head, GRAPHITE_FORBIDDEN))
172     *head = escape_char;
173 }
174
175 int format_graphite(char *buffer, size_t buffer_size, data_set_t const *ds,
176                     value_list_t const *vl, char const *prefix,
177                     char const *postfix, char const escape_char,
178                     unsigned int flags) {
179   int status = 0;
180   int buffer_pos = 0;
181
182   gauge_t *rates = NULL;
183   if (flags & GRAPHITE_STORE_RATES)
184     rates = uc_get_rate(ds, vl);
185
186   for (size_t i = 0; i < ds->ds_num; i++) {
187     char const *ds_name = NULL;
188     char key[10 * DATA_MAX_NAME_LEN];
189     char values[512];
190     size_t message_len;
191     char message[1024];
192
193     if ((flags & GRAPHITE_ALWAYS_APPEND_DS) || (ds->ds_num > 1))
194       ds_name = ds->ds[i].name;
195
196     /* Copy the identifier to `key' and escape it. */
197     status = gr_format_name(key, sizeof(key), vl, ds_name, prefix, postfix,
198                             escape_char, flags);
199     if (status != 0) {
200       ERROR("format_graphite: error with gr_format_name");
201       sfree(rates);
202       return (status);
203     }
204
205     escape_graphite_string(key, escape_char);
206     /* Convert the values to an ASCII representation and put that into
207      * `values'. */
208     status = gr_format_values(values, sizeof(values), i, ds, vl, rates);
209     if (status != 0) {
210       ERROR("format_graphite: error with gr_format_values");
211       sfree(rates);
212       return (status);
213     }
214
215     /* Compute the graphite command */
216     message_len =
217         (size_t)ssnprintf(message, sizeof(message), "%s %s %u\r\n", key, values,
218                           (unsigned int)CDTIME_T_TO_TIME_T(vl->time));
219     if (message_len >= sizeof(message)) {
220       ERROR("format_graphite: message buffer too small: "
221             "Need %zu bytes.",
222             message_len + 1);
223       sfree(rates);
224       return (-ENOMEM);
225     }
226
227     /* Append it in case we got multiple data set */
228     if ((buffer_pos + message_len) >= buffer_size) {
229       ERROR("format_graphite: target buffer too small");
230       sfree(rates);
231       return (-ENOMEM);
232     }
233     memcpy((void *)(buffer + buffer_pos), message, message_len);
234     buffer_pos += message_len;
235     buffer[buffer_pos] = '\0';
236   }
237   sfree(rates);
238   return (status);
239 } /* int format_graphite */