Add a check-list for new SD's (#7634)

Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
This commit is contained in:
Julien Pivotto 2020-07-22 00:07:33 +02:00 committed by GitHub
parent 38fec5345d
commit 52cdcc2a3b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -216,4 +216,16 @@ If all the targets in a group go away, we need to send the target groups with em
```
down the channel.
### New Service Discovery Check List
Here are some non-obvious parts of adding service discoveries that need to be verified:
- Check for `nil` SDConfigs in `discovery/config/config.go`.
- Validate that discovery configs can be DeepEqualled by adding them to
`config/testdata/conf.good.yml` and to the associated tests.
- If there is a TLSConfig or HTTPClientConfig, add them to
`resolveFilepaths` in `config/config.go`.
- List the service discovery in both `<scrape_config>` and
`<alertmanager_config>` in `docs/configuration/configuration.md`.
<!-- TODO: Add best-practices -->