dom
/
telegraf
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Link to SampleConfig documentation in contributing guide.

This commit is contained in:
Daniel Nelson 2018-07-26 15:51:21 -07:00
parent 6e245b5483
commit 4e1a253633
No known key found for this signature in database
GPG Key ID: CAAD59C9444F6155
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
CONTRIBUTING.md
View File

@ -51,7 +51,9 @@ See below for a quick example.
* Input Plugins must be added to the * Input Plugins must be added to the
`github.com/influxdata/telegraf/plugins/inputs/all/all.go` file. `github.com/influxdata/telegraf/plugins/inputs/all/all.go` file.
* The `SampleConfig` function should return valid toml that describes how the * The `SampleConfig` function should return valid toml that describes how the
plugin can be configured. This is include in `telegraf config`. plugin can be configured. This is included in `telegraf config`. Please
consult the [SampleConfig](https://github.com/influxdata/telegraf/wiki/SampleConfig)
page for the latest style guidelines.
* The `Description` function should say in one line what this plugin does. * The `Description` function should say in one line what this plugin does.
Let's say you've written a plugin that emits metrics about processes on the Let's say you've written a plugin that emits metrics about processes on the
@ -192,7 +194,9 @@ See below for a quick example.
* To be available within Telegraf itself, plugins must add themselves to the * To be available within Telegraf itself, plugins must add themselves to the
`github.com/influxdata/telegraf/plugins/outputs/all/all.go` file. `github.com/influxdata/telegraf/plugins/outputs/all/all.go` file.
* The `SampleConfig` function should return valid toml that describes how the * The `SampleConfig` function should return valid toml that describes how the
output can be configured. This is include in `telegraf config`. plugin can be configured. This is included in `telegraf config`. Please
consult the [SampleConfig](https://github.com/influxdata/telegraf/wiki/SampleConfig)
page for the latest style guidelines.
* The `Description` function should say in one line what this output does. * The `Description` function should say in one line what this output does.
### Output Example ### Output Example