2 * collectd - src/utils_format_json.c
3 * Copyright (C) 2009 Florian octo Forster
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; only version 2 of the License is applicable.
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 * Florian octo Forster <octo at verplant.org>
26 #include "utils_cache.h"
27 #include "utils_format_json.h"
29 static int escape_string (char *buffer, size_t buffer_size, /* {{{ */
35 if ((buffer == NULL) || (string == NULL))
43 #define BUFFER_ADD(c) do { \
44 if (dst_pos >= (buffer_size - 1)) { \
45 buffer[buffer_size - 1] = 0; \
48 buffer[dst_pos] = (c); \
52 /* Escape special characters */
54 for (src_pos = 0; string[src_pos] != 0; src_pos++)
56 if ((string[src_pos] == '"')
57 || (string[src_pos] == '\\'))
60 BUFFER_ADD (string[src_pos]);
62 else if (string[src_pos] <= 0x001F)
65 BUFFER_ADD (string[src_pos]);
73 } /* }}} int escape_string */
75 static int values_to_json (char *buffer, size_t buffer_size, /* {{{ */
76 const data_set_t *ds, const value_list_t *vl, int store_rates)
80 gauge_t *rates = NULL;
82 memset (buffer, 0, buffer_size);
84 #define BUFFER_ADD(...) do { \
86 status = ssnprintf (buffer + offset, buffer_size - offset, \
93 else if (((size_t) status) >= (buffer_size - offset)) \
99 offset += ((size_t) status); \
103 for (i = 0; i < ds->ds_num; i++)
108 if (ds->ds[i].type == DS_TYPE_GAUGE)
110 if(isfinite (vl->values[i].gauge))
111 BUFFER_ADD ("%g", vl->values[i].gauge);
115 else if (store_rates)
118 rates = uc_get_rate (ds, vl);
121 WARNING ("utils_format_json: uc_get_rate failed.");
126 if(isfinite (rates[i]))
127 BUFFER_ADD ("%g", rates[i]);
131 else if (ds->ds[i].type == DS_TYPE_COUNTER)
132 BUFFER_ADD ("%llu", vl->values[i].counter);
133 else if (ds->ds[i].type == DS_TYPE_DERIVE)
134 BUFFER_ADD ("%"PRIi64, vl->values[i].derive);
135 else if (ds->ds[i].type == DS_TYPE_ABSOLUTE)
136 BUFFER_ADD ("%"PRIu64, vl->values[i].absolute);
139 ERROR ("format_json: Unknown data source type: %i",
144 } /* for ds->ds_num */
149 DEBUG ("format_json: values_to_json: buffer = %s;", buffer);
152 } /* }}} int values_to_json */
154 static int dstypes_to_json (char *buffer, size_t buffer_size, /* {{{ */
155 const data_set_t *ds)
160 memset (buffer, 0, buffer_size);
162 #define BUFFER_ADD(...) do { \
164 status = ssnprintf (buffer + offset, buffer_size - offset, \
168 else if (((size_t) status) >= (buffer_size - offset)) \
171 offset += ((size_t) status); \
175 for (i = 0; i < ds->ds_num; i++)
180 BUFFER_ADD ("\"%s\"", DS_TYPE_TO_STRING (ds->ds[i].type));
181 } /* for ds->ds_num */
186 DEBUG ("format_json: dstypes_to_json: buffer = %s;", buffer);
189 } /* }}} int dstypes_to_json */
191 static int dsnames_to_json (char *buffer, size_t buffer_size, /* {{{ */
192 const data_set_t *ds)
197 memset (buffer, 0, buffer_size);
199 #define BUFFER_ADD(...) do { \
201 status = ssnprintf (buffer + offset, buffer_size - offset, \
205 else if (((size_t) status) >= (buffer_size - offset)) \
208 offset += ((size_t) status); \
212 for (i = 0; i < ds->ds_num; i++)
217 BUFFER_ADD ("\"%s\"", ds->ds[i].name);
218 } /* for ds->ds_num */
223 DEBUG ("format_json: dsnames_to_json: buffer = %s;", buffer);
226 } /* }}} int dsnames_to_json */
228 static int meta_data_to_json (char *buffer, size_t buffer_size, /* {{{ */
242 #define BUFFER_ADD(...) do { \
243 status = ssnprintf (buffer + offset, buffer_size - offset, \
247 else if (((size_t) status) >= (buffer_size - offset)) \
250 offset += ((size_t) status); \
253 keys_num = meta_data_toc (meta, &keys);
260 for (i = 0; i < keys_num; ++i)
265 type = meta_data_type (meta, key);
266 if (type == MD_TYPE_STRING)
269 if (meta_data_get_string (meta, key, &value) == 0)
272 escape_string (temp, sizeof (temp), value);
274 BUFFER_ADD (",\"%s\":%s", key, temp);
277 else if (type == MD_TYPE_SIGNED_INT)
280 if (meta_data_get_signed_int (meta, key, &value) == 0)
281 BUFFER_ADD (",\"%s\":%"PRIi64, key, value);
283 else if (type == MD_TYPE_UNSIGNED_INT)
286 if (meta_data_get_unsigned_int (meta, key, &value) == 0)
287 BUFFER_ADD (",\"%s\":%"PRIu64, key, value);
289 else if (type == MD_TYPE_DOUBLE)
292 if (meta_data_get_double (meta, key, &value) == 0)
293 BUFFER_ADD (",\"%s\":%f", key, value);
295 else if (type == MD_TYPE_BOOLEAN)
298 if (meta_data_get_boolean (meta, key, &value) == 0)
299 BUFFER_ADD (",\"%s\":%s", key, value ? "true" : "false");
309 buffer[0] = '{'; /* replace leading ',' */
315 } /* }}} int meta_data_to_json */
317 static int value_list_to_json (char *buffer, size_t buffer_size, /* {{{ */
318 const data_set_t *ds, const value_list_t *vl, int store_rates)
324 memset (buffer, 0, buffer_size);
326 #define BUFFER_ADD(...) do { \
327 status = ssnprintf (buffer + offset, buffer_size - offset, \
331 else if (((size_t) status) >= (buffer_size - offset)) \
334 offset += ((size_t) status); \
337 /* All value lists have a leading comma. The first one will be replaced with
338 * a square bracket in `format_json_finalize'. */
341 status = values_to_json (temp, sizeof (temp), ds, vl, store_rates);
344 BUFFER_ADD ("\"values\":%s", temp);
346 status = dstypes_to_json (temp, sizeof (temp), ds);
349 BUFFER_ADD (",\"dstypes\":%s", temp);
351 status = dsnames_to_json (temp, sizeof (temp), ds);
354 BUFFER_ADD (",\"dsnames\":%s", temp);
356 BUFFER_ADD (",\"time\":%.3f", CDTIME_T_TO_DOUBLE (vl->time));
357 BUFFER_ADD (",\"interval\":%.3f", CDTIME_T_TO_DOUBLE (vl->interval));
359 #define BUFFER_ADD_KEYVAL(key, value) do { \
360 status = escape_string (temp, sizeof (temp), (value)); \
363 BUFFER_ADD (",\"%s\":%s", (key), temp); \
366 BUFFER_ADD_KEYVAL ("host", vl->host);
367 BUFFER_ADD_KEYVAL ("plugin", vl->plugin);
368 BUFFER_ADD_KEYVAL ("plugin_instance", vl->plugin_instance);
369 BUFFER_ADD_KEYVAL ("type", vl->type);
370 BUFFER_ADD_KEYVAL ("type_instance", vl->type_instance);
372 if (vl->meta != NULL)
374 char meta_buffer[buffer_size];
375 memset (meta_buffer, 0, sizeof (meta_buffer));
376 status = meta_data_to_json (meta_buffer, sizeof (meta_buffer), vl->meta);
380 BUFFER_ADD (",\"meta\":%s", meta_buffer);
381 } /* if (vl->meta != NULL) */
385 #undef BUFFER_ADD_KEYVAL
388 DEBUG ("format_json: value_list_to_json: buffer = %s;", buffer);
391 } /* }}} int value_list_to_json */
393 static int format_json_value_list_nocheck (char *buffer, /* {{{ */
394 size_t *ret_buffer_fill, size_t *ret_buffer_free,
395 const data_set_t *ds, const value_list_t *vl,
396 int store_rates, size_t temp_size)
398 char temp[temp_size];
401 status = value_list_to_json (temp, sizeof (temp), ds, vl, store_rates);
404 temp_size = strlen (temp);
406 memcpy (buffer + (*ret_buffer_fill), temp, temp_size + 1);
407 (*ret_buffer_fill) += temp_size;
408 (*ret_buffer_free) -= temp_size;
411 } /* }}} int format_json_value_list_nocheck */
413 int format_json_initialize (char *buffer, /* {{{ */
414 size_t *ret_buffer_fill, size_t *ret_buffer_free)
419 if ((buffer == NULL) || (ret_buffer_fill == NULL) || (ret_buffer_free == NULL))
422 buffer_fill = *ret_buffer_fill;
423 buffer_free = *ret_buffer_free;
425 buffer_free = buffer_fill + buffer_free;
431 memset (buffer, 0, buffer_free);
432 *ret_buffer_fill = buffer_fill;
433 *ret_buffer_free = buffer_free;
436 } /* }}} int format_json_initialize */
438 int format_json_finalize (char *buffer, /* {{{ */
439 size_t *ret_buffer_fill, size_t *ret_buffer_free)
443 if ((buffer == NULL) || (ret_buffer_fill == NULL) || (ret_buffer_free == NULL))
446 if (*ret_buffer_free < 2)
449 /* Replace the leading comma added in `value_list_to_json' with a square
451 if (buffer[0] != ',')
455 pos = *ret_buffer_fill;
459 (*ret_buffer_fill)++;
460 (*ret_buffer_free)--;
463 } /* }}} int format_json_finalize */
465 int format_json_value_list (char *buffer, /* {{{ */
466 size_t *ret_buffer_fill, size_t *ret_buffer_free,
467 const data_set_t *ds, const value_list_t *vl, int store_rates)
470 || (ret_buffer_fill == NULL) || (ret_buffer_free == NULL)
471 || (ds == NULL) || (vl == NULL))
474 if (*ret_buffer_free < 3)
477 return (format_json_value_list_nocheck (buffer,
478 ret_buffer_fill, ret_buffer_free, ds, vl,
479 store_rates, (*ret_buffer_free) - 2));
480 } /* }}} int format_json_value_list */
482 /* vim: set sw=2 sts=2 et fdm=marker : */