99 lines
2.9 KiB
Markdown
99 lines
2.9 KiB
Markdown
### Contributing
|
|
|
|
1. [Sign the CLA][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 plugin using the guidelines in the following
|
|
documents:
|
|
- [Input Plugins][inputs]
|
|
- [Processor Plugins][processors]
|
|
- [Aggregator Plugins][aggregators]
|
|
- [Output Plugins][outputs]
|
|
4. Ensure you have added proper unit tests and documentation.
|
|
5. Open a new [pull request][].
|
|
6. The pull request title needs to follow [conventional commit format](https://www.conventionalcommits.org/en/v1.0.0/#summary)
|
|
|
|
|
|
#### 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 security@influxdata.com. More details about
|
|
security vulnerability reporting,
|
|
including our GPG key, [can be found here](https://www.influxdata.com/how-to-report-security-vulnerabilities/).
|
|
|
|
### GoDoc
|
|
|
|
Public interfaces for inputs, outputs, processors, aggregators, metrics,
|
|
and the accumulator can be found in the GoDoc:
|
|
|
|
[](https://godoc.org/github.com/influxdata/telegraf)
|
|
|
|
### Common development tasks
|
|
|
|
**Adding a dependency:**
|
|
|
|
Telegraf uses Go modules. Assuming you can already build the project, run this in the telegraf directory:
|
|
|
|
1. `go get github.com/[dependency]/[new-package]`
|
|
|
|
**Unit Tests:**
|
|
|
|
Before opening a pull request you should run the linter checks and
|
|
the short tests.
|
|
|
|
```
|
|
make check
|
|
make test
|
|
```
|
|
|
|
**Execute integration tests:**
|
|
|
|
(Optional)
|
|
|
|
Running the integration tests requires several docker containers to be
|
|
running. You can start the containers with:
|
|
```
|
|
docker-compose up
|
|
```
|
|
|
|
To run only the integration tests use:
|
|
|
|
```
|
|
make test-integration
|
|
```
|
|
|
|
To run the full test suite use:
|
|
```
|
|
make test-all
|
|
```
|
|
|
|
Use `make docker-kill` to stop the containers.
|
|
|
|
### For more developer resources
|
|
- [Code Style][codestyle]
|
|
- [Deprecation][deprecation]
|
|
- [Logging][logging]
|
|
- [Metric Format Changes][metricformat]
|
|
- [Packaging][packaging]
|
|
- [Logging][logging]
|
|
- [Packaging][packaging]
|
|
- [Profiling][profiling]
|
|
- [Reviews][reviews]
|
|
- [Sample Config][sample config]
|
|
|
|
[cla]: https://www.influxdata.com/legal/cla/
|
|
[new issue]: https://github.com/influxdata/telegraf/issues/new/choose
|
|
[pull request]: https://github.com/influxdata/telegraf/compare
|
|
[inputs]: /docs/INPUTS.md
|
|
[processors]: /docs/PROCESSORS.md
|
|
[aggregators]: /docs/AGGREGATORS.md
|
|
[outputs]: /docs/OUTPUTS.md
|
|
[codestyle]: /docs/developers/CODE_STYLE.md
|
|
[deprecation]: /docs/developers/DEPRECATION.md
|
|
[logging]: /docs/developers/LOGGING.md
|
|
[metricformat]: /docs/developers/METRIC_FORMAT_CHANGES.md
|
|
[packaging]: /docs/developers/PACKAGING.md
|
|
[profiling]: /docs/developers/PROFILING.md
|
|
[reviews]: /docs/developers/REVIEWS.md
|
|
[sample config]: /docs/developers/SAMPLE_CONFIG.md
|