2 * collectd - src/utils_format_json.c
3 * Copyright (C) 2009 Florian octo Forster
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 * Florian octo Forster <octo at collectd.org>
32 #include "utils_cache.h"
33 #include "utils_format_json.h"
35 static int json_escape_string (char *buffer, size_t buffer_size, /* {{{ */
41 if ((buffer == NULL) || (string == NULL))
49 #define BUFFER_ADD(c) do { \
50 if (dst_pos >= (buffer_size - 1)) { \
51 buffer[buffer_size - 1] = 0; \
54 buffer[dst_pos] = (c); \
58 /* Escape special characters */
60 for (src_pos = 0; string[src_pos] != 0; src_pos++)
62 if ((string[src_pos] == '"')
63 || (string[src_pos] == '\\'))
66 BUFFER_ADD (string[src_pos]);
68 else if (string[src_pos] <= 0x001F)
71 BUFFER_ADD (string[src_pos]);
79 } /* }}} int json_escape_string */
81 static int values_to_json (char *buffer, size_t buffer_size, /* {{{ */
82 const data_set_t *ds, const value_list_t *vl, int store_rates)
86 gauge_t *rates = NULL;
88 memset (buffer, 0, buffer_size);
90 #define BUFFER_ADD(...) do { \
92 status = ssnprintf (buffer + offset, buffer_size - offset, \
99 else if (((size_t) status) >= (buffer_size - offset)) \
105 offset += ((size_t) status); \
109 for (i = 0; i < ds->ds_num; i++)
114 if (ds->ds[i].type == DS_TYPE_GAUGE)
116 if(isfinite (vl->values[i].gauge))
117 BUFFER_ADD (JSON_GAUGE_FORMAT, vl->values[i].gauge);
121 else if (store_rates)
124 rates = uc_get_rate (ds, vl);
127 WARNING ("utils_format_json: uc_get_rate failed.");
132 if(isfinite (rates[i]))
133 BUFFER_ADD (JSON_GAUGE_FORMAT, rates[i]);
137 else if (ds->ds[i].type == DS_TYPE_COUNTER)
138 BUFFER_ADD ("%llu", vl->values[i].counter);
139 else if (ds->ds[i].type == DS_TYPE_DERIVE)
140 BUFFER_ADD ("%"PRIi64, vl->values[i].derive);
141 else if (ds->ds[i].type == DS_TYPE_ABSOLUTE)
142 BUFFER_ADD ("%"PRIu64, vl->values[i].absolute);
145 ERROR ("format_json: Unknown data source type: %i",
150 } /* for ds->ds_num */
155 DEBUG ("format_json: values_to_json: buffer = %s;", buffer);
158 } /* }}} int values_to_json */
160 static int dstypes_to_json (char *buffer, size_t buffer_size, /* {{{ */
161 const data_set_t *ds)
166 memset (buffer, 0, buffer_size);
168 #define BUFFER_ADD(...) do { \
170 status = ssnprintf (buffer + offset, buffer_size - offset, \
174 else if (((size_t) status) >= (buffer_size - offset)) \
177 offset += ((size_t) status); \
181 for (i = 0; i < ds->ds_num; i++)
186 BUFFER_ADD ("\"%s\"", DS_TYPE_TO_STRING (ds->ds[i].type));
187 } /* for ds->ds_num */
192 DEBUG ("format_json: dstypes_to_json: buffer = %s;", buffer);
195 } /* }}} int dstypes_to_json */
197 static int dsnames_to_json (char *buffer, size_t buffer_size, /* {{{ */
198 const data_set_t *ds)
203 memset (buffer, 0, buffer_size);
205 #define BUFFER_ADD(...) do { \
207 status = ssnprintf (buffer + offset, buffer_size - offset, \
211 else if (((size_t) status) >= (buffer_size - offset)) \
214 offset += ((size_t) status); \
218 for (i = 0; i < ds->ds_num; i++)
223 BUFFER_ADD ("\"%s\"", ds->ds[i].name);
224 } /* for ds->ds_num */
229 DEBUG ("format_json: dsnames_to_json: buffer = %s;", buffer);
232 } /* }}} int dsnames_to_json */
234 static int meta_data_keys_to_json (char *buffer, size_t buffer_size, /* {{{ */
235 meta_data_t *meta, char **keys, size_t keys_num)
243 #define BUFFER_ADD(...) do { \
244 status = ssnprintf (buffer + offset, buffer_size - offset, \
248 else if (((size_t) status) >= (buffer_size - offset)) \
251 offset += ((size_t) status); \
254 for (i = 0; i < keys_num; ++i)
259 type = meta_data_type (meta, key);
260 if (type == MD_TYPE_STRING)
263 if (meta_data_get_string (meta, key, &value) == 0)
267 status = json_escape_string (temp, sizeof (temp), value);
272 BUFFER_ADD (",\"%s\":%s", key, temp);
275 else if (type == MD_TYPE_SIGNED_INT)
278 if (meta_data_get_signed_int (meta, key, &value) == 0)
279 BUFFER_ADD (",\"%s\":%"PRIi64, key, value);
281 else if (type == MD_TYPE_UNSIGNED_INT)
284 if (meta_data_get_unsigned_int (meta, key, &value) == 0)
285 BUFFER_ADD (",\"%s\":%"PRIu64, key, value);
287 else if (type == MD_TYPE_DOUBLE)
290 if (meta_data_get_double (meta, key, &value) == 0)
291 BUFFER_ADD (",\"%s\":%f", key, value);
293 else if (type == MD_TYPE_BOOLEAN)
296 if (meta_data_get_boolean (meta, key, &value) == 0)
297 BUFFER_ADD (",\"%s\":%s", key, value ? "true" : "false");
304 buffer[0] = '{'; /* replace leading ',' */
310 } /* }}} int meta_data_keys_to_json */
312 static int meta_data_to_json (char *buffer, size_t buffer_size, /* {{{ */
320 if ((buffer == NULL) || (buffer_size == 0) || (meta == NULL))
323 status = meta_data_toc (meta, &keys);
326 keys_num = (size_t) status;
328 status = meta_data_keys_to_json (buffer, buffer_size, meta, keys, keys_num);
330 for (i = 0; i < keys_num; ++i)
335 } /* }}} int meta_data_to_json */
337 static int value_list_to_json (char *buffer, size_t buffer_size, /* {{{ */
338 const data_set_t *ds, const value_list_t *vl, int store_rates)
344 memset (buffer, 0, buffer_size);
346 #define BUFFER_ADD(...) do { \
347 status = ssnprintf (buffer + offset, buffer_size - offset, \
351 else if (((size_t) status) >= (buffer_size - offset)) \
354 offset += ((size_t) status); \
357 /* All value lists have a leading comma. The first one will be replaced with
358 * a square bracket in `format_json_finalize'. */
361 status = values_to_json (temp, sizeof (temp), ds, vl, store_rates);
364 BUFFER_ADD ("\"values\":%s", temp);
366 status = dstypes_to_json (temp, sizeof (temp), ds);
369 BUFFER_ADD (",\"dstypes\":%s", temp);
371 status = dsnames_to_json (temp, sizeof (temp), ds);
374 BUFFER_ADD (",\"dsnames\":%s", temp);
376 BUFFER_ADD (",\"time\":%.3f", CDTIME_T_TO_DOUBLE (vl->time));
377 BUFFER_ADD (",\"interval\":%.3f", CDTIME_T_TO_DOUBLE (vl->interval));
379 #define BUFFER_ADD_KEYVAL(key, value) do { \
380 status = json_escape_string (temp, sizeof (temp), (value)); \
383 BUFFER_ADD (",\"%s\":%s", (key), temp); \
386 BUFFER_ADD_KEYVAL ("host", vl->host);
387 BUFFER_ADD_KEYVAL ("plugin", vl->plugin);
388 BUFFER_ADD_KEYVAL ("plugin_instance", vl->plugin_instance);
389 BUFFER_ADD_KEYVAL ("type", vl->type);
390 BUFFER_ADD_KEYVAL ("type_instance", vl->type_instance);
392 if (vl->meta != NULL)
394 char meta_buffer[buffer_size];
395 memset (meta_buffer, 0, sizeof (meta_buffer));
396 status = meta_data_to_json (meta_buffer, sizeof (meta_buffer), vl->meta);
400 BUFFER_ADD (",\"meta\":%s", meta_buffer);
401 } /* if (vl->meta != NULL) */
405 #undef BUFFER_ADD_KEYVAL
408 DEBUG ("format_json: value_list_to_json: buffer = %s;", buffer);
411 } /* }}} int value_list_to_json */
413 static int format_json_value_list_nocheck (char *buffer, /* {{{ */
414 size_t *ret_buffer_fill, size_t *ret_buffer_free,
415 const data_set_t *ds, const value_list_t *vl,
416 int store_rates, size_t temp_size)
418 char temp[temp_size];
421 status = value_list_to_json (temp, sizeof (temp), ds, vl, store_rates);
424 temp_size = strlen (temp);
426 memcpy (buffer + (*ret_buffer_fill), temp, temp_size + 1);
427 (*ret_buffer_fill) += temp_size;
428 (*ret_buffer_free) -= temp_size;
431 } /* }}} int format_json_value_list_nocheck */
433 int format_json_initialize (char *buffer, /* {{{ */
434 size_t *ret_buffer_fill, size_t *ret_buffer_free)
439 if ((buffer == NULL) || (ret_buffer_fill == NULL) || (ret_buffer_free == NULL))
442 buffer_fill = *ret_buffer_fill;
443 buffer_free = *ret_buffer_free;
445 buffer_free = buffer_fill + buffer_free;
451 memset (buffer, 0, buffer_free);
452 *ret_buffer_fill = buffer_fill;
453 *ret_buffer_free = buffer_free;
456 } /* }}} int format_json_initialize */
458 int format_json_finalize (char *buffer, /* {{{ */
459 size_t *ret_buffer_fill, size_t *ret_buffer_free)
463 if ((buffer == NULL) || (ret_buffer_fill == NULL) || (ret_buffer_free == NULL))
466 if (*ret_buffer_free < 2)
469 /* Replace the leading comma added in `value_list_to_json' with a square
471 if (buffer[0] != ',')
475 pos = *ret_buffer_fill;
479 (*ret_buffer_fill)++;
480 (*ret_buffer_free)--;
483 } /* }}} int format_json_finalize */
485 int format_json_value_list (char *buffer, /* {{{ */
486 size_t *ret_buffer_fill, size_t *ret_buffer_free,
487 const data_set_t *ds, const value_list_t *vl, int store_rates)
490 || (ret_buffer_fill == NULL) || (ret_buffer_free == NULL)
491 || (ds == NULL) || (vl == NULL))
494 if (*ret_buffer_free < 3)
497 return (format_json_value_list_nocheck (buffer,
498 ret_buffer_fill, ret_buffer_free, ds, vl,
499 store_rates, (*ret_buffer_free) - 2));
500 } /* }}} int format_json_value_list */
502 /* vim: set sw=2 sts=2 et fdm=marker : */