2 * collectd - src/utils_format_kairosdb.c
3 * Copyright (C) 2016 Aurelien beorn Rougemont
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
24 * Aurelien beorn Rougemont <beorn at gandi dot net>
33 #include "utils_cache.h"
34 #include "utils_format_kairosdb.h"
37 /* This is the KAIROSDB format for write_http output
42 * "name":"collectd.vmem"
45 * [1453897164060, 97.000000]
49 * "host": "fqdn.domain.tld",
50 * "plugin_instance": "vmpage_number",
51 * "type": "kernel_stack",
59 static int kairosdb_escape_string (char *buffer, size_t buffer_size, /* {{{ */
65 if ((buffer == NULL) || (string == NULL))
73 #define BUFFER_ADD(c) do { \
74 if (dst_pos >= (buffer_size - 1)) { \
75 buffer[buffer_size - 1] = 0; \
78 buffer[dst_pos] = (c); \
82 /* Escape special characters */
83 /* authorize -_. and alpha num but also escapes " */
85 for (src_pos = 0; string[src_pos] != 0; src_pos++)
87 if (isalnum(string[src_pos]) ||
88 0x2d == string[src_pos] ||
89 0x2e == string[src_pos] ||
90 0x5f == string[src_pos])
91 BUFFER_ADD (tolower(string[src_pos]));
99 } /* }}} int kairosdb_escape_string */
101 static int values_to_kairosdb (char *buffer, size_t buffer_size, /* {{{ */
102 const data_set_t *ds, const value_list_t *vl, int store_rates,
106 gauge_t *rates = NULL;
108 memset (buffer, 0, buffer_size);
110 #define BUFFER_ADD(...) do { \
112 status = ssnprintf (buffer + offset, buffer_size - offset, \
119 else if (((size_t) status) >= (buffer_size - offset)) \
125 offset += ((size_t) status); \
128 if (ds->ds[ds_idx].type == DS_TYPE_GAUGE)
130 if (isfinite (vl->values[ds_idx].gauge))
133 BUFFER_ADD ("%"PRIu64, CDTIME_T_TO_MS (vl->time));
135 BUFFER_ADD (JSON_GAUGE_FORMAT, vl->values[ds_idx].gauge);
139 DEBUG ("utils_format_kairosdb: invalid vl->values[ds_idx].gauge for %s|%s|%s|%s|%s",
144 ds->ds[ds_idx].name);
148 else if (store_rates)
151 rates = uc_get_rate (ds, vl);
154 WARNING ("utils_format_kairosdb: uc_get_rate failed for %s|%s|%s|%s|%s",
159 ds->ds[ds_idx].name);
164 if (isfinite (rates[ds_idx]))
167 BUFFER_ADD ("%"PRIu64, CDTIME_T_TO_MS (vl->time));
169 BUFFER_ADD (JSON_GAUGE_FORMAT, rates[ds_idx]);
173 WARNING ("utils_format_kairosdb: invalid rates[ds_idx] for %s|%s|%s|%s|%s",
178 ds->ds[ds_idx].name);
183 else if (ds->ds[ds_idx].type == DS_TYPE_COUNTER)
186 BUFFER_ADD ("%"PRIu64, CDTIME_T_TO_MS (vl->time));
188 BUFFER_ADD ("%llu", vl->values[ds_idx].counter);
190 else if (ds->ds[ds_idx].type == DS_TYPE_DERIVE)
193 BUFFER_ADD ("%"PRIu64, CDTIME_T_TO_MS (vl->time));
195 BUFFER_ADD ("%"PRIi64, vl->values[ds_idx].derive);
197 else if (ds->ds[ds_idx].type == DS_TYPE_ABSOLUTE)
200 BUFFER_ADD ("%"PRIu64, CDTIME_T_TO_MS (vl->time));
202 BUFFER_ADD ("%"PRIu64, vl->values[ds_idx].absolute);
206 ERROR ("format_kairosdb: Unknown data source type: %i",
207 ds->ds[ds_idx].type);
215 DEBUG ("format_kairosdb: values_to_kairosdb: buffer = %s;", buffer);
218 } /* }}} int values_to_kairosdb */
220 static int value_list_to_kairosdb (char *buffer, size_t buffer_size, /* {{{ */
221 const data_set_t *ds, const value_list_t *vl, int store_rates)
228 memset (buffer, 0, buffer_size);
230 #define BUFFER_ADD(...) do { \
231 status = ssnprintf (buffer + offset, buffer_size - offset, \
235 else if (((size_t) status) >= (buffer_size - offset)) \
238 offset += ((size_t) status); \
241 #define BUFFER_ADD_KEYVAL(key, value) do { \
242 status = kairosdb_escape_string (temp, sizeof (temp), (value)); \
245 BUFFER_ADD (",\"%s\": %s", (key), temp); \
248 for (i = 0; i < ds->ds_num; i++)
250 /* All value lists have a leading comma. The first one will be replaced with
251 * a square bracket in `format_kairosdb_finalize'. */
254 BUFFER_ADD ("\"name\":\"collectd");
256 BUFFER_ADD (".%s", vl->plugin);
258 status = values_to_kairosdb (temp, sizeof (temp), ds, vl, store_rates, i);
262 BUFFER_ADD ("\", \"datapoints\": %s", temp);
265 * Now adds meta data to metric as tags
268 memset (temp, 0, sizeof(temp));
270 BUFFER_ADD (", \"tags\":\{");
272 BUFFER_ADD ("\"host\": \"%s\"", vl->host);
273 if (strlen(vl->plugin_instance))
274 BUFFER_ADD_KEYVAL ("plugin_instance", vl->plugin_instance);
275 BUFFER_ADD_KEYVAL ("type", vl->type);
276 if (strlen(vl->type_instance))
277 BUFFER_ADD_KEYVAL ("type_instance", vl->type_instance);
279 BUFFER_ADD_KEYVAL ("ds", ds->ds[i].name);
281 } /* for ds->ds_num */
283 #undef BUFFER_ADD_KEYVAL
286 DEBUG ("format_kairosdb: value_list_to_kairosdb: buffer = %s;", buffer);
289 } /* }}} int value_list_to_kairosdb */
291 static int format_kairosdb_value_list_nocheck (char *buffer, /* {{{ */
292 size_t *ret_buffer_fill, size_t *ret_buffer_free,
293 const data_set_t *ds, const value_list_t *vl,
294 int store_rates, size_t temp_size)
296 char temp[temp_size];
299 status = value_list_to_kairosdb (temp, sizeof (temp), ds, vl, store_rates);
302 temp_size = strlen (temp);
304 memcpy (buffer + (*ret_buffer_fill), temp, temp_size + 1);
305 (*ret_buffer_fill) += temp_size;
306 (*ret_buffer_free) -= temp_size;
309 } /* }}} int format_kairosdb_value_list_nocheck */
311 int format_kairosdb_initialize (char *buffer, /* {{{ */
312 size_t *ret_buffer_fill, size_t *ret_buffer_free)
317 if ((buffer == NULL) || (ret_buffer_fill == NULL) || (ret_buffer_free == NULL))
320 buffer_fill = *ret_buffer_fill;
321 buffer_free = *ret_buffer_free;
323 buffer_free = buffer_fill + buffer_free;
329 memset (buffer, 0, buffer_free);
330 *ret_buffer_fill = buffer_fill;
331 *ret_buffer_free = buffer_free;
334 } /* }}} int format_kairosdb_initialize */
336 int format_kairosdb_finalize (char *buffer, /* {{{ */
337 size_t *ret_buffer_fill, size_t *ret_buffer_free)
341 if ((buffer == NULL) || (ret_buffer_fill == NULL) || (ret_buffer_free == NULL))
344 if (*ret_buffer_free < 2)
347 /* Replace the leading comma added in `value_list_to_kairosdb' with a square
349 if (buffer[0] != ',')
353 pos = *ret_buffer_fill;
357 (*ret_buffer_fill)++;
358 (*ret_buffer_free)--;
361 } /* }}} int format_kairosdb_finalize */
363 int format_kairosdb_value_list (char *buffer, /* {{{ */
364 size_t *ret_buffer_fill, size_t *ret_buffer_free,
365 const data_set_t *ds, const value_list_t *vl, int store_rates)
368 || (ret_buffer_fill == NULL) || (ret_buffer_free == NULL)
369 || (ds == NULL) || (vl == NULL))
372 if (*ret_buffer_free < 3)
375 return (format_kairosdb_value_list_nocheck (buffer,
376 ret_buffer_fill, ret_buffer_free, ds, vl,
377 store_rates, (*ret_buffer_free) - 2));
378 } /* }}} int format_kairosdb_value_list */
380 /* vim: set sw=2 sts=2 et fdm=marker : */