From 30c111183bf529381359a411edf5e5b1feb6ba9e Mon Sep 17 00:00:00 2001 From: Florian Forster Date: Fri, 20 Nov 2015 10:47:57 +0100 Subject: [PATCH] src/utils_format_json.[ch]: Implement format_json_notification(). --- src/Makefile.am | 32 ++++-- src/utils_format_json.c | 206 ++++++++++++++++++++++++++++++++++- src/utils_format_json.h | 2 + src/utils_format_json_test.c | 152 ++++++++++++++++++++++++++ 4 files changed, 379 insertions(+), 13 deletions(-) create mode 100644 src/utils_format_json_test.c diff --git a/src/Makefile.am b/src/Makefile.am index a4ca01e7..c78e4798 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -27,6 +27,21 @@ noinst_LTLIBRARIES = check_PROGRAMS = TESTS = +noinst_LTLIBRARIES += libformat_json.la +libformat_json_la_SOURCES = utils_format_json.c utils_format_json.h +libformat_json_la_CPPFLAGS = $(AM_CPPFLAGS) +libformat_json_la_LDFLAGS = $(AM_LDFLAGS) +libformat_json_la_LIBADD = +if BUILD_WITH_LIBYAJL +libformat_json_la_CPPFLAGS += $(BUILD_WITH_LIBYAJL_CPPFLAGS) +libformat_json_la_LDFLAGS += $(BUILD_WITH_LIBYAJL_LDFLAGS) +libformat_json_la_LIBADD += $(BUILD_WITH_LIBYAJL_LIBS) +check_PROGRAMS += test_format_json +TESTS += test_format_json +test_format_json_SOURCES = utils_format_json_test.c testing.h +test_format_json_LDADD = libformat_json.la daemon/libmetadata.la daemon/libplugin_mock.la -lm +endif + noinst_LTLIBRARIES += liblatency.la liblatency_la_SOURCES = utils_latency.c utils_latency.h check_PROGRAMS += test_utils_latency @@ -141,11 +156,10 @@ pkglib_LTLIBRARIES += amqp.la amqp_la_SOURCES = amqp.c \ utils_cmd_putval.c utils_cmd_putval.h \ utils_parse_option.c utils_parse_option.h \ - utils_format_graphite.c utils_format_graphite.h \ - utils_format_json.c utils_format_json.h + utils_format_graphite.c utils_format_graphite.h amqp_la_LDFLAGS = $(PLUGIN_LDFLAGS) $(BUILD_WITH_LIBRABBITMQ_LDFLAGS) amqp_la_CPPFLAGS = $(AM_CPPFLAGS) $(BUILD_WITH_LIBRABBITMQ_CPPFLAGS) -amqp_la_LIBADD = $(BUILD_WITH_LIBRABBITMQ_LIBS) +amqp_la_LIBADD = $(BUILD_WITH_LIBRABBITMQ_LIBS) libformat_json.la endif if BUILD_PLUGIN_APACHE @@ -1213,31 +1227,29 @@ endif if BUILD_PLUGIN_WRITE_GRAPHITE pkglib_LTLIBRARIES += write_graphite.la write_graphite_la_SOURCES = write_graphite.c \ - utils_format_graphite.c utils_format_graphite.h \ - utils_format_json.c utils_format_json.h + utils_format_graphite.c utils_format_graphite.h write_graphite_la_LDFLAGS = $(PLUGIN_LDFLAGS) +write_graphite_la_LIBADD = libformat_json.la endif if BUILD_PLUGIN_WRITE_HTTP pkglib_LTLIBRARIES += write_http.la write_http_la_SOURCES = write_http.c \ - utils_format_json.c utils_format_json.h \ utils_format_kairosdb.c utils_format_kairosdb.h -write_http_la_CFLAGS = $(AM_CFLAGS) $(BUILD_WITH_LIBCURL_CFLAGS) write_http_la_LDFLAGS = $(PLUGIN_LDFLAGS) -write_http_la_LIBADD = $(BUILD_WITH_LIBCURL_LIBS) +write_http_la_CFLAGS = $(AM_CFLAGS) $(BUILD_WITH_LIBCURL_CFLAGS) +write_http_la_LIBADD = $(BUILD_WITH_LIBCURL_LIBS) libformat_json.la endif if BUILD_PLUGIN_WRITE_KAFKA pkglib_LTLIBRARIES += write_kafka.la write_kafka_la_SOURCES = write_kafka.c \ utils_format_graphite.c utils_format_graphite.h \ - utils_format_json.c utils_format_json.h \ utils_cmd_putval.c utils_cmd_putval.h \ utils_crc32.c utils_crc32.h write_kafka_la_CPPFLAGS = $(AM_CPPFLAGS) $(BUILD_WITH_LIBRDKAFKA_CPPFLAGS) write_kafka_la_LDFLAGS = $(PLUGIN_LDFLAGS) $(BUILD_WITH_LIBRDKAFKA_LDFLAGS) -write_kafka_la_LIBADD = $(BUILD_WITH_LIBRDKAFKA_LIBS) +write_kafka_la_LIBADD = $(BUILD_WITH_LIBRDKAFKA_LIBS) libformat_json.la endif if BUILD_PLUGIN_WRITE_LOG diff --git a/src/utils_format_json.c b/src/utils_format_json.c index 5ca7fc83..ed942301 100644 --- a/src/utils_format_json.c +++ b/src/utils_format_json.c @@ -1,6 +1,6 @@ /** * collectd - src/utils_format_json.c - * Copyright (C) 2009 Florian octo Forster + * Copyright (C) 2009-2015 Florian octo Forster * * Permission is hereby granted, free of charge, to any person obtaining a * copy of this software and associated documentation files (the "Software"), @@ -26,11 +26,15 @@ #include "collectd.h" +#include "utils_format_json.h" + #include "plugin.h" #include "common.h" - #include "utils_cache.h" -#include "utils_format_json.h" + +#if HAVE_LIBYAJL +#include +#endif static int json_escape_string (char *buffer, size_t buffer_size, /* {{{ */ const char *string) @@ -493,4 +497,200 @@ int format_json_value_list (char *buffer, /* {{{ */ store_rates, (*ret_buffer_free) - 2)); } /* }}} int format_json_value_list */ +#if HAVE_LIBYAJL +static int json_add_string (yajl_gen g, char const *str) /* {{{ */ +{ + if (str == NULL) + return (int) yajl_gen_null (g); + + return (int) yajl_gen_string (g, (unsigned char const *) str, (unsigned int) strlen (str)); +} /* }}} int json_add_string */ + +#define JSON_ADD(g, str) do { \ + yajl_gen_status status = json_add_string (g, str); \ + if (status != yajl_gen_status_ok) { return -1; } \ +} while (0) + +#define JSON_ADDF(g, format, ...) do { \ + char *str = ssnprintf_alloc (format, __VA_ARGS__); \ + yajl_gen_status status = json_add_string (g, str); \ + free (str); \ + if (status != yajl_gen_status_ok) { return -1; } \ +} while (0) + +static int format_json_meta (yajl_gen g, notification_meta_t *meta) /* {{{ */ +{ + if (meta == NULL) + return 0; + + JSON_ADD (g, meta->name); + switch (meta->type) + { + case NM_TYPE_STRING: + JSON_ADD (g, meta->nm_value.nm_string); + break; + case NM_TYPE_SIGNED_INT: + JSON_ADDF (g, "%"PRIi64, meta->nm_value.nm_signed_int); + break; + case NM_TYPE_UNSIGNED_INT: + JSON_ADDF (g, "%"PRIu64, meta->nm_value.nm_unsigned_int); + break; + case NM_TYPE_DOUBLE: + JSON_ADDF (g, JSON_GAUGE_FORMAT, meta->nm_value.nm_double); + break; + case NM_TYPE_BOOLEAN: + JSON_ADD (g, meta->nm_value.nm_boolean ? "true" : "false"); + break; + default: + ERROR ("format_json_meta: unknown meta data type %d (name \"%s\")", meta->type, meta->name); + yajl_gen_null (g); + } + + return format_json_meta (g, meta->next); +} /* }}} int format_json_meta */ + +static int format_time (yajl_gen g, cdtime_t t) /* {{{ */ +{ + char buffer[RFC3339NANO_SIZE] = ""; + + if (rfc3339nano (buffer, sizeof (buffer), t) != 0) + return -1; + + JSON_ADD (g, buffer); + return 0; +} /* }}} int format_time */ + +static int format_alert (yajl_gen g, notification_t const *n) /* {{{ */ +{ + yajl_gen_array_open (g); + yajl_gen_map_open (g); /* BEGIN alert */ + + /* + * labels + */ + JSON_ADD (g, "labels"); + yajl_gen_map_open (g); /* BEGIN labels */ + + JSON_ADD (g, "alertname"); + if (strncmp (n->plugin, n->type, strlen (n->plugin)) == 0) + JSON_ADDF (g, "collectd_%s", n->type); + else + JSON_ADDF (g, "collectd_%s_%s", n->plugin, n->type); + + JSON_ADD (g, "instance"); + JSON_ADD (g, n->host); + + /* mangling of plugin instance and type instance into labels is copied from + * the Prometheus collectd exporter. */ + if (strlen (n->plugin_instance) > 0) + { + JSON_ADD (g, n->plugin); + JSON_ADD (g, n->plugin_instance); + } + if (strlen (n->type_instance) > 0) + { + if (strlen (n->plugin_instance) > 0) + JSON_ADD (g, "type"); + else + JSON_ADD (g, n->plugin); + JSON_ADD (g, n->type_instance); + } + + JSON_ADD (g, "severity"); + JSON_ADD (g, (n->severity == NOTIF_FAILURE) ? "FAILURE" + : (n->severity == NOTIF_WARNING) ? "WARNING" + : (n->severity == NOTIF_OKAY) ? "OKAY" + : "UNKNOWN"); + + JSON_ADD (g, "service"); + JSON_ADD (g, "collectd"); + + yajl_gen_map_close (g); /* END labels */ + + /* + * annotations + */ + JSON_ADD (g, "annotations"); + yajl_gen_map_open (g); /* BEGIN annotations */ + + JSON_ADD (g, "summary"); + JSON_ADD (g, n->message); + + if (format_json_meta (g, n->meta) != 0) + return -1; + + yajl_gen_map_close (g); /* END annotations */ + + JSON_ADD (g, "startsAt"); + format_time (g, n->time); + + yajl_gen_map_close (g); /* END alert */ + yajl_gen_array_close (g); + + return 0; +} /* }}} format_alert */ + +/* + * Format (prometheus/alertmanager v1): + * + * [{ + * "labels": { + * "alertname": "collectd_cpu", + * "instance": "host.example.com", + * "severity": "FAILURE", + * "service": "collectd", + * "cpu": "0", + * "type": "wait" + * }, + * "annotations": { + * "summary": "...", + * // meta + * }, + * "startsAt": , + * "endsAt": , // not used + * }] + */ +int format_json_notification (char *buffer, size_t buffer_size, /* {{{ */ + notification_t const *n) +{ + yajl_gen g; + unsigned char const *out; + size_t unused_out_len; + + if ((buffer == NULL) || (n == NULL)) + return EINVAL; + + g = yajl_gen_alloc (NULL); + if (g == NULL) + return -1; + +#if COLLECT_DEBUG + yajl_gen_config (g, yajl_gen_beautify); + yajl_gen_config (g, yajl_gen_validate_utf8); +#endif + + if (format_alert (g, n) != 0) + { + yajl_gen_clear (g); + yajl_gen_free (g); + return -1; + } + + /* copy to output buffer */ + yajl_gen_get_buf (g, &out, &unused_out_len); + sstrncpy (buffer, (void *) out, buffer_size); + + yajl_gen_clear (g); + yajl_gen_free (g); + return 0; +} /* }}} format_json_notification */ +#else +int format_json_notification (char *buffer, size_t buffer_size, /* {{{ */ + notification_t const *n) +{ + ERROR ("format_json_notification: Not available (requires libyajl)."); + return ENOTSUP; +} /* }}} int format_json_notification */ +#endif + /* vim: set sw=2 sts=2 et fdm=marker : */ diff --git a/src/utils_format_json.h b/src/utils_format_json.h index 3584decf..a3eda304 100644 --- a/src/utils_format_json.h +++ b/src/utils_format_json.h @@ -42,5 +42,7 @@ int format_json_value_list (char *buffer, const data_set_t *ds, const value_list_t *vl, int store_rates); int format_json_finalize (char *buffer, size_t *ret_buffer_fill, size_t *ret_buffer_free); +int format_json_notification (char *buffer, size_t buffer_size, + notification_t const *n); #endif /* UTILS_FORMAT_JSON_H */ diff --git a/src/utils_format_json_test.c b/src/utils_format_json_test.c new file mode 100644 index 00000000..6df62119 --- /dev/null +++ b/src/utils_format_json_test.c @@ -0,0 +1,152 @@ +/** + * collectd - src/utils_format_json_test.c + * Copyright (C) 2015 Florian octo Forster + * + * Permission is hereby granted, free of charge, to any person obtaining a + * copy of this software and associated documentation files (the "Software"), + * to deal in the Software without restriction, including without limitation + * the rights to use, copy, modify, merge, publish, distribute, sublicense, + * and/or sell copies of the Software, and to permit persons to whom the + * Software is furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER + * DEALINGS IN THE SOFTWARE. + * + * Authors: + * Florian octo Forster + */ + +#include "testing.h" +#include "collectd.h" +#include "utils_format_json.h" +#include "common.h" /* for STATIC_ARRAY_SIZE */ + +#include + +struct label_s +{ + char *key; + char *value; +}; +typedef struct label_s label_t; + +struct test_case_s +{ + label_t *expected_labels; + size_t expected_labels_num; + + label_t *current_label; +}; +typedef struct test_case_s test_case_t; + +static int test_map_key (void *ctx, unsigned char const *key, size_t key_len) +{ + test_case_t *c = ctx; + size_t i; + + c->current_label = NULL; + for (i = 0; i < c->expected_labels_num; i++) + { + label_t *l = c->expected_labels + i; + if ((strlen (l->key) == key_len) + && (strncmp (l->key, (char const *) key, key_len) == 0)) + { + c->current_label = l; + break; + } + } + + return 1; /* continue */ +} + +static int expect_label (char const *name, char const *got, char const *want) +{ + _Bool ok = (strcmp (got, want) == 0); + char msg[1024]; + + if (ok) + snprintf (msg, sizeof (msg), "label[\"%s\"] = \"%s\"", name, got); + else + snprintf (msg, sizeof (msg), "label[\"%s\"] = \"%s\", want \"%s\"", name, got, want); + + OK1 (ok, msg); + return 0; +} + +static int test_string (void *ctx, unsigned char const *value, size_t value_len) +{ + test_case_t *c = ctx; + + if (c->current_label != NULL) + { + label_t *l = c->current_label; + char *got; + int status; + + got = malloc (value_len + 1); + memmove (got, value, value_len); + got[value_len] = 0; + + status = expect_label (l->key, got, l->value); + + free (got); + + if (status != 0) + return 0; /* abort */ + } + + return 1; /* continue */ +} + +static int expect_json_labels (char *json, label_t *labels, size_t labels_num) +{ + yajl_callbacks funcs = { + .yajl_string = test_string, + .yajl_map_key = test_map_key, + }; + + test_case_t c = { labels, labels_num, NULL }; + + yajl_handle hndl; + CHECK_NOT_NULL (hndl = yajl_alloc (&funcs, NULL, &c)); + OK (yajl_parse (hndl, (unsigned char *) json, strlen (json)) == yajl_status_ok); + + yajl_free (hndl); + return 0; +} + +DEF_TEST(notification) +{ + label_t labels[] = { + {"summary", "this is a message"}, + {"alertname", "collectd_unit_test"}, + {"instance", "example.com"}, + {"service", "collectd"}, + {"unit", "case"}, + }; + + /* 1448284606.125 ^= 1555083754651779072 */ + notification_t n = { NOTIF_WARNING, 1555083754651779072, "this is a message", + "example.com", "unit", "", "test", "case", NULL }; + + char got[1024]; + CHECK_ZERO (format_json_notification (got, sizeof (got), &n)); + // printf ("got = \"%s\";\n", got); + + return expect_json_labels (got, labels, STATIC_ARRAY_SIZE (labels)); +} + +int main (void) +{ + RUN_TEST(notification); + + END_TEST; +} -- 2.30.2