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

Add link to CodeStyle wiki page in plugin guides

This commit is contained in:
Daniel Nelson 2018-12-28 13:02:16 -08:00
parent 60cbdcb416
commit 1d6ff4fe4c
No known key found for this signature in database
GPG Key ID: CAAD59C9444F6155
4 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/AGGREGATORS.md
View File

@ -17,6 +17,7 @@ This section is for developers who want to create a new aggregator plugin.
through it. This should be done using the builtin `HashID()` function of through it. This should be done using the builtin `HashID()` function of
each metric. each metric.
* When the `Reset()` function is called, all caches should be cleared. * When the `Reset()` function is called, all caches should be cleared.
- Follow the recommended [CodeStyle][].
### Aggregator Plugin Example ### Aggregator Plugin Example
@ -124,3 +125,4 @@ func init() {
[telegraf.Aggregator]: https://godoc.org/github.com/influxdata/telegraf#Aggregator [telegraf.Aggregator]: https://godoc.org/github.com/influxdata/telegraf#Aggregator
[SampleConfig]: https://github.com/influxdata/telegraf/wiki/SampleConfig [SampleConfig]: https://github.com/influxdata/telegraf/wiki/SampleConfig
[CodeStyle]: https://github.com/influxdata/telegraf/wiki/CodeStyle

2
docs/INPUTS.md
View File

@ -20,6 +20,7 @@ and submit new inputs.
consult the [SampleConfig][] page for the latest style consult the [SampleConfig][] page for the latest style
guidelines. 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.
- Follow the recommended [CodeStyle][].
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
current host. current host.
@ -137,6 +138,7 @@ Check the [amqp_consumer][] for an example implementation.
[prom metric types]: https://prometheus.io/docs/concepts/metric_types/ [prom metric types]: https://prometheus.io/docs/concepts/metric_types/
[input data formats]: https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md [input data formats]: https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md
[SampleConfig]: https://github.com/influxdata/telegraf/wiki/SampleConfig [SampleConfig]: https://github.com/influxdata/telegraf/wiki/SampleConfig
[CodeStyle]: https://github.com/influxdata/telegraf/wiki/CodeStyle
[telegraf.Input]: https://godoc.org/github.com/influxdata/telegraf#Input [telegraf.Input]: https://godoc.org/github.com/influxdata/telegraf#Input
[telegraf.ServiceInput]: https://godoc.org/github.com/influxdata/telegraf#ServiceInput [telegraf.ServiceInput]: https://godoc.org/github.com/influxdata/telegraf#ServiceInput
[telegraf.Accumulator]: https://godoc.org/github.com/influxdata/telegraf#Accumulator [telegraf.Accumulator]: https://godoc.org/github.com/influxdata/telegraf#Accumulator

2
docs/OUTPUTS.md
View File

@ -15,6 +15,7 @@ similar constructs.
plugin can be configured. This is included in `telegraf config`. Please plugin can be configured. This is included in `telegraf config`. Please
consult the [SampleConfig][] page for the latest style guidelines. consult the [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.
- Follow the recommended [CodeStyle][].
### Output Plugin Example ### Output Plugin Example
@ -92,4 +93,5 @@ You should also add the following to your `SampleConfig()`:
[file]: https://github.com/influxdata/telegraf/tree/master/plugins/inputs/file [file]: https://github.com/influxdata/telegraf/tree/master/plugins/inputs/file
[output data formats]: https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md [output data formats]: https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md
[SampleConfig]: https://github.com/influxdata/telegraf/wiki/SampleConfig [SampleConfig]: https://github.com/influxdata/telegraf/wiki/SampleConfig
[CodeStyle]: https://github.com/influxdata/telegraf/wiki/CodeStyle
[telegraf.Output]: https://godoc.org/github.com/influxdata/telegraf#Output [telegraf.Output]: https://godoc.org/github.com/influxdata/telegraf#Output

2
docs/PROCESSORS.md
View File

@ -16,6 +16,7 @@ This section is for developers who want to create a new processor plugin.
plugin can be configured. This is included in `telegraf config`. Please plugin can be configured. This is included in `telegraf config`. Please
consult the [SampleConfig][] page for the latest style guidelines. consult the [SampleConfig][] page for the latest style guidelines.
* The `Description` function should say in one line what this processor does. * The `Description` function should say in one line what this processor does.
- Follow the recommended [CodeStyle][].
### Processor Plugin Example ### Processor Plugin Example
@ -60,4 +61,5 @@ func init() {
``` ```
[SampleConfig]: https://github.com/influxdata/telegraf/wiki/SampleConfig [SampleConfig]: https://github.com/influxdata/telegraf/wiki/SampleConfig
[CodeStyle]: https://github.com/influxdata/telegraf/wiki/CodeStyle
[telegraf.Processor]: https://godoc.org/github.com/influxdata/telegraf#Processor [telegraf.Processor]: https://godoc.org/github.com/influxdata/telegraf#Processor