You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
cleanup docs for query_store_for_labels_enabled config (#6156)
* cleanup docs for query_store_for_labels_enabled config
Signed-off-by: Ben Ye <[email protected]>
* update doc and mention the release
Signed-off-by: Ben Ye <[email protected]>
---------
Signed-off-by: Ben Ye <[email protected]>
Find series by label matchers. Differently than Prometheus and due to scalability and performances reasons, if `-querier.query-store-for-labels-enabled` is not set or if `start` param is not specified, Cortex currently always fetches series from data stored in the ingesters.
359
-
360
-
If `-querier.query-store-for-labels-enabled` is configured, Cortex also queries the long-term store with the *blocks* storage engine.
358
+
Find series by label matchers. Starting from release v1.18.0, Cortex by default honors the `start` and `end` request parameters and fetches series from either ingester, store gateway or both. The special case is that if `start` param is not specified, Cortex currently fetches series from data stored in the ingesters.
361
359
362
360
_For more information, please check out the Prometheus [series endpoint](https://prometheus.io/docs/prometheus/latest/querying/api/#finding-series-by-label-matchers) documentation._
Get label names of ingested series. Differently than Prometheus and due to scalability and performances reasons, Cortex currently ignores the `start` and `end` request parameters and always fetches the label names from in-memory data stored in the ingesters. There is experimental support to query the long-term store with the *blocks* storage engine when `-querier.query-store-for-labels-enabled` is set.
373
+
Get label names of ingested series. Starting from release v1.18.0, Cortex by default honors the `start` and `end` request parameters and fetches label names from either ingester, store gateway or both.
376
374
377
375
_For more information, please check out the Prometheus [get label names](https://prometheus.io/docs/prometheus/latest/querying/api/#getting-label-names) documentation._
378
376
@@ -387,7 +385,7 @@ GET <prometheus-http-prefix>/api/v1/label/{name}/values
387
385
GET <legacy-http-prefix>/api/v1/label/{name}/values
388
386
```
389
387
390
-
Get label values for a given label name. Differently than Prometheus and due to scalability and performances reasons, Cortex currently ignores the `start` and `end` request parameters and always fetches the label values from in-memory data stored in the ingesters. There is experimental support to query the long-term store with the *blocks* storage engine when `-querier.query-store-for-labels-enabled` is set.
388
+
Get label values for a given label name. Starting from release v1.18.0, Cortex by default honors the `start` and `end` request parameters and fetches label values from either ingester, store gateway or both.
391
389
392
390
_For more information, please check out the Prometheus [get label values](https://prometheus.io/docs/prometheus/latest/querying/api/#querying-label-values) documentation._
Copy file name to clipboardExpand all lines: docs/configuration/v1-guarantees.md
-2Lines changed: 0 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,6 @@ The Cortex maintainers commit to ensuring future version of Cortex can read data
23
23
24
24
Cortex strives to be 100% API compatible with Prometheus (under `/prometheus/*` and `/api/prom/*`); any deviation from this is considered a bug, except:
25
25
26
-
- For queries to the `/api/v1/series`, `/api/v1/labels` and `/api/v1/label/{name}/values` endpoints, query's time range is ignored and the data is always fetched from ingesters. There is experimental support to query the long-term store with the *blocks* storage engine when `-querier.query-store-for-labels-enabled` is set.
27
26
- Additional API endpoints for creating, removing and modifying alerts and recording rules.
28
27
- Additional API around pushing metrics (under `/api/push`).
29
28
- Additional API endpoints for management of Cortex itself, such as the ring. These APIs are not part of the any compatibility guarantees.
@@ -53,7 +52,6 @@ Currently experimental features are:
53
52
- OpenStack Swift storage support.
54
53
- Metric relabeling in the distributor.
55
54
- Scalable query-frontend (when using query-scheduler)
56
-
- Querying store for series, labels APIs (`-querier.query-store-for-labels-enabled`)
57
55
- Ingester: do not unregister from ring on shutdown (`-ingester.unregister-on-shutdown=false`)
58
56
- Distributor: do not extend writes on unhealthy ingesters (`-distributor.extend-writes=false`)
Copy file name to clipboardExpand all lines: docs/guides/limitations.md
-4Lines changed: 0 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,7 +35,3 @@ All other characters are not safe to use. In particular, slashes `/` and whitesp
35
35
### Length
36
36
37
37
The tenant ID length should not exceed 150 bytes/characters.
38
-
39
-
## Query series and labels
40
-
41
-
When running queries to the `/api/v1/series`, `/api/v1/labels` and `/api/v1/label/{name}/values` endpoints, query's time range is ignored and the data is always fetched from ingesters. There is experimental support to query the long-term store with the *blocks* storage engine when `-querier.query-store-for-labels-enabled` is set.
0 commit comments