From 7041a2efb39c4ab51795ce75ea0471342b67e5bd Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Tue, 9 Dec 2025 11:31:22 -0600 Subject: [PATCH] chore(telegraf): Prepare for data formats (serializers) documentation generated from upstream (influxdata/telegraf). - Moves data_format and subdirs to `content/telegraf/v1/{input,output}-data-formats - Adds _index.md with metadata similar to {input,output}-plugins files. - Included shortcode reference, but haven't made any shortcode updates yet. --- .../telegraf/v1/input-data-formats/_index.md | 34 +++++++++++++++++++ .../telegraf/v1/output-data-formats/_index.md | 30 ++++++++++++++++ 2 files changed, 64 insertions(+) create mode 100644 content/telegraf/v1/input-data-formats/_index.md create mode 100644 content/telegraf/v1/output-data-formats/_index.md diff --git a/content/telegraf/v1/input-data-formats/_index.md b/content/telegraf/v1/input-data-formats/_index.md new file mode 100644 index 000000000..6cac4137b --- /dev/null +++ b/content/telegraf/v1/input-data-formats/_index.md @@ -0,0 +1,34 @@ +--- +title: Telegraf input data formats +list_title: Input data formats +description: Telegraf supports parsing input data formats into Telegraf metrics. +menu: + telegraf_v1_ref: + name: Input data formats + parent: data_formats_reference + identifier: input_data_formats_reference + weight: 20 +tags: [input-data-formats, input-serializers] +--- + +Telegraf supports the following input data formats for parsing data into [metrics](/telegraf/v1/metrics/). +Input plugins that support these formats include a `data_format` configuration option. + +For example, in the [Exec input plugin](/telegraf/v1/input-plugins/exec/): + +```toml +[[inputs.exec]] + ## Commands array + commands = ["/tmp/test.sh", "/usr/bin/mycollector --foo=bar"] + + ## measurement name suffix (for separating different commands) + name_suffix = "_mycollector" + + ## Data format to consume. + ## Each data format has its own unique set of configuration options, read + ## more about them here: + ## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md + data_format = "json_v2" +``` + +{{< telegraf/data-formats type="input" >}} diff --git a/content/telegraf/v1/output-data-formats/_index.md b/content/telegraf/v1/output-data-formats/_index.md new file mode 100644 index 000000000..b3e11ae84 --- /dev/null +++ b/content/telegraf/v1/output-data-formats/_index.md @@ -0,0 +1,30 @@ +--- +title: Telegraf output data formats +list_title: Output data formats +description: Telegraf serializes metrics into output data formats. +menu: + telegraf_v1_ref: + name: Output data formats + parent: data_formats_reference + identifier: output_data_formats_reference + weight: 20 +tags: [output-data-formats, output-serializers] + +Telegraf supports the following output data formats for serializing metrics. +Output plugins that support these formats include a `data_format` configuration option. + +For example, in the [File output plugin](/telegraf/v1/output-plugins/file/): + +```toml +[[outputs.file]] + ## Files to write to, "stdout" is a specially handled file. + files = ["stdout"] + + ## Data format to output. + ## Each data format has its own unique set of configuration options, read + ## more about them here: + ## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md + data_format = "influx" +``` + +{{< telegraf/data-formats type="output" >}}