2 * collectd - src/utils_format_json.c
3 * Copyright (C) 2009-2015 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>
29 #include "utils_format_json.h"
33 #include "utils_cache.h"
36 #include <yajl/yajl_common.h>
37 #include <yajl/yajl_gen.h>
38 #if HAVE_YAJL_YAJL_VERSION_H
39 #include <yajl/yajl_version.h>
41 #if defined(YAJL_MAJOR) && (YAJL_MAJOR > 1)
42 #define HAVE_YAJL_V2 1
46 static int json_escape_string(char *buffer, size_t buffer_size, /* {{{ */
50 if ((buffer == NULL) || (string == NULL))
58 #define BUFFER_ADD(c) \
60 if (dst_pos >= (buffer_size - 1)) { \
61 buffer[buffer_size - 1] = 0; \
64 buffer[dst_pos] = (c); \
68 /* Escape special characters */
70 for (size_t src_pos = 0; string[src_pos] != 0; src_pos++) {
71 if ((string[src_pos] == '"') || (string[src_pos] == '\\')) {
73 BUFFER_ADD(string[src_pos]);
74 } else if (string[src_pos] <= 0x001F)
77 BUFFER_ADD(string[src_pos]);
85 } /* }}} int json_escape_string */
87 static int values_to_json(char *buffer, size_t buffer_size, /* {{{ */
88 const data_set_t *ds, const value_list_t *vl,
91 gauge_t *rates = NULL;
93 memset(buffer, 0, buffer_size);
95 #define BUFFER_ADD(...) \
98 status = snprintf(buffer + offset, buffer_size - offset, __VA_ARGS__); \
102 } else if (((size_t)status) >= (buffer_size - offset)) { \
106 offset += ((size_t)status); \
110 for (size_t i = 0; i < ds->ds_num; i++) {
114 if (ds->ds[i].type == DS_TYPE_GAUGE) {
115 if (isfinite(vl->values[i].gauge))
116 BUFFER_ADD(JSON_GAUGE_FORMAT, vl->values[i].gauge);
119 } else if (store_rates) {
121 rates = uc_get_rate(ds, vl);
123 WARNING("utils_format_json: uc_get_rate failed.");
128 if (isfinite(rates[i]))
129 BUFFER_ADD(JSON_GAUGE_FORMAT, rates[i]);
132 } else if (ds->ds[i].type == DS_TYPE_COUNTER)
133 BUFFER_ADD("%" PRIu64, (uint64_t)vl->values[i].counter);
134 else if (ds->ds[i].type == DS_TYPE_DERIVE)
135 BUFFER_ADD("%" PRIi64, vl->values[i].derive);
136 else if (ds->ds[i].type == DS_TYPE_ABSOLUTE)
137 BUFFER_ADD("%" PRIu64, vl->values[i].absolute);
139 ERROR("format_json: Unknown data source type: %i", ds->ds[i].type);
143 } /* for ds->ds_num */
150 } /* }}} int values_to_json */
152 static int dstypes_to_json(char *buffer, size_t buffer_size, /* {{{ */
153 const data_set_t *ds) {
156 memset(buffer, 0, buffer_size);
158 #define BUFFER_ADD(...) \
161 status = snprintf(buffer + offset, buffer_size - offset, __VA_ARGS__); \
164 else if (((size_t)status) >= (buffer_size - offset)) \
167 offset += ((size_t)status); \
171 for (size_t i = 0; i < ds->ds_num; i++) {
175 BUFFER_ADD("\"%s\"", DS_TYPE_TO_STRING(ds->ds[i].type));
176 } /* for ds->ds_num */
182 } /* }}} int dstypes_to_json */
184 static int dsnames_to_json(char *buffer, size_t buffer_size, /* {{{ */
185 const data_set_t *ds) {
188 memset(buffer, 0, buffer_size);
190 #define BUFFER_ADD(...) \
193 status = snprintf(buffer + offset, buffer_size - offset, __VA_ARGS__); \
196 else if (((size_t)status) >= (buffer_size - offset)) \
199 offset += ((size_t)status); \
203 for (size_t i = 0; i < ds->ds_num; i++) {
207 BUFFER_ADD("\"%s\"", ds->ds[i].name);
208 } /* for ds->ds_num */
214 } /* }}} int dsnames_to_json */
216 static int meta_data_keys_to_json(char *buffer, size_t buffer_size, /* {{{ */
217 meta_data_t *meta, char **keys,
224 #define BUFFER_ADD(...) \
226 status = snprintf(buffer + offset, buffer_size - offset, __VA_ARGS__); \
229 else if (((size_t)status) >= (buffer_size - offset)) \
232 offset += ((size_t)status); \
235 for (size_t i = 0; i < keys_num; ++i) {
239 type = meta_data_type(meta, key);
240 if (type == MD_TYPE_STRING) {
242 if (meta_data_get_string(meta, key, &value) == 0) {
245 status = json_escape_string(temp, sizeof(temp), value);
250 BUFFER_ADD(",\"%s\":%s", key, temp);
252 } else if (type == MD_TYPE_SIGNED_INT) {
254 if (meta_data_get_signed_int(meta, key, &value) == 0)
255 BUFFER_ADD(",\"%s\":%" PRIi64, key, value);
256 } else if (type == MD_TYPE_UNSIGNED_INT) {
258 if (meta_data_get_unsigned_int(meta, key, &value) == 0)
259 BUFFER_ADD(",\"%s\":%" PRIu64, key, value);
260 } else if (type == MD_TYPE_DOUBLE) {
262 if (meta_data_get_double(meta, key, &value) == 0)
263 BUFFER_ADD(",\"%s\":%f", key, value);
264 } else if (type == MD_TYPE_BOOLEAN) {
266 if (meta_data_get_boolean(meta, key, &value) == 0)
267 BUFFER_ADD(",\"%s\":%s", key, value ? "true" : "false");
274 buffer[0] = '{'; /* replace leading ',' */
280 } /* }}} int meta_data_keys_to_json */
282 static int meta_data_to_json(char *buffer, size_t buffer_size, /* {{{ */
288 if ((buffer == NULL) || (buffer_size == 0) || (meta == NULL))
291 status = meta_data_toc(meta, &keys);
294 keys_num = (size_t)status;
296 status = meta_data_keys_to_json(buffer, buffer_size, meta, keys, keys_num);
298 for (size_t i = 0; i < keys_num; ++i)
303 } /* }}} int meta_data_to_json */
305 static int value_list_to_json(char *buffer, size_t buffer_size, /* {{{ */
306 const data_set_t *ds, const value_list_t *vl,
312 memset(buffer, 0, buffer_size);
314 #define BUFFER_ADD(...) \
316 status = snprintf(buffer + offset, buffer_size - offset, __VA_ARGS__); \
319 else if (((size_t)status) >= (buffer_size - offset)) \
322 offset += ((size_t)status); \
325 /* All value lists have a leading comma. The first one will be replaced with
326 * a square bracket in `format_json_finalize'. */
329 status = values_to_json(temp, sizeof(temp), ds, vl, store_rates);
332 BUFFER_ADD("\"values\":%s", temp);
334 status = dstypes_to_json(temp, sizeof(temp), ds);
337 BUFFER_ADD(",\"dstypes\":%s", temp);
339 status = dsnames_to_json(temp, sizeof(temp), ds);
342 BUFFER_ADD(",\"dsnames\":%s", temp);
344 BUFFER_ADD(",\"time\":%.3f", CDTIME_T_TO_DOUBLE(vl->time));
345 BUFFER_ADD(",\"interval\":%.3f", CDTIME_T_TO_DOUBLE(vl->interval));
347 #define BUFFER_ADD_KEYVAL(key, value) \
349 status = json_escape_string(temp, sizeof(temp), (value)); \
352 BUFFER_ADD(",\"%s\":%s", (key), temp); \
355 BUFFER_ADD_KEYVAL("host", vl->host);
356 BUFFER_ADD_KEYVAL("plugin", vl->plugin);
357 BUFFER_ADD_KEYVAL("plugin_instance", vl->plugin_instance);
358 BUFFER_ADD_KEYVAL("type", vl->type);
359 BUFFER_ADD_KEYVAL("type_instance", vl->type_instance);
361 if (vl->meta != NULL) {
362 char meta_buffer[buffer_size];
363 memset(meta_buffer, 0, sizeof(meta_buffer));
364 status = meta_data_to_json(meta_buffer, sizeof(meta_buffer), vl->meta);
368 BUFFER_ADD(",\"meta\":%s", meta_buffer);
369 } /* if (vl->meta != NULL) */
373 #undef BUFFER_ADD_KEYVAL
377 } /* }}} int value_list_to_json */
379 static int format_json_value_list_nocheck(char *buffer, /* {{{ */
380 size_t *ret_buffer_fill,
381 size_t *ret_buffer_free,
382 const data_set_t *ds,
383 const value_list_t *vl,
384 int store_rates, size_t temp_size) {
385 char temp[temp_size];
388 status = value_list_to_json(temp, sizeof(temp), ds, vl, store_rates);
391 temp_size = strlen(temp);
393 memcpy(buffer + (*ret_buffer_fill), temp, temp_size + 1);
394 (*ret_buffer_fill) += temp_size;
395 (*ret_buffer_free) -= temp_size;
398 } /* }}} int format_json_value_list_nocheck */
400 int format_json_initialize(char *buffer, /* {{{ */
401 size_t *ret_buffer_fill, size_t *ret_buffer_free) {
405 if ((buffer == NULL) || (ret_buffer_fill == NULL) ||
406 (ret_buffer_free == NULL))
409 buffer_fill = *ret_buffer_fill;
410 buffer_free = *ret_buffer_free;
412 buffer_free = buffer_fill + buffer_free;
418 memset(buffer, 0, buffer_free);
419 *ret_buffer_fill = buffer_fill;
420 *ret_buffer_free = buffer_free;
423 } /* }}} int format_json_initialize */
425 int format_json_finalize(char *buffer, /* {{{ */
426 size_t *ret_buffer_fill, size_t *ret_buffer_free) {
429 if ((buffer == NULL) || (ret_buffer_fill == NULL) ||
430 (ret_buffer_free == NULL))
433 if (*ret_buffer_free < 2)
436 /* Replace the leading comma added in `value_list_to_json' with a square
438 if (buffer[0] != ',')
442 pos = *ret_buffer_fill;
446 (*ret_buffer_fill)++;
447 (*ret_buffer_free)--;
450 } /* }}} int format_json_finalize */
452 int format_json_value_list(char *buffer, /* {{{ */
453 size_t *ret_buffer_fill, size_t *ret_buffer_free,
454 const data_set_t *ds, const value_list_t *vl,
456 if ((buffer == NULL) || (ret_buffer_fill == NULL) ||
457 (ret_buffer_free == NULL) || (ds == NULL) || (vl == NULL))
460 if (*ret_buffer_free < 3)
463 return format_json_value_list_nocheck(buffer, ret_buffer_fill,
464 ret_buffer_free, ds, vl, store_rates,
465 (*ret_buffer_free) - 2);
466 } /* }}} int format_json_value_list */
469 static int json_add_string(yajl_gen g, char const *str) /* {{{ */
472 return (int)yajl_gen_null(g);
474 return (int)yajl_gen_string(g, (const unsigned char *)str,
475 (unsigned int)strlen(str));
476 } /* }}} int json_add_string */
478 #define JSON_ADD(g, str) \
480 yajl_gen_status status = json_add_string(g, str); \
481 if (status != yajl_gen_status_ok) { \
486 #define JSON_ADDF(g, format, ...) \
488 char *str = ssnprintf_alloc(format, __VA_ARGS__); \
489 yajl_gen_status status = json_add_string(g, str); \
491 if (status != yajl_gen_status_ok) { \
496 #define CHECK_SUCCESS(cmd) \
498 yajl_gen_status s = (cmd); \
499 if (s != yajl_gen_status_ok) { \
504 static int format_json_meta(yajl_gen g, notification_meta_t *meta) /* {{{ */
509 JSON_ADD(g, meta->name);
510 switch (meta->type) {
512 JSON_ADD(g, meta->nm_value.nm_string);
514 case NM_TYPE_SIGNED_INT:
515 JSON_ADDF(g, "%" PRIi64, meta->nm_value.nm_signed_int);
517 case NM_TYPE_UNSIGNED_INT:
518 JSON_ADDF(g, "%" PRIu64, meta->nm_value.nm_unsigned_int);
521 JSON_ADDF(g, JSON_GAUGE_FORMAT, meta->nm_value.nm_double);
523 case NM_TYPE_BOOLEAN:
524 JSON_ADD(g, meta->nm_value.nm_boolean ? "true" : "false");
527 ERROR("format_json_meta: unknown meta data type %d (name \"%s\")",
528 meta->type, meta->name);
529 CHECK_SUCCESS(yajl_gen_null(g));
532 return format_json_meta(g, meta->next);
533 } /* }}} int format_json_meta */
535 static int format_time(yajl_gen g, cdtime_t t) /* {{{ */
537 char buffer[RFC3339NANO_SIZE] = "";
539 if (rfc3339nano(buffer, sizeof(buffer), t) != 0)
544 } /* }}} int format_time */
546 static int format_alert(yajl_gen g, notification_t const *n) /* {{{ */
548 CHECK_SUCCESS(yajl_gen_array_open(g)); /* BEGIN array */
549 CHECK_SUCCESS(yajl_gen_map_open(g)); /* BEGIN alert */
554 JSON_ADD(g, "labels");
555 CHECK_SUCCESS(yajl_gen_map_open(g)); /* BEGIN labels */
557 JSON_ADD(g, "alertname");
558 if (strncmp(n->plugin, n->type, strlen(n->plugin)) == 0)
559 JSON_ADDF(g, "collectd_%s", n->type);
561 JSON_ADDF(g, "collectd_%s_%s", n->plugin, n->type);
563 JSON_ADD(g, "instance");
564 JSON_ADD(g, n->host);
566 /* mangling of plugin instance and type instance into labels is copied from
567 * the Prometheus collectd exporter. */
568 if (strlen(n->plugin_instance) > 0) {
569 JSON_ADD(g, n->plugin);
570 JSON_ADD(g, n->plugin_instance);
572 if (strlen(n->type_instance) > 0) {
573 if (strlen(n->plugin_instance) > 0)
576 JSON_ADD(g, n->plugin);
577 JSON_ADD(g, n->type_instance);
580 JSON_ADD(g, "severity");
582 (n->severity == NOTIF_FAILURE)
584 : (n->severity == NOTIF_WARNING)
586 : (n->severity == NOTIF_OKAY) ? "OKAY" : "UNKNOWN");
588 JSON_ADD(g, "service");
589 JSON_ADD(g, "collectd");
591 CHECK_SUCCESS(yajl_gen_map_close(g)); /* END labels */
596 JSON_ADD(g, "annotations");
597 CHECK_SUCCESS(yajl_gen_map_open(g)); /* BEGIN annotations */
599 JSON_ADD(g, "summary");
600 JSON_ADD(g, n->message);
602 if (format_json_meta(g, n->meta) != 0) {
606 CHECK_SUCCESS(yajl_gen_map_close(g)); /* END annotations */
608 JSON_ADD(g, "startsAt");
609 if (format_time(g, n->time) != 0) {
613 CHECK_SUCCESS(yajl_gen_map_close(g)); /* END alert */
614 CHECK_SUCCESS(yajl_gen_array_close(g)); /* END array */
617 } /* }}} format_alert */
620 * Format (prometheus/alertmanager v1):
624 * "alertname": "collectd_cpu",
625 * "instance": "host.example.com",
626 * "severity": "FAILURE",
627 * "service": "collectd",
635 * "startsAt": <rfc3339 time>,
636 * "endsAt": <rfc3339 time>, // not used
639 int format_json_notification(char *buffer, size_t buffer_size, /* {{{ */
640 notification_t const *n) {
642 unsigned char const *out;
644 size_t unused_out_len;
646 unsigned int unused_out_len;
649 if ((buffer == NULL) || (n == NULL))
653 g = yajl_gen_alloc(NULL);
657 yajl_gen_config(g, yajl_gen_beautify, 1);
658 yajl_gen_config(g, yajl_gen_validate_utf8, 1);
661 #else /* !HAVE_YAJL_V2 */
662 yajl_gen_config conf = {0};
665 conf.indentString = " ";
667 g = yajl_gen_alloc(&conf, NULL);
672 if (format_alert(g, n) != 0) {
678 /* copy to output buffer */
679 if (yajl_gen_get_buf(g, &out, &unused_out_len) != yajl_gen_status_ok) {
684 sstrncpy(buffer, (void *)out, buffer_size);
689 } /* }}} format_json_notification */
691 int format_json_notification(char *buffer, size_t buffer_size, /* {{{ */
692 notification_t const *n) {
693 ERROR("format_json_notification: Not available (requires libyajl).");
695 } /* }}} int format_json_notification */