- 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.
Public interfaces for inputs, outputs, processors, aggregators, metrics, and the accumulator can be found in the GoDoc:
Adding a dependency:
Assuming you can already build the project, run these in the telegraf directory:
dep ensure -vendor-onlydep ensure -add github.com/[dependency]/[new-package]
Unit Tests:
Before opening a pull request you should run the linter checks and the short tests.
Run static analysis:
make check
Run short tests:
make test
Execute integration tests:
Running the integration tests requires several docker containers to be running. You can start the containers with:
docker-compose up
And run the full test suite with:
make test-all
Use make docker-kill to stop the containers.