2 * collectd - src/utils_format_graphite.c
3 * Copyright (C) 2012 Thomas Meson
4 * Copyright (C) 2012 Florian octo Forster
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.
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.
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
20 * Thomas Meson <zllak at hycik.org>
21 * Florian octo Forster <octo at collectd.org>
27 #include "utils/common/common.h"
29 #include "utils/format_graphite/format_graphite.h"
30 #include "utils_cache.h"
32 #define GRAPHITE_FORBIDDEN " \t\"\\:!/()\n\r"
34 /* Utils functions to format data sets in graphite format.
35 * Largely taken from write_graphite.c as it remains the same formatting */
37 /* helper function for reverse_hostname */
38 void reverse_string(char *r_host, int len) {
39 for (int i = 0, j = len - 1; i < j; i++, j--) {
41 r_host[i] = r_host[j];
46 void reverse_hostname(char *r_host, char const *orig_host) {
47 int len_host = strlen(orig_host);
49 /* put reversed hostname into working copy */
50 for (int i = 0; i < len_host; i++)
51 r_host[i] = orig_host[len_host - 1 - i];
52 r_host[len_host] = '\0';
54 /* reverse labels (except last) */
56 for (int i = 0; i < len_host; i++)
57 if (r_host[i] == '.') {
58 reverse_string(&r_host[p], i - p);
62 /* reverse last label */
63 reverse_string(&r_host[p], len_host - p);
66 static int gr_format_values(char *ret, size_t ret_len, int ds_num,
67 const data_set_t *ds, const value_list_t *vl,
68 gauge_t const *rates) {
72 assert(0 == strcmp(ds->type, vl->type));
74 memset(ret, 0, ret_len);
76 #define BUFFER_ADD(...) \
78 status = snprintf(ret + offset, ret_len - offset, __VA_ARGS__); \
81 } else if (((size_t)status) >= (ret_len - offset)) { \
84 offset += ((size_t)status); \
87 if (ds->ds[ds_num].type == DS_TYPE_GAUGE)
88 BUFFER_ADD(GAUGE_FORMAT, vl->values[ds_num].gauge);
89 else if (rates != NULL)
90 BUFFER_ADD("%f", rates[ds_num]);
91 else if (ds->ds[ds_num].type == DS_TYPE_COUNTER)
92 BUFFER_ADD("%" PRIu64, (uint64_t)vl->values[ds_num].counter);
93 else if (ds->ds[ds_num].type == DS_TYPE_DERIVE)
94 BUFFER_ADD("%" PRIi64, vl->values[ds_num].derive);
95 else if (ds->ds[ds_num].type == DS_TYPE_ABSOLUTE)
96 BUFFER_ADD("%" PRIu64, vl->values[ds_num].absolute);
98 P_ERROR("gr_format_values: Unknown data source type: %i",
108 static void gr_copy_escape_part(char *dst, const char *src, size_t dst_len,
109 char escape_char, bool preserve_separator) {
110 memset(dst, 0, dst_len);
115 for (size_t i = 0; i < dst_len; i++) {
121 if ((!preserve_separator && (src[i] == '.')) || isspace((int)src[i]) ||
122 iscntrl((int)src[i]))
123 dst[i] = escape_char;
129 static int gr_format_name_tagged(char *ret, int ret_len, value_list_t const *vl,
130 char const *ds_name, char const *prefix,
131 char const *postfix, char const escape_char,
132 unsigned int flags) {
133 char n_host[DATA_MAX_NAME_LEN];
134 char n_plugin[DATA_MAX_NAME_LEN];
135 char n_plugin_instance[DATA_MAX_NAME_LEN];
136 char n_type[DATA_MAX_NAME_LEN];
137 char n_type_instance[DATA_MAX_NAME_LEN];
139 char tmp_plugin[DATA_MAX_NAME_LEN + 8];
140 char tmp_plugin_instance[DATA_MAX_NAME_LEN + 17];
141 char tmp_type[DATA_MAX_NAME_LEN + 6];
142 char tmp_type_instance[DATA_MAX_NAME_LEN + 15];
143 char tmp_metric[3 * DATA_MAX_NAME_LEN + 2];
144 char tmp_ds_name[DATA_MAX_NAME_LEN + 9];
152 if (flags & GRAPHITE_REVERSE_HOST) {
153 char r_host[DATA_MAX_NAME_LEN];
154 reverse_hostname(r_host, vl->host);
155 gr_copy_escape_part(n_host, r_host, sizeof(n_host), escape_char, 1);
157 gr_copy_escape_part(n_host, vl->host, sizeof(n_host), escape_char, 1);
159 gr_copy_escape_part(n_plugin, vl->plugin, sizeof(n_plugin), escape_char, 1);
160 gr_copy_escape_part(n_plugin_instance, vl->plugin_instance,
161 sizeof(n_plugin_instance), escape_char, 1);
162 gr_copy_escape_part(n_type, vl->type, sizeof(n_type), escape_char, 1);
163 gr_copy_escape_part(n_type_instance, vl->type_instance,
164 sizeof(n_type_instance), escape_char, 1);
166 snprintf(tmp_plugin, sizeof(tmp_plugin), ";plugin=%s", n_plugin);
168 if (n_plugin_instance[0] != '\0')
169 snprintf(tmp_plugin_instance, sizeof(tmp_plugin_instance),
170 ";plugin_instance=%s", n_plugin_instance);
172 tmp_plugin_instance[0] = '\0';
174 if (!(flags & GRAPHITE_DROP_DUPE_FIELDS) || strcmp(n_plugin, n_type) != 0)
175 snprintf(tmp_type, sizeof(tmp_type), ";type=%s", n_type);
179 if (n_type_instance[0] != '\0') {
180 if (!(flags & GRAPHITE_DROP_DUPE_FIELDS) ||
181 strcmp(n_plugin_instance, n_type_instance) != 0)
182 snprintf(tmp_type_instance, sizeof(tmp_type_instance),
183 ";type_instance=%s", n_type_instance);
185 tmp_type_instance[0] = '\0';
187 tmp_type_instance[0] = '\0';
189 /* Assert always_append_ds -> ds_name */
190 assert(!(flags & GRAPHITE_ALWAYS_APPEND_DS) || (ds_name != NULL));
191 if (ds_name != NULL) {
192 snprintf(tmp_ds_name, sizeof(tmp_ds_name), ";ds_name=%s", ds_name);
194 if ((flags & GRAPHITE_DROP_DUPE_FIELDS) && strcmp(n_plugin, n_type) == 0)
195 snprintf(tmp_metric, sizeof(tmp_metric), "%s.%s", n_plugin, ds_name);
197 snprintf(tmp_metric, sizeof(tmp_metric), "%s.%s.%s", n_plugin, n_type,
200 tmp_ds_name[0] = '\0';
202 if ((flags & GRAPHITE_DROP_DUPE_FIELDS) && strcmp(n_plugin, n_type) == 0)
203 snprintf(tmp_metric, sizeof(tmp_metric), "%s", n_plugin);
205 snprintf(tmp_metric, sizeof(tmp_metric), "%s.%s", n_plugin, n_type);
208 snprintf(ret, ret_len, "%s%s%s;host=%s%s%s%s%s%s", prefix, tmp_metric,
209 postfix, n_host, tmp_plugin, tmp_plugin_instance, tmp_type,
210 tmp_type_instance, tmp_ds_name);
215 static int gr_format_name(char *ret, int ret_len, value_list_t const *vl,
216 char const *ds_name, char const *prefix,
217 char const *postfix, char const escape_char,
218 unsigned int flags) {
219 char n_host[DATA_MAX_NAME_LEN];
220 char n_plugin[DATA_MAX_NAME_LEN];
221 char n_plugin_instance[DATA_MAX_NAME_LEN];
222 char n_type[DATA_MAX_NAME_LEN];
223 char n_type_instance[DATA_MAX_NAME_LEN];
225 char tmp_plugin[2 * DATA_MAX_NAME_LEN + 1];
226 char tmp_type[2 * DATA_MAX_NAME_LEN + 1];
234 bool preserve_separator = (flags & GRAPHITE_PRESERVE_SEPARATOR);
236 if (flags & GRAPHITE_REVERSE_HOST) {
237 char r_host[DATA_MAX_NAME_LEN];
238 reverse_hostname(r_host, vl->host);
239 gr_copy_escape_part(n_host, r_host, sizeof(n_host), escape_char,
242 gr_copy_escape_part(n_host, vl->host, sizeof(n_host), escape_char,
245 gr_copy_escape_part(n_plugin, vl->plugin, sizeof(n_plugin), escape_char,
247 gr_copy_escape_part(n_plugin_instance, vl->plugin_instance,
248 sizeof(n_plugin_instance), escape_char,
250 gr_copy_escape_part(n_type, vl->type, sizeof(n_type), escape_char,
252 gr_copy_escape_part(n_type_instance, vl->type_instance,
253 sizeof(n_type_instance), escape_char, preserve_separator);
255 if (n_plugin_instance[0] != '\0')
256 snprintf(tmp_plugin, sizeof(tmp_plugin), "%s%c%s", n_plugin,
257 (flags & GRAPHITE_SEPARATE_INSTANCES) ? '.' : '-',
260 sstrncpy(tmp_plugin, n_plugin, sizeof(tmp_plugin));
262 if (n_type_instance[0] != '\0') {
263 if ((flags & GRAPHITE_DROP_DUPE_FIELDS) && strcmp(n_plugin, n_type) == 0)
264 sstrncpy(tmp_type, n_type_instance, sizeof(tmp_type));
266 snprintf(tmp_type, sizeof(tmp_type), "%s%c%s", n_type,
267 (flags & GRAPHITE_SEPARATE_INSTANCES) ? '.' : '-',
270 sstrncpy(tmp_type, n_type, sizeof(tmp_type));
272 /* Assert always_append_ds -> ds_name */
273 assert(!(flags & GRAPHITE_ALWAYS_APPEND_DS) || (ds_name != NULL));
274 if (ds_name != NULL) {
275 if ((flags & GRAPHITE_DROP_DUPE_FIELDS) &&
276 strcmp(tmp_plugin, tmp_type) == 0)
277 snprintf(ret, ret_len, "%s%s%s.%s.%s", prefix, n_host, postfix,
278 tmp_plugin, ds_name);
280 snprintf(ret, ret_len, "%s%s%s.%s.%s.%s", prefix, n_host, postfix,
281 tmp_plugin, tmp_type, ds_name);
283 snprintf(ret, ret_len, "%s%s%s.%s.%s", prefix, n_host, postfix, tmp_plugin,
289 static void escape_graphite_string(char *buffer, char escape_char) {
290 assert(strchr(GRAPHITE_FORBIDDEN, escape_char) == NULL);
292 for (char *head = buffer + strcspn(buffer, GRAPHITE_FORBIDDEN); *head != '\0';
293 head += strcspn(head, GRAPHITE_FORBIDDEN))
297 int format_graphite(char *buffer, size_t buffer_size, data_set_t const *ds,
298 value_list_t const *vl, char const *prefix,
299 char const *postfix, char const escape_char,
300 unsigned int flags) {
304 gauge_t *rates = NULL;
305 if (flags & GRAPHITE_STORE_RATES) {
306 rates = uc_get_rate(ds, vl);
308 P_ERROR("format_graphite: error with uc_get_rate");
313 for (size_t i = 0; i < ds->ds_num; i++) {
314 char const *ds_name = NULL;
315 char key[10 * DATA_MAX_NAME_LEN];
320 if ((flags & GRAPHITE_ALWAYS_APPEND_DS) || (ds->ds_num > 1))
321 ds_name = ds->ds[i].name;
323 /* Copy the identifier to `key' and escape it. */
324 if (flags & GRAPHITE_USE_TAGS) {
325 status = gr_format_name_tagged(key, sizeof(key), vl, ds_name, prefix,
326 postfix, escape_char, flags);
328 P_ERROR("format_graphite: error with gr_format_name_tagged");
333 status = gr_format_name(key, sizeof(key), vl, ds_name, prefix, postfix,
336 P_ERROR("format_graphite: error with gr_format_name");
342 escape_graphite_string(key, escape_char);
344 /* Convert the values to an ASCII representation and put that into
346 status = gr_format_values(values, sizeof(values), i, ds, vl, rates);
348 P_ERROR("format_graphite: error with gr_format_values");
353 /* Compute the graphite command */
355 (size_t)snprintf(message, sizeof(message), "%s %s %u\r\n", key, values,
356 (unsigned int)CDTIME_T_TO_TIME_T(vl->time));
357 if (message_len >= sizeof(message)) {
358 P_ERROR("format_graphite: message buffer too small: "
359 "Need %" PRIsz " bytes.",
365 /* Append it in case we got multiple data set */
366 if ((buffer_pos + message_len) >= buffer_size) {
367 P_ERROR("format_graphite: target buffer too small");
371 memcpy((void *)(buffer + buffer_pos), message, message_len);
372 buffer_pos += message_len;
373 buffer[buffer_pos] = '\0';
377 } /* int format_graphite */