Contribute to Telegraf

There are many ways to contribute to InfluxData open source products. Whether you want to report a bug, write a plugin, or answer support questions, the following sections will guide you through the process.

• Open GitHub issues
  • File bug reports
  • Open feature requests
  • Ask or answer support questions
• Contribute code
  • Create a pull request
  • Contribute an external plugin
• Report security vulnerabilities

Open GitHub issues

File bug reports

1. Search Telegraf GitHub issues for related issues that are open or have been fixed.
2. If an issue does not already exist, create a new bug report issue.
3. Include all the requested details.

{{% note %}} Do not open general support requests as GitHub issues. Support-related questions should be directed to the InfluxDB Community Slack or InfluxData Community forum. {{% /note %}}

Open feature requests

Feature requests help to prioritize work. To submit a feature request:

1. Search Telegraf GitHub issues for issues related your feature request. Use the feature request label to filter issues by feature requests.
2. If an issue related to your feature request already exists, indicate your support for that feature by using the thumbs up reaction and add a comment explaining your use case for the feature.
3. If a feature request does not already exist, create a new feature request issue. Include the following with your feature request
4. Include all the requested details.

Ask or answer support questions

Post support questions to InfluxDB Community Slack or InfluxData Community forum.

Contribute code

Create a pull request

1. Sign the InfluxData CLA.

2. 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.

3. Make changes or write plugins using the following plugin guidelines:

   • Input Plugins
   • Processor Plugins
   • Aggregator Plugins
   • Output Plugins

4. Include unit tests and documentation for your change.

5. Open a new pull request. The pull request title needs to follow the conventional commit format.

{{% note %}} If you have a pull request with only one commit, the commit message must follow the conventional commit format, otherwise the Semantic Pull Request check will fail. For single-commit pull requests, GitHub uses the commit message as the default pull request title. {{% /note %}}

Contribute an external plugin

Input, output, and processor plugins written for 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.

For more information, see:

• Execd Go Shim: Use the Go execd shim to compile your plugin as a separate app and run it with the respective execd plugin.
• Write an external plugin: Build and set up external plugins to run with execd.

Report security vulnerabilities

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 protected]. For more information about reporting security vulnerabilities, including our GPG key, see How to report security vulnerabilities.