Commit 5f38896b authored by beorn7's avatar beorn7

Merge branch 'next-release'

This is for the 1.6 release of the Prometheus server.
parents b602ec32 4e15503b
......@@ -71,6 +71,35 @@ The [Pushgateway](../../instrumenting/pushing/) persists the most recent push
of metrics from batch jobs. This allows Prometheus to scrape their metrics
after they have terminated.
### Remote Read
Remote read is a Prometheus feature that allows transparent reading of time series from
other systems (such as long term storage) as part of queries.
### Remote Read Adapter
Not all systems directly support remote read. A remote read adapter sits between
Prometheus and another system, converting time series requests and responses between them.
### Remote Read Endpoint
A remote read endpoint is what Prometheus talks to when doing a remote read.
### Remote Write
Remote write is a Prometheus feature that allows sending ingested samples on the
fly to other systems, such as long term storage.
### Remote Write Adapter
Not all systems directly support remote write. A remote write adapter sits
between Prometheus and another system, converting the samples in the remote
write into a format the other system can understand.
### Remote Write Endpoint
A remote write endpoint is what Prometheus talks to when doing a remote write.
### Silence
A silence in the Alertmanager prevents alerts with labels matching the silence from
......
......@@ -85,16 +85,11 @@ alerting:
# 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> ... ]
[ - <remote_write> ... ]
# Settings related to the experimental remote read feature.
remote_read:
[ - <remote_read> ... ]
```
### `<scrape_config>`
......@@ -448,8 +443,6 @@ files:
Where `<filename_pattern>` may be a path ending in `.json`, `.yml` or `.yaml`. The last path segment
may contain a single `*` that matches any character sequence, e.g. `my/path/tg_*.json`.
NOTE: Prior to v0.20, `names:` was used instead of `files:`.
### `<gce_sd_config>`
CAUTION: GCE SD is in beta: breaking changes to configuration are still
......@@ -662,6 +655,14 @@ See below for the configuration options for Marathon discovery:
servers:
- <string>
# Optional bearer token authentication information.
# It is mutually exclusive with `bearer_token_file`.
[ bearer_token: <string> ]
# Optional bearer token file authentication information.
# It is mutually exclusive with `bearer_token`.
[ bearer_token_file: <filename> ]
# Polling interval
[ refresh_interval: <duration> | default = 30s ]
```
......@@ -983,16 +984,77 @@ relabel_configs:
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.
`write_relabel_configs` is relabeling applied to samples before sending them
to the remote endpoint. Write relabeling 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.
```
# The URL of the endpoint to send samples to.
url: <string>
# Timeout for requests to the remote write endpoint.
[ remote_timeout: <duration> | default = 30s ]
# List of remote write relabel configurations.
write_relabel_configs:
[ - <relabel_config> ... ]
# Sets the `Authorization` header on every remote write request with the
# configured username and password.
basic_auth:
[ username: <string> ]
[ password: <string> ]
# Sets the `Authorization` header on every remote write request with
# the configured bearer token. It is mutually exclusive with `bearer_token_file`.
[ bearer_token: <string> ]
# Sets the `Authorization` header on every remote write request with the bearer token
# read from the configured file. It is mutually exclusive with `bearer_token`.
[ bearer_token_file: /path/to/bearer/token/file ]
# Configures the remote write request's TLS settings.
tls_config:
[ <tls_config> ]
# Optional proxy URL.
[ proxy_url: <string> ]
```
### `<remote_read>`
CAUTION: Remote read is experimental: breaking changes to configuration are
likely in future releases.
```
# The URL of the endpoint to query from.
url: <string>
# Timeout for requests to the remote read endpoint.
[ remote_timeout: <duration> | default = 30s ]
# Sets the `Authorization` header on every remote read request with the
# configured username and password.
basic_auth:
[ username: <string> ]
[ password: <string> ]
# Sets the `Authorization` header on every remote read request with
# the configured bearer token. It is mutually exclusive with `bearer_token_file`.
[ bearer_token: <string> ]
# Sets the `Authorization` header on every remote read request with the bearer token
# read from the configured file. It is mutually exclusive with `bearer_token`.
[ bearer_token_file: /path/to/bearer/token/file ]
# Configures the remote read request's TLS settings.
tls_config:
[ <tls_config> ]
# Optional proxy URL.
[ proxy_url: <string> ]
```
This diff is collapsed.
......@@ -71,6 +71,8 @@ URL query parameters:
- `query=<string>`: Prometheus expression query string.
- `time=<rfc3339 | unix_timestamp>`: Evaluation timestamp. Optional.
- `timeout=<duration>`: Evaluation timeout. Optional. Defaults to and
is capped by the value of the `-query.timeout` flag.
The current server time is used if the `time` parameter is omitted.
......@@ -132,6 +134,8 @@ URL query parameters:
- `start=<rfc3339 | unix_timestamp>`: Start timestamp.
- `end=<rfc3339 | unix_timestamp>`: End timestamp.
- `step=<duration>`: Query resolution step width.
- `timeout=<duration>`: Evaluation timeout. Optional. Defaults to and
is capped by the value of the `-query.timeout` flag.
The `data` section of the query result has the following format:
......
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