CL-Softwares
/
telegraf
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Redirect former wiki links (#9183) 

* fix docs links

* redirect links

* redirect links

* redirect links

* redirect links
This commit is contained in:
Samantha Wang 2021-05-07 12:26:11 -07:00 committed by GitHub
parent 1482246902
commit 3e9f191142
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/AGGREGATORS.md
View File

@ -11,13 +11,13 @@ This section is for developers who want to create a new aggregator plugin.
`github.com/influxdata/telegraf/plugins/aggregators/all/all.go` file. `github.com/influxdata/telegraf/plugins/aggregators/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 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 [Sample Config][] page for the latest style guidelines.
* The `Description` function should say in one line what this aggregator does. * The `Description` function should say in one line what this aggregator does.
* The Aggregator plugin will need to keep caches of metrics that have passed * The Aggregator plugin will need to keep caches of metrics that have passed
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][]. - Follow the recommended [Code Style][].
### Aggregator Plugin Example ### Aggregator Plugin Example
@ -128,5 +128,5 @@ 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 [Sample Config]: https://github.com/influxdata/telegraf/blob/master/docs/developers/SAMPLE_CONFIG.md
[CodeStyle]: https://github.com/influxdata/telegraf/wiki/CodeStyle [Code Style]: https://github.com/influxdata/telegraf/blob/master/docs/developers/CODE_STYLE.md

8
docs/INPUTS.md
View File

@ -17,10 +17,10 @@ and submit new inputs.
`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 included in `telegraf config`. Please plugin can be configured. This is included in `telegraf config`. Please
consult the [SampleConfig][] page for the latest style consult the [Sample Config][] 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][]. - Follow the recommended [Code Style][].
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.
@ -143,8 +143,8 @@ Check the [amqp_consumer][] for an example implementation.
[amqp_consumer]: https://github.com/influxdata/telegraf/tree/master/plugins/inputs/amqp_consumer [amqp_consumer]: https://github.com/influxdata/telegraf/tree/master/plugins/inputs/amqp_consumer
[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 [Sample Config]: https://github.com/influxdata/telegraf/blob/master/docs/developers/SAMPLE_CONFIG.md
[CodeStyle]: https://github.com/influxdata/telegraf/wiki/CodeStyle [Code Style]: https://github.com/influxdata/telegraf/blob/master/docs/developers/CODE_STYLE.md
[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

8
docs/OUTPUTS.md
View File

@ -13,9 +13,9 @@ similar constructs.
`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
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 [Sample Config][] 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][]. - Follow the recommended [Code Style][].
### Output Plugin Example ### Output Plugin Example
@ -115,6 +115,6 @@ or investigate other reasons why the writes might be taking longer than expected
[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 [Sample Config]: https://github.com/influxdata/telegraf/blob/master/docs/developers/SAMPLE_CONFIG.md
[CodeStyle]: https://github.com/influxdata/telegraf/wiki/CodeStyle [Code Style]: https://github.com/influxdata/telegraf/blob/master/docs/developers/CODE_STYLE.md
[telegraf.Output]: https://godoc.org/github.com/influxdata/telegraf#Output [telegraf.Output]: https://godoc.org/github.com/influxdata/telegraf#Output

8
docs/PROCESSORS.md
View File

@ -14,9 +14,9 @@ This section is for developers who want to create a new processor plugin.
config`. config`.
- 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 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 [Sample Config][] 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][]. - Follow the recommended [Code Style][].
### Processor Plugin Example ### Processor Plugin Example
@ -160,7 +160,7 @@ func init() {
} }
``` ```
[SampleConfig]: https://github.com/influxdata/telegraf/wiki/SampleConfig [Sample Config]: https://github.com/influxdata/telegraf/blob/master/docs/developers/SAMPLE_CONFIG.md
[CodeStyle]: https://github.com/influxdata/telegraf/wiki/CodeStyle [Code Style]: https://github.com/influxdata/telegraf/blob/master/docs/developers/CODE_STYLE.md
[telegraf.Processor]: https://godoc.org/github.com/influxdata/telegraf#Processor [telegraf.Processor]: https://godoc.org/github.com/influxdata/telegraf#Processor
[telegraf.StreamingProcessor]: https://godoc.org/github.com/influxdata/telegraf#StreamingProcessor [telegraf.StreamingProcessor]: https://godoc.org/github.com/influxdata/telegraf#StreamingProcessor

4
docs/maintainers/PULL_REQUESTS.md
View File

@ -19,7 +19,7 @@ contributor to merge or rebase.
## Review ## Review
[Review the pull request](Review). [Review the pull request](docs/developers/REVIEWS.md).
## Merge ## Merge
@ -53,7 +53,7 @@ message. If applicable mention the plugin in the message.
## After Merge ## After Merge
[Update the Changelog](Changelog). [Update the Changelog](https://github.com/influxdata/telegraf/blob/master/docs/maintainers/CHANGELOG.md).
If required, backport the patch and the changelog update to the current If required, backport the patch and the changelog update to the current
release branch. Usually this can be done by cherry picking the commits: release branch. Usually this can be done by cherry picking the commits: