Skip to content
Snippets Groups Projects
Unverified Commit 575a07c9 authored by Daniel Nelson's avatar Daniel Nelson
Browse files

Update input plugin example readme.

parent b94cda6b
No related branches found
No related tags found
No related merge requests found
...@@ -6,30 +6,37 @@ additional information can be found. ...@@ -6,30 +6,37 @@ additional information can be found.
### Configuration: ### Configuration:
This section contains the default TOML to configure the plugin. You can
generate it using `telegraf --usage <plugin-name>`.
```toml ```toml
# Description # Description
[[inputs.example]] [[inputs.example]]
# SampleConfig example_option = "example_value"
``` ```
### Measurements & Fields: ### Metrics:
Here you should add an optional description and links to where the user can Here you should add an optional description and links to where the user can
get more information about the measurements. 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 - measurement1
- tags:
- tag1 (optional description)
- tag2
- fields:
- field1 (type, unit) - field1 (type, unit)
- field2 (float, percent) - field2 (float, percent)
- measurement2
- field3 (integer, bytes)
### Tags: - measurement2
- tags:
- All measurements have the following tags:
- tag1 (optional description)
- tag2
- measurement2 has the following tags:
- tag3 - tag3
- fields:
- field3 (integer, bytes)
### Sample Queries: ### Sample Queries:
...@@ -44,6 +51,10 @@ SELECT max(field1), mean(field1), min(field1) FROM measurement1 WHERE tag1=bar A ...@@ -44,6 +51,10 @@ SELECT max(field1), mean(field1), min(field1) FROM measurement1 WHERE tag1=bar A
### Example Output: ### Example Output:
This section shows example output in Line Protocol format. You can often use
`telegraf --input-filter <plugin-name> --test` or use the `file` output to get
this information.
``` ```
measurement1,tag1=foo,tag2=bar field1=1i,field2=2.1 1453831884664956455 measurement1,tag1=foo,tag2=bar field1=1i,field2=2.1 1453831884664956455
measurement2,tag1=foo,tag2=bar,tag3=baz field3=1i 1453831884664956455 measurement2,tag1=foo,tag2=bar,tag3=baz field3=1i 1453831884664956455
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment