Contributing to Telegraf
There are many ways to get involved in the Telegraf project! From opening issues, creating pull requests, to joining the conversation in Slack. We would love to see you contribute your expertise and join our community. To get started review this document to learn best practices.
Before you file an issue, please search existing issues in case it has already been filed, or perhaps even fixed. If you file an issue, please ensure you include all the requested details (e.g. Telegraf config and logs, platform, etc.)
Please note that issues are not the place to file general support requests such as "How do I use the mongoDB plugin?" Questions of this nature should be sent to the Community Slack or Community Page, not filed as issues.
We really like to receive feature requests as it helps us prioritize our work. Before you file a feature request, please search existing issues, you can filter issues that have the label
feature request. Please be clear about your requirements and goals, help us to understand what you would like to see added to Telegraf with examples and the reasons why it is important to you. If you find your feature request already exists as a Github issue please indicate your support for that feature by using the "thumbs up" reaction.
Creating a pull request
- Sign the CLA.
- Open a new issue to discuss the changes you would like to make. This is not strictly required but it may help reduce the amount of rework you need to do later.
- Make changes or write plugin using the guidelines in the following documents:
- Ensure you have added proper unit tests and documentation.
- Open a new pull request.
- The pull request title needs to follow conventional commit format
Note: If you have a pull request with only one commit, then that commit needs to follow the conventional commit format or the
Semantic Pull Request check will fail. This is because github will use the pull request title if there are multiple commits, but if there is only one commit it will use it instead.
When will your contribution get released?
We have two kinds of releases: patch releases, which happen every few weeks, and feature releases, which happen once a quarter. If your fix is a bug fix, it will be released in the next patch release after it is merged to master. If your release is a new plugin or other feature, it will be released in the next quarterly release after it is merged to master. Quarterly releases are on the third Wednesday of March, June, September, and December.
Contributing an External Plugin
Input, output, and processor plugins written for internal Telegraf can be run as externally-compiled plugins through the Execd Input, Execd Output, and Execd Processor Plugins without having to change the plugin code.
Follow the guidelines of how to integrate your plugin with the Execd Go Shim to easily compile it as a separate app and run it with the respective
Check out our guidelines on how to build and set up your external plugins to run with
Security Vulnerability Reporting
InfluxData takes security and our users' trust very seriously. If you believe you have found a security issue in any of our open source projects, please responsibly disclose it by contacting email@example.com. More details about security vulnerability reporting, including our GPG key, can be found here.
Common development tasks
Adding a dependency:
Telegraf uses Go modules. Assuming you can already build the project, run this in the telegraf directory:
go get github.com/[dependency]/[new-package]
Before opening a pull request you should run the following checks to make sure the CI will pass.
make check make check-deps make test make docs
Execute integration tests:
To run only the integration tests use:
To run the full test suite use: