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, /* {{{ */
64 if ((buffer == NULL) || (string == NULL))
72 #define BUFFER_ADD(c) do { \
73 if (dst_pos >= (buffer_size - 1)) { \
74 buffer[buffer_size - 1] = 0; \
77 buffer[dst_pos] = (c); \
81 /* Escape special characters */
82 /* authorize -_. and alpha num but also escapes " */
84 for (size_t src_pos = 0; string[src_pos] != 0; src_pos++)
86 if (isalnum(string[src_pos]) ||
87 0x2d == string[src_pos] ||
88 0x2e == string[src_pos] ||
89 0x5f == string[src_pos])
90 BUFFER_ADD (tolower(string[src_pos]));
98 } /* }}} int kairosdb_escape_string */
100 static int values_to_kairosdb (char *buffer, size_t buffer_size, /* {{{ */
101 const data_set_t *ds, const value_list_t *vl, int store_rates,
105 gauge_t *rates = NULL;
107 memset (buffer, 0, buffer_size);
109 #define BUFFER_ADD(...) do { \
111 status = ssnprintf (buffer + offset, buffer_size - offset, \
118 else if (((size_t) status) >= (buffer_size - offset)) \
124 offset += ((size_t) status); \
127 if (ds->ds[ds_idx].type == DS_TYPE_GAUGE)
129 if (isfinite (vl->values[ds_idx].gauge))
132 BUFFER_ADD ("%"PRIu64, CDTIME_T_TO_MS (vl->time));
134 BUFFER_ADD (JSON_GAUGE_FORMAT, vl->values[ds_idx].gauge);
138 DEBUG ("utils_format_kairosdb: invalid vl->values[ds_idx].gauge for %s|%s|%s|%s|%s",
143 ds->ds[ds_idx].name);
147 else if (store_rates)
150 rates = uc_get_rate (ds, vl);
153 WARNING ("utils_format_kairosdb: uc_get_rate failed for %s|%s|%s|%s|%s",
158 ds->ds[ds_idx].name);
163 if (isfinite (rates[ds_idx]))
166 BUFFER_ADD ("%"PRIu64, CDTIME_T_TO_MS (vl->time));
168 BUFFER_ADD (JSON_GAUGE_FORMAT, rates[ds_idx]);
172 WARNING ("utils_format_kairosdb: invalid rates[ds_idx] for %s|%s|%s|%s|%s",
177 ds->ds[ds_idx].name);
182 else if (ds->ds[ds_idx].type == DS_TYPE_COUNTER)
185 BUFFER_ADD ("%"PRIu64, CDTIME_T_TO_MS (vl->time));
187 BUFFER_ADD ("%llu", vl->values[ds_idx].counter);
189 else if (ds->ds[ds_idx].type == DS_TYPE_DERIVE)
192 BUFFER_ADD ("%"PRIu64, CDTIME_T_TO_MS (vl->time));
194 BUFFER_ADD ("%"PRIi64, vl->values[ds_idx].derive);
196 else if (ds->ds[ds_idx].type == DS_TYPE_ABSOLUTE)
199 BUFFER_ADD ("%"PRIu64, CDTIME_T_TO_MS (vl->time));
201 BUFFER_ADD ("%"PRIu64, vl->values[ds_idx].absolute);
205 ERROR ("format_kairosdb: Unknown data source type: %i",
206 ds->ds[ds_idx].type);
214 DEBUG ("format_kairosdb: values_to_kairosdb: buffer = %s;", buffer);
217 } /* }}} int values_to_kairosdb */
219 static int value_list_to_kairosdb (char *buffer, size_t buffer_size, /* {{{ */
220 const data_set_t *ds, const value_list_t *vl, int store_rates)
226 memset (buffer, 0, buffer_size);
228 #define BUFFER_ADD(...) do { \
229 status = ssnprintf (buffer + offset, buffer_size - offset, \
233 else if (((size_t) status) >= (buffer_size - offset)) \
236 offset += ((size_t) status); \
239 #define BUFFER_ADD_KEYVAL(key, value) do { \
240 status = kairosdb_escape_string (temp, sizeof (temp), (value)); \
243 BUFFER_ADD (",\"%s\": %s", (key), temp); \
246 for (size_t i = 0; i < ds->ds_num; i++)
248 /* All value lists have a leading comma. The first one will be replaced with
249 * a square bracket in `format_kairosdb_finalize'. */
252 BUFFER_ADD ("\"name\":\"collectd");
254 BUFFER_ADD (".%s", vl->plugin);
256 status = values_to_kairosdb (temp, sizeof (temp), ds, vl, store_rates, i);
260 BUFFER_ADD ("\", \"datapoints\": %s", temp);
263 * Now adds meta data to metric as tags
266 memset (temp, 0, sizeof(temp));
268 BUFFER_ADD (", \"tags\":\{");
270 BUFFER_ADD ("\"host\": \"%s\"", vl->host);
271 if (strlen(vl->plugin_instance))
272 BUFFER_ADD_KEYVAL ("plugin_instance", vl->plugin_instance);
273 BUFFER_ADD_KEYVAL ("type", vl->type);
274 if (strlen(vl->type_instance))
275 BUFFER_ADD_KEYVAL ("type_instance", vl->type_instance);
277 BUFFER_ADD_KEYVAL ("ds", ds->ds[i].name);
279 } /* for ds->ds_num */
281 #undef BUFFER_ADD_KEYVAL
284 DEBUG ("format_kairosdb: value_list_to_kairosdb: buffer = %s;", buffer);
287 } /* }}} int value_list_to_kairosdb */
289 static int format_kairosdb_value_list_nocheck (char *buffer, /* {{{ */
290 size_t *ret_buffer_fill, size_t *ret_buffer_free,
291 const data_set_t *ds, const value_list_t *vl,
292 int store_rates, size_t temp_size)
294 char temp[temp_size];
297 status = value_list_to_kairosdb (temp, sizeof (temp), ds, vl, store_rates);
300 temp_size = strlen (temp);
302 memcpy (buffer + (*ret_buffer_fill), temp, temp_size + 1);
303 (*ret_buffer_fill) += temp_size;
304 (*ret_buffer_free) -= temp_size;
307 } /* }}} int format_kairosdb_value_list_nocheck */
309 int format_kairosdb_initialize (char *buffer, /* {{{ */
310 size_t *ret_buffer_fill, size_t *ret_buffer_free)
315 if ((buffer == NULL) || (ret_buffer_fill == NULL) || (ret_buffer_free == NULL))
318 buffer_fill = *ret_buffer_fill;
319 buffer_free = *ret_buffer_free;
321 buffer_free = buffer_fill + buffer_free;
327 memset (buffer, 0, buffer_free);
328 *ret_buffer_fill = buffer_fill;
329 *ret_buffer_free = buffer_free;
332 } /* }}} int format_kairosdb_initialize */
334 int format_kairosdb_finalize (char *buffer, /* {{{ */
335 size_t *ret_buffer_fill, size_t *ret_buffer_free)
339 if ((buffer == NULL) || (ret_buffer_fill == NULL) || (ret_buffer_free == NULL))
342 if (*ret_buffer_free < 2)
345 /* Replace the leading comma added in `value_list_to_kairosdb' with a square
347 if (buffer[0] != ',')
351 pos = *ret_buffer_fill;
355 (*ret_buffer_fill)++;
356 (*ret_buffer_free)--;
359 } /* }}} int format_kairosdb_finalize */
361 int format_kairosdb_value_list (char *buffer, /* {{{ */
362 size_t *ret_buffer_fill, size_t *ret_buffer_free,
363 const data_set_t *ds, const value_list_t *vl, int store_rates)
366 || (ret_buffer_fill == NULL) || (ret_buffer_free == NULL)
367 || (ds == NULL) || (vl == NULL))
370 if (*ret_buffer_free < 3)
373 return (format_kairosdb_value_list_nocheck (buffer,
374 ret_buffer_fill, ret_buffer_free, ds, vl,
375 store_rates, (*ret_buffer_free) - 2));
376 } /* }}} int format_kairosdb_value_list */
378 /* vim: set sw=2 sts=2 et fdm=marker : */