Merging upstream version 1.46.3.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

3 files changed, 521 insertions, 0 deletions

diff --git a/src/web/api/formatters/json/README.md b/src/web/api/formatters/json/README.md
new file mode 100644
index 000000000..4137b0372
--- /dev/null
+++ b/src/web/api/formatters/json/README.md
@@ -0,0 +1,160 @@
+<!--
+title: "JSON formatter"
+custom_edit_url: https://github.com/netdata/netdata/edit/master/src/web/api/formatters/json/README.md
+sidebar_label: "JSON formatter"
+learn_status: "Published"
+learn_topic_type: "References"
+learn_rel_path: "Developers/Web/Api/Formatters"
+-->
+
+# JSON formatter
+
+The CSV formatter presents [results of database queries](/src/web/api/queries/README.md) in the following formats:
+
+| format       | content type     | description|
+|:----:|:----------:|:----------|
+| `json`       | application/json | return the query result as a json object|
+| `jsonp`      | application/json | return the query result as a JSONP javascript callback|
+| `datatable`  | application/json | return the query result as a Google `datatable`|
+| `datasource` | application/json | return the query result as a Google Visualization Provider `datasource` javascript callback|
+
+The CSV formatter respects the following API `&options=`:
+
+| option        | supported | description|
+|:----:|:-------:|:----------|
+| `google_json` | yes       | enable the Google flavor of JSON (using double quotes for strings and `Date()` function for dates|
+| `objectrows`  | yes       | return each row as an object, instead of an array|
+| `nonzero`     | yes       | to return only the dimensions that have at least a non-zero value|
+| `flip`        | yes       | to return the rows older to newer (the default is newer to older)|
+| `seconds`     | yes       | to return the date and time in unix timestamp|
+| `ms`          | yes       | to return the date and time in unit timestamp as milliseconds|
+| `percent`     | yes       | to replace all values with their percentage over the row total|
+| `abs`         | yes       | to turn all values positive|
+| `null2zero`   | yes       | to replace gaps with zeros (the default prints the string `null`|
+
+## Examples
+
+To show the differences between each format, in the following examples we query the same
+chart (having just one dimension called `active`), changing only the query `format` and its `options`.
+
+> Using `format=json` and `options=`
+
+```bash
+# curl -Ss 'https://registry.my-netdata.io/api/v1/data?chart=nginx_local.connections&after=-3600&points=6&group=average&format=json&options='
+{
+ "labels": ["time", "active"],
+    "data":
+ [
+      [ 1540644600, 224.2516667],
+      [ 1540644000, 229.29],
+      [ 1540643400, 222.41],
+      [ 1540642800, 226.6816667],
+      [ 1540642200, 246.4083333],
+      [ 1540641600, 241.0966667]
+  ]
+}
+```
+
+> Using `format=json` and `options=objectrows`
+
+```bash
+# curl -Ss 'https://registry.my-netdata.io/api/v1/data?chart=nginx_local.connections&after=-3600&points=6&group=average&format=json&options=objectrows'
+{
+ "labels": ["time", "active"],
+    "data":
+ [
+      { "time": 1540644600, "active": 224.2516667},
+      { "time": 1540644000, "active": 229.29},
+      { "time": 1540643400, "active": 222.41},
+      { "time": 1540642800, "active": 226.6816667},
+      { "time": 1540642200, "active": 246.4083333},
+      { "time": 1540641600, "active": 241.0966667}
+  ]
+}
+```
+
+> Using `format=json` and `options=objectrows,google_json`
+
+```bash
+# curl -Ss 'https://registry.my-netdata.io/api/v1/data?chart=nginx_local.connections&after=-3600&points=6&group=average&formatjson&options=objectrows,google_json'
+{
+ "labels": ["time", "active"],
+    "data":
+ [
+      { "time": new Date(2018,9,27,12,50,0), "active": 224.2516667},
+      { "time": new Date(2018,9,27,12,40,0), "active": 229.29},
+      { "time": new Date(2018,9,27,12,30,0), "active": 222.41},
+      { "time": new Date(2018,9,27,12,20,0), "active": 226.6816667},
+      { "time": new Date(2018,9,27,12,10,0), "active": 246.4083333},
+      { "time": new Date(2018,9,27,12,0,0), "active": 241.0966667}
+  ]
+}
+```
+
+> Using `format=jsonp` and `options=`
+
+```bash
+curl -Ss 'https://registry.my-netdata.io/api/v1/data?chart=nginx_local.connections&after=-3600&points=6&group=average&formjsonp&options='
+callback({
+ "labels": ["time", "active"],
+    "data":
+ [
+      [ 1540645200, 235.885],
+      [ 1540644600, 224.2516667],
+      [ 1540644000, 229.29],
+      [ 1540643400, 222.41],
+      [ 1540642800, 226.6816667],
+      [ 1540642200, 246.4083333]
+  ]
+});
+```
+
+> Using `format=datatable` and `options=`
+
+```bash
+curl -Ss 'https://registry.my-netdata.io/api/v1/data?chart=nginx_local.connections&after=-3600&points=6&group=average&formdatatable&options='
+{
+ "cols":
+ [
+        {"id":"","label":"time","pattern":"","type":"datetime"},
+        {"id":"","label":"","pattern":"","type":"string","p":{"role":"annotation"}},
+        {"id":"","label":"","pattern":"","type":"string","p":{"role":"annotationText"}},
+     {"id":"","label":"active","pattern":"","type":"number"}
+  ],
+    "rows":
+ [
+        {"c":[{"v":"Date(2018,9,27,13,0,0)"},{"v":null},{"v":null},{"v":235.885}]},
+        {"c":[{"v":"Date(2018,9,27,12,50,0)"},{"v":null},{"v":null},{"v":224.2516667}]},
+        {"c":[{"v":"Date(2018,9,27,12,40,0)"},{"v":null},{"v":null},{"v":229.29}]},
+        {"c":[{"v":"Date(2018,9,27,12,30,0)"},{"v":null},{"v":null},{"v":222.41}]},
+        {"c":[{"v":"Date(2018,9,27,12,20,0)"},{"v":null},{"v":null},{"v":226.6816667}]},
+        {"c":[{"v":"Date(2018,9,27,12,10,0)"},{"v":null},{"v":null},{"v":246.4083333}]}
+  ]
+}
+```
+
+> Using `format=datasource` and `options=`
+
+```bash
+curl -Ss 'https://registry.my-netdata.io/api/v1/data?chart=nginx_local.connections&after=-3600&points=6&group=average&format=datasource&options='
+google.visualization.Query.setResponse({version:'0.6',reqId:'0',status:'ok',sig:'1540645368',table:{
+ "cols":
+ [
+        {"id":"","label":"time","pattern":"","type":"datetime"},
+        {"id":"","label":"","pattern":"","type":"string","p":{"role":"annotation"}},
+        {"id":"","label":"","pattern":"","type":"string","p":{"role":"annotationText"}},
+     {"id":"","label":"active","pattern":"","type":"number"}
+  ],
+    "rows":
+ [
+        {"c":[{"v":"Date(2018,9,27,13,0,0)"},{"v":null},{"v":null},{"v":235.885}]},
+        {"c":[{"v":"Date(2018,9,27,12,50,0)"},{"v":null},{"v":null},{"v":224.2516667}]},
+        {"c":[{"v":"Date(2018,9,27,12,40,0)"},{"v":null},{"v":null},{"v":229.29}]},
+        {"c":[{"v":"Date(2018,9,27,12,30,0)"},{"v":null},{"v":null},{"v":222.41}]},
+        {"c":[{"v":"Date(2018,9,27,12,20,0)"},{"v":null},{"v":null},{"v":226.6816667}]},
+        {"c":[{"v":"Date(2018,9,27,12,10,0)"},{"v":null},{"v":null},{"v":246.4083333}]}
+  ]
+}});
+```
+
+
diff --git a/src/web/api/formatters/json/json.c b/src/web/api/formatters/json/json.c
new file mode 100644
index 000000000..7e3f400e9
--- /dev/null
+++ b/src/web/api/formatters/json/json.c
@@ -0,0 +1,350 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+
+#include "json.h"
+
+#define JSON_DATES_JS 1
+#define JSON_DATES_TIMESTAMP 2
+
+void rrdr2json(RRDR *r, BUFFER *wb, RRDR_OPTIONS options, int datatable) {
+    //netdata_log_info("RRD2JSON(): %s: BEGIN", r->st->id);
+    int row_annotations = 0, dates, dates_with_new = 0;
+    char kq[2] = "",                        // key quote
+            sq[2] = "",                     // string quote
+            pre_label[101] = "",            // before each label
+            post_label[101] = "",           // after each label
+            pre_date[101] = "",             // the beginning of line, to the date
+            post_date[101] = "",            // closing the date
+            pre_value[101] = "",            // before each value
+            post_value[101] = "",           // after each value
+            post_line[101] = "",            // at the end of each row
+            normal_annotation[201] = "",    // default row annotation
+            overflow_annotation[201] = "",  // overflow row annotation
+            data_begin[101] = "",           // between labels and values
+            finish[101] = "",               // at the end of everything
+            object_rows_time[101] = "";
+
+    if(datatable) {
+        dates = JSON_DATES_JS;
+        if( options & RRDR_OPTION_GOOGLE_JSON ) {
+            kq[0] = '\0';
+            sq[0] = '\'';
+        }
+        else {
+            kq[0] = '"';
+            sq[0] = '"';
+        }
+        row_annotations = 1;
+        snprintfz(pre_date,   100, "        {%sc%s:[{%sv%s:%s", kq, kq, kq, kq, sq);
+        snprintfz(post_date,  100, "%s}", sq);
+        snprintfz(pre_label,  100, ",\n     {%sid%s:%s%s,%slabel%s:%s", kq, kq, sq, sq, kq, kq, sq);
+        snprintfz(post_label, 100, "%s,%spattern%s:%s%s,%stype%s:%snumber%s}", sq, kq, kq, sq, sq, kq, kq, sq, sq);
+        snprintfz(pre_value,  100, ",{%sv%s:", kq, kq);
+        strcpy(post_value,         "}");
+        strcpy(post_line,          "]}");
+        snprintfz(data_begin, 100, "\n  ],\n    %srows%s:\n [\n", kq, kq);
+        strcpy(finish,             "\n        ]\n    }");
+
+        snprintfz(overflow_annotation, 200, ",{%sv%s:%sRESET OR OVERFLOW%s},{%sv%s:%sThe counters have been wrapped.%s}", kq, kq, sq, sq, kq, kq, sq, sq);
+        snprintfz(normal_annotation,   200, ",{%sv%s:null},{%sv%s:null}", kq, kq, kq, kq);
+
+        buffer_sprintf(wb, "{\n %scols%s:\n [\n", kq, kq);
+        buffer_sprintf(wb, "        {%sid%s:%s%s,%slabel%s:%stime%s,%spattern%s:%s%s,%stype%s:%sdatetime%s},\n", kq, kq, sq, sq, kq, kq, sq, sq, kq, kq, sq, sq, kq, kq, sq, sq);
+        buffer_sprintf(wb, "        {%sid%s:%s%s,%slabel%s:%s%s,%spattern%s:%s%s,%stype%s:%sstring%s,%sp%s:{%srole%s:%sannotation%s}},\n", kq, kq, sq, sq, kq, kq, sq, sq, kq, kq, sq, sq, kq, kq, sq, sq, kq, kq, kq, kq, sq, sq);
+        buffer_sprintf(wb, "        {%sid%s:%s%s,%slabel%s:%s%s,%spattern%s:%s%s,%stype%s:%sstring%s,%sp%s:{%srole%s:%sannotationText%s}}", kq, kq, sq, sq, kq, kq, sq, sq, kq, kq, sq, sq, kq, kq, sq, sq, kq, kq, kq, kq, sq, sq);
+
+        // remove the valueobjects flag
+        // google wants its own keys
+        if(options & RRDR_OPTION_OBJECTSROWS)
+            options &= ~RRDR_OPTION_OBJECTSROWS;
+    }
+    else {
+        kq[0] = '"';
+        sq[0] = '"';
+        if(options & RRDR_OPTION_GOOGLE_JSON) {
+            dates = JSON_DATES_JS;
+            dates_with_new = 1;
+        }
+        else {
+            dates = JSON_DATES_TIMESTAMP;
+            dates_with_new = 0;
+        }
+        if( options & RRDR_OPTION_OBJECTSROWS )
+            strcpy(pre_date, "            {");
+        else
+            strcpy(pre_date, "            [");
+        strcpy(pre_label,  ",\"");
+        strcpy(post_label, "\"");
+        strcpy(pre_value,  ",");
+        if( options & RRDR_OPTION_OBJECTSROWS )
+            strcpy(post_line, "}");
+        else
+            strcpy(post_line, "]");
+        snprintfz(data_begin, 100, "],\n        %sdata%s:[\n", kq, kq);
+        strcpy(finish,             "\n        ]\n    }");
+
+        buffer_sprintf(wb, "{\n        %slabels%s:[", kq, kq);
+        buffer_sprintf(wb, "%stime%s", sq, sq);
+
+        if( options & RRDR_OPTION_OBJECTSROWS )
+            snprintfz(object_rows_time, 100, "%stime%s: ", kq, kq);
+
+    }
+
+    size_t pre_value_len = strlen(pre_value);
+    size_t post_value_len = strlen(post_value);
+    size_t pre_label_len = strlen(pre_label);
+    size_t post_label_len = strlen(post_label);
+    size_t pre_date_len = strlen(pre_date);
+    size_t post_date_len = strlen(post_date);
+    size_t post_line_len = strlen(post_line);
+    size_t normal_annotation_len = strlen(normal_annotation);
+    size_t overflow_annotation_len = strlen(overflow_annotation);
+    size_t object_rows_time_len = strlen(object_rows_time);
+
+    // -------------------------------------------------------------------------
+    // print the JSON header
+
+    long c, i;
+    const long used = (long)r->d;
+
+    // print the header lines
+    for(c = 0, i = 0; c < used ; c++) {
+        if(!rrdr_dimension_should_be_exposed(r->od[c], options))
+            continue;
+
+        buffer_fast_strcat(wb, pre_label, pre_label_len);
+        buffer_strcat(wb, string2str(r->dn[c]));
+        buffer_fast_strcat(wb, post_label, post_label_len);
+        i++;
+    }
+
+    if(!i) {
+        buffer_fast_strcat(wb, pre_label, pre_label_len);
+        buffer_fast_strcat(wb, "no data", 7);
+        buffer_fast_strcat(wb, post_label, post_label_len);
+    }
+    size_t total_number_of_dimensions = i;
+
+    // print the beginning of row data
+    buffer_strcat(wb, data_begin);
+
+    // if all dimensions are hidden, print a null
+    if(!i) {
+        buffer_strcat(wb, finish);
+        return;
+    }
+
+    long start = 0, end = rrdr_rows(r), step = 1;
+    if(!(options & RRDR_OPTION_REVERSED)) {
+        start = rrdr_rows(r) - 1;
+        end = -1;
+        step = -1;
+    }
+
+    // pre-allocate a large enough buffer for us
+    // this does not need to be accurate - it is just a hint to avoid multiple realloc().
+    buffer_need_bytes(wb,
+                      ( 20 * rrdr_rows(r)) // timestamp + json overhead
+                    + ( (pre_value_len + post_value_len + 4) * total_number_of_dimensions * rrdr_rows(r) ) // number
+                      );
+
+    // for each line in the array
+    for(i = start; i != end ;i += step) {
+        NETDATA_DOUBLE *cn = &r->v[ i * r->d ];
+        RRDR_VALUE_FLAGS *co = &r->o[ i * r->d ];
+        NETDATA_DOUBLE *ar = &r->ar[ i * r->d ];
+
+        time_t now = r->t[i];
+
+        if(dates == JSON_DATES_JS) {
+            // generate the local date time
+            struct tm tmbuf, *tm = localtime_r(&now, &tmbuf);
+            if(!tm) {
+                netdata_log_error("localtime_r() failed."); continue; }
+
+            if(likely(i != start)) buffer_fast_strcat(wb, ",\n", 2);
+            buffer_fast_strcat(wb, pre_date, pre_date_len);
+
+            if( options & RRDR_OPTION_OBJECTSROWS )
+                buffer_fast_strcat(wb, object_rows_time, object_rows_time_len);
+
+            if(unlikely(dates_with_new))
+                buffer_fast_strcat(wb, "new ", 4);
+
+            buffer_jsdate(wb, tm->tm_year + 1900, tm->tm_mon, tm->tm_mday, tm->tm_hour, tm->tm_min, tm->tm_sec);
+
+            buffer_fast_strcat(wb, post_date, post_date_len);
+
+            if(unlikely(row_annotations)) {
+                // google supports one annotation per row
+                int annotation_found = 0;
+                for(c = 0; c < used ; c++) {
+                    if(unlikely(!(r->od[c] & RRDR_DIMENSION_QUERIED))) continue;
+
+                    if(unlikely(co[c] & RRDR_VALUE_RESET)) {
+                        buffer_fast_strcat(wb, overflow_annotation, overflow_annotation_len);
+                        annotation_found = 1;
+                        break;
+                    }
+                }
+                if(likely(!annotation_found))
+                    buffer_fast_strcat(wb, normal_annotation, normal_annotation_len);
+            }
+        }
+        else {
+            // print the timestamp of the line
+            if(likely(i != start))
+                buffer_fast_strcat(wb, ",\n", 2);
+
+            buffer_fast_strcat(wb, pre_date, pre_date_len);
+
+            if(unlikely( options & RRDR_OPTION_OBJECTSROWS ))
+                buffer_fast_strcat(wb, object_rows_time, object_rows_time_len);
+
+            buffer_print_netdata_double(wb, (NETDATA_DOUBLE) r->t[i]);
+
+            // in ms
+            if(unlikely(options & RRDR_OPTION_MILLISECONDS))
+                buffer_fast_strcat(wb, "000", 3);
+
+            buffer_fast_strcat(wb, post_date, post_date_len);
+        }
+
+        // for each dimension
+        for(c = 0; c < used ;c++) {
+            if(!rrdr_dimension_should_be_exposed(r->od[c], options))
+                continue;
+
+            NETDATA_DOUBLE n;
+            if(unlikely(options & RRDR_OPTION_INTERNAL_AR))
+                n = ar[c];
+            else
+                n = cn[c];
+
+            buffer_fast_strcat(wb, pre_value, pre_value_len);
+
+            if(unlikely( options & RRDR_OPTION_OBJECTSROWS ))
+                buffer_sprintf(wb, "%s%s%s: ", kq, string2str(r->dn[c]), kq);
+
+            if(co[c] & RRDR_VALUE_EMPTY && !(options & (RRDR_OPTION_INTERNAL_AR))) {
+                if(unlikely(options & RRDR_OPTION_NULL2ZERO))
+                    buffer_fast_strcat(wb, "0", 1);
+                else
+                    buffer_fast_strcat(wb, "null", 4);
+            }
+            else
+                buffer_print_netdata_double(wb, n);
+
+            buffer_fast_strcat(wb, post_value, post_value_len);
+        }
+
+        buffer_fast_strcat(wb, post_line, post_line_len);
+    }
+
+    buffer_strcat(wb, finish);
+    //netdata_log_info("RRD2JSON(): %s: END", r->st->id);
+}
+
+void rrdr2json_v2(RRDR *r, BUFFER *wb) {
+    QUERY_TARGET *qt = r->internal.qt;
+    RRDR_OPTIONS options = qt->window.options;
+
+    bool send_count = query_target_aggregatable(qt);
+    bool send_hidden = send_count && r->vh && query_has_group_by_aggregation_percentage(qt);
+
+    buffer_json_member_add_object(wb, "result");
+
+    buffer_json_member_add_array(wb, "labels");
+    buffer_json_add_array_item_string(wb, "time");
+    long d, i;
+    const long used = (long)r->d;
+    for(d = 0, i = 0; d < used ; d++) {
+        if(!rrdr_dimension_should_be_exposed(r->od[d], options))
+            continue;
+
+        buffer_json_add_array_item_string(wb, string2str(r->di[d]));
+        i++;
+    }
+    buffer_json_array_close(wb); // labels
+
+    buffer_json_member_add_object(wb, "point");
+    {
+        size_t point_count = 0;
+        buffer_json_member_add_uint64(wb, "value", point_count++);
+        buffer_json_member_add_uint64(wb, "arp", point_count++);
+        buffer_json_member_add_uint64(wb, "pa", point_count++);
+        if (send_count)
+            buffer_json_member_add_uint64(wb, "count", point_count++);
+        if (send_hidden)
+            buffer_json_member_add_uint64(wb, "hidden", point_count++);
+    }
+    buffer_json_object_close(wb); // point
+
+    buffer_json_member_add_array(wb, "data");
+    if(i) {
+        long start = 0, end = rrdr_rows(r), step = 1;
+        if (!(options & RRDR_OPTION_REVERSED)) {
+            start = rrdr_rows(r) - 1;
+            end = -1;
+            step = -1;
+        }
+
+        // for each line in the array
+        for (i = start; i != end; i += step) {
+            NETDATA_DOUBLE *cn = &r->v[ i * r->d ];
+            NETDATA_DOUBLE *ch = send_hidden ? &r->vh[i * r->d ] : NULL;
+            RRDR_VALUE_FLAGS *co = &r->o[ i * r->d ];
+            NETDATA_DOUBLE *ar = &r->ar[ i * r->d ];
+            uint32_t *gbc = &r->gbc [ i * r->d ];
+            time_t now = r->t[i];
+
+            buffer_json_add_array_item_array(wb); // row
+
+            if (options & RRDR_OPTION_MILLISECONDS)
+                buffer_json_add_array_item_time_ms(wb, now); // the time
+            else
+                buffer_json_add_array_item_time_t(wb, now); // the time
+
+            for (d = 0; d < used; d++) {
+                if (!rrdr_dimension_should_be_exposed(r->od[d], options))
+                    continue;
+
+                RRDR_VALUE_FLAGS o = co[d];
+
+                buffer_json_add_array_item_array(wb); // point
+
+                // add the value
+                NETDATA_DOUBLE n = cn[d];
+
+                if(o & RRDR_VALUE_EMPTY) {
+                    if (unlikely(options & RRDR_OPTION_NULL2ZERO))
+                        buffer_json_add_array_item_double(wb, 0);
+                    else
+                        buffer_json_add_array_item_double(wb, NAN);
+                }
+                else
+                    buffer_json_add_array_item_double(wb, n);
+
+                // add the anomaly
+                buffer_json_add_array_item_double(wb, ar[d]);
+
+                // add the point annotations
+                buffer_json_add_array_item_uint64(wb, o);
+
+                // add the count
+                if(send_count)
+                    buffer_json_add_array_item_uint64(wb, gbc[d]);
+                if(send_hidden)
+                    buffer_json_add_array_item_double(wb, ch[d]);
+
+                buffer_json_array_close(wb); // point
+            }
+
+            buffer_json_array_close(wb); // row
+        }
+    }
+
+    buffer_json_array_close(wb); // data
+
+    buffer_json_object_close(wb); // annotations
+}
diff --git a/src/web/api/formatters/json/json.h b/src/web/api/formatters/json/json.h
new file mode 100644
index 000000000..d1ab4f901
--- /dev/null
+++ b/src/web/api/formatters/json/json.h
@@ -0,0 +1,11 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+
+#ifndef NETDATA_API_FORMATTER_JSON_H
+#define NETDATA_API_FORMATTER_JSON_H
+
+#include "../rrd2json.h"
+
+void rrdr2json(RRDR *r, BUFFER *wb, RRDR_OPTIONS options, int datatable);
+void rrdr2json_v2(RRDR *r, BUFFER *wb);
+
+#endif //NETDATA_API_FORMATTER_JSON_H