metricator/docs/CONFIGURE.md

26 lines
660 B
Markdown
Raw Permalink Normal View History

2020-12-23 21:13:56 +05:00
# Configuration
This page describes every configuration value.
## The Table
| Variable | Type | Description |
| -------- | ---- | ----------- |
| applications > APPNAME > endpoint | string | Prometheus metrics endpoint URL. |
| applications > APPNAME > headers > MAP | map | Headers which should be added to request. See example below. |
| applications > APPNAME > time_between_requests | string | time.Duration-compatible string which represents timeout between requests. |
2020-12-23 21:33:39 +05:00
Where:
* `APPNAME` is a custom name for application.
2020-12-23 21:13:56 +05:00
## Headers map example
2020-12-23 21:33:39 +05:00
```yaml
2020-12-23 21:13:56 +05:00
applications:
example:
headers:
HeaderOne: valueOne
HeaderTwo: valueTwo
```