From c2383e9d78956ee8906b5efb750e412c0256382c Mon Sep 17 00:00:00 2001 From: Daniel Nelson Date: Thu, 14 Sep 2017 15:50:55 -0700 Subject: [PATCH] Update input plugin example readme. --- plugins/inputs/EXAMPLE_README.md | 33 +++++++++++++++++++++----------- 1 file changed, 22 insertions(+), 11 deletions(-) diff --git a/plugins/inputs/EXAMPLE_README.md b/plugins/inputs/EXAMPLE_README.md index 73e33850c..4ebedda87 100644 --- a/plugins/inputs/EXAMPLE_README.md +++ b/plugins/inputs/EXAMPLE_README.md @@ -6,30 +6,37 @@ additional information can be found. ### Configuration: +This section contains the default TOML to configure the plugin. You can +generate it using `telegraf --usage `. + ```toml # Description [[inputs.example]] - # SampleConfig + example_option = "example_value" ``` -### Measurements & Fields: +### Metrics: Here you should add an optional description and links to where the user can get more information about the measurements. +If the output is determined dynamically based on the input source, or there +are more metrics than can reasonably be listed, describe how the input is +mapped to the output. + - measurement1 - - field1 (type, unit) - - field2 (float, percent) -- measurement2 - - field3 (integer, bytes) - -### Tags: - -- All measurements have the following tags: + - tags: - tag1 (optional description) - tag2 -- measurement2 has the following tags: + - fields: + - field1 (type, unit) + - field2 (float, percent) + +- measurement2 + - tags: - tag3 + - fields: + - field3 (integer, bytes) ### Sample Queries: @@ -44,6 +51,10 @@ SELECT max(field1), mean(field1), min(field1) FROM measurement1 WHERE tag1=bar A ### Example Output: +This section shows example output in Line Protocol format. You can often use +`telegraf --input-filter --test` or use the `file` output to get +this information. + ``` measurement1,tag1=foo,tag2=bar field1=1i,field2=2.1 1453831884664956455 measurement2,tag1=foo,tag2=bar,tag3=baz field3=1i 1453831884664956455