Skip to content

Commit 2177ec0

Browse files
authored
Downstream url documentation (#4570)
Adds some documentation about downstream_url config in Frontend. Fixes #3039
1 parent aca36e5 commit 2177ec0

File tree

3 files changed

+5
-4
lines changed

3 files changed

+5
-4
lines changed

docs/architecture.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -214,6 +214,8 @@ Flow of the query in the system when using query-frontend:
214214
3) Querier picks up the query, and executes it.
215215
4) Querier sends result back to query-frontend, which then forwards it to the client.
216216

217+
Query frontend can also be used with any Prometheus-API compatible service. In this mode Cortex can be used as an query accelerator with it's caching and splitting features on other prometheus query engines like Thanos Querier or your own Prometheus server. Query frontend needs to be configured with downstream url address(via the `-frontend.downstream-url` CLI flag), which is the endpoint of the prometheus server intended to be connected with Cortex.
218+
217219
#### Queueing
218220

219221
The query frontend queuing mechanism is used to:

docs/configuration/prometheus-frontend.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,6 @@ frontend:
6666
log_queries_longer_than: 1s
6767
compress_responses: true
6868

69-
# The Prometheus URL to which the query-frontend should connect to.
69+
# The query endpoint URL of a Prometheus-API compatible service to which the query-frontend should connect to.
7070
downstream_url: http://prometheus.mydomain.com
7171
```

docs/configuration/prometheus-frontend.yml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ query_range:
2222

2323
results_cache:
2424
cache:
25-
2625
# We're going to use the in-process "FIFO" cache, but you can enable
2726
# memcached below.
2827
enable_fifocache: true
@@ -32,7 +31,7 @@ query_range:
3231

3332
# If you want to use a memcached cluster, you can either configure a
3433
# headless service in Kubernetes and Cortex will discover the individual
35-
# instances using a SRV DNS query (host) or list comma separated
34+
# instances using a SRV DNS query (host) or list comma separated
3635
# memcached addresses.
3736
# host + service: this is the config you should set when you use the
3837
# SRV DNS (this is considered stable)
@@ -54,5 +53,5 @@ frontend:
5453
log_queries_longer_than: 1s
5554
compress_responses: true
5655

57-
# The Prometheus URL to which the query-frontend should connect to.
56+
# The query endpoint URL of a Prometheus-API compatible service to which the query-frontend should connect to.
5857
downstream_url: http://prometheus.mydomain.com

0 commit comments

Comments
 (0)