Telegraf Plugin Documentation - Edit in Source Repository
The Telegraf plugin documentation in subdirectories (input-plugins/, output-plugins/, aggregator-plugins/, processor-plugins/) is generated from plugin READMEs in the influxdata/telegraf repository.
Workflow
- Source of truth: Plugin READMEs in
telegraf/plugins/<type>/<plugin>/README.md - Automated sync: The
telegraf-internalrepository generates documentation PRs from plugin READMEs - Release process: Telegraf releases automatically trigger documentation updates
To Make Changes
- Edit the source README in the
telegrafrepository:plugins/<type>/<plugin>/README.md - Submit a PR to
influxdata/telegraf - After merge, the sync process will create a PR to docs-v2
Plugin Types and Locations
| Directory | Source Location |
|---|---|
input-plugins/ | telegraf/plugins/inputs/<plugin>/README.md |
output-plugins/ | telegraf/plugins/outputs/<plugin>/README.md |
aggregator-plugins/ | telegraf/plugins/aggregators/<plugin>/README.md |
processor-plugins/ | telegraf/plugins/processors/<plugin>/README.md |
Documentation
- Telegraf repository: https://github.com/influxdata/telegraf
- Contributing guide: https://github.com/influxdata/telegraf/blob/master/CONTRIBUTING.md
Non-Generated Content
The following files in content/telegraf/ are not generated and can be edited directly:
_index.mdconfiguration.mdinstall.mdget-started.mdmetrics.mdrelease-notes.md- Other top-level documentation files
Was this page helpful?
Thank you for your feedback!
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for Telegraf and this documentation. To find support, use the following resources:
Customers with an annual or support contract can contact InfluxData Support.