CL-Softwares
/
telegraf
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(serializers.json): specify version of jsonata used (#12117)

This commit is contained in:
Joshua Powers 2022-10-27 10:29:25 -06:00 committed by GitHub
parent 7d37ddfe51
commit 7466834164
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
plugins/serializers/json/README.md
View File

@ -27,7 +27,9 @@ The `json` output data format converts metrics into JSON documents.
# e.g.: json_timestamp_format = "2006-01-02T15:04:05Z07:00" # e.g.: json_timestamp_format = "2006-01-02T15:04:05Z07:00"
#json_timestamp_format = "" #json_timestamp_format = ""
## A [JSONata](https://jsonata.org/) transformation of the JSON in [standard-form](#examples). ## A [JSONata](https://jsonata.org/) transformation of the JSON in
## [standard-form](#examples). Please note that only version 1.5.4 of the
## JSONata is supported due to the underlying library used.
## This allows to generate an arbitrary output form based on the metric(s). Please use ## This allows to generate an arbitrary output form based on the metric(s). Please use
## multiline strings (starting and ending with three single-quotes) if needed. ## multiline strings (starting and ending with three single-quotes) if needed.
#json_transformation = "" #json_transformation = ""
@ -100,6 +102,11 @@ metric in the standard-form above.
The former adds a `metrics` field containing the metric array, while the later The former adds a `metrics` field containing the metric array, while the later
serializes the metric directly. serializes the metric directly.
**Note**: Please note that the JSONata support is limited to version 1.5.4 due
to the underlying library used by Telegraf. When using the online playground
below ensure that you have selected 1.5.4 when trying examples or building
transformations.
In the following sections, some rudimentary examples for transformations are shown. In the following sections, some rudimentary examples for transformations are shown.
For more elaborated JSONata expressions please consult the For more elaborated JSONata expressions please consult the
[documentation](https://docs.jsonata.org) or the [documentation](https://docs.jsonata.org) or the