Skip to content
This repository has been archived by the owner on Oct 18, 2023. It is now read-only.

Commit

Permalink
Update EXAMPLE_README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
danielnelson committed Apr 21, 2017
1 parent da07731 commit 3684ec6
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions plugins/inputs/EXAMPLE_README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Example Input Plugin

The example plugin gathers metrics about example things
The example plugin gathers metrics about example things. This description
explains at a high level what the plugin does and provides links to where
additional information can be found.

### Configuration:

Expand All @@ -12,7 +14,8 @@ The example plugin gathers metrics about example things

### Measurements & Fields:

<optional description>
Here you should add an optional description and links to where the user can
get more information about the measurements.

- measurement1
- field1 (type, unit)
Expand All @@ -30,16 +33,19 @@ The example plugin gathers metrics about example things

### Sample Queries:

These are some useful queries (to generate dashboards or other) to run against data from this plugin:
This section should contain some useful InfluxDB queries that can be used to
get started with the plugin or to generate dashboards. For each query listed,
describe at a high level what data is returned.

Get the max, mean, and min for the measurement in the last hour:
```
SELECT max(field1), mean(field1), min(field1) FROM measurement1 WHERE tag1=bar AND time > now() - 1h GROUP BY tag
```

### Example Output:

```
$ ./telegraf -config telegraf.conf -input-filter example -test
$ telegraf -input-filter example -test
measurement1,tag1=foo,tag2=bar field1=1i,field2=2.1 1453831884664956455
measurement2,tag1=foo,tag2=bar,tag3=baz field3=1i 1453831884664956455
```

0 comments on commit 3684ec6

Please sign in to comment.