Commit 7ed56c13 authored by Julius Volz's avatar Julius Volz Committed by GitHub

Merge pull request #599 from prometheus/write

Document remote write config.
parents df201039 9b103d30
...@@ -99,6 +99,3 @@ DEPENDENCIES ...@@ -99,6 +99,3 @@ DEPENDENCIES
rb-inotify rb-inotify
redcarpet redcarpet
rspec rspec
BUNDLED WITH
1.11.2
...@@ -75,6 +75,19 @@ scrape_configs: ...@@ -75,6 +75,19 @@ scrape_configs:
alerting: alerting:
alert_relabel_configs: alert_relabel_configs:
[ - <relabel_config> ... ] [ - <relabel_config> ... ]
# Settings related to the experimental remote write feature.
remote_write:
[ url: <string> ]
[ remote_timeout: <duration> | default = 30s ]
tls_config:
[ <tls_config> ]
[ proxy_url: <string> ]
basic_auth:
[ username: <string> ]
[ password: <string> ]
write_relabel_configs:
[ - <relabel_config> ... ]
``` ```
...@@ -776,3 +789,21 @@ relabeling is applied after external labels. ...@@ -776,3 +789,21 @@ relabeling is applied after external labels.
One use for this is ensuring a HA pair of Prometheus servers with different One use for this is ensuring a HA pair of Prometheus servers with different
external labels send identical alerts. external labels send identical alerts.
### `<remote_write>`
CAUTION: Remote write is experimental: breaking changes to configuration are
likely in future releases.
`url` is the URL of the endpoint to send samples to. `remote_timeout` specifies
the timeout for sending requests to the URL. There are no retries.
`basic_auth`, `tls_config` and `proxy_url` have the same meanings as in a
`scrape_config`.
`write_relabel_configs` is relabelling applied to samples before sending them
to the URL. Write relabelling is applied after external labels. This could be
used to limit which samples are sent.
There is a [small
demo](https://github.com/prometheus/prometheus/tree/master/documentation/examples/remote_storage)
of how to use this functionality.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment