From 0511d5c3a045f15eb54b84e5ded7ec6085d83036 Mon Sep 17 00:00:00 2001 From: Aliaksandr Valialkin <valyala@victoriametrics.com> Date: Thu, 8 Feb 2024 18:32:22 +0200 Subject: [PATCH] docs/Cluster-VictoriaMetrics.md: document that /api/v1/query?series_lector[d] returns raw samples Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1148 --- docs/Cluster-VictoriaMetrics.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/Cluster-VictoriaMetrics.md b/docs/Cluster-VictoriaMetrics.md index d8fb31d91c..6dd4c3d81e 100644 --- a/docs/Cluster-VictoriaMetrics.md +++ b/docs/Cluster-VictoriaMetrics.md @@ -597,7 +597,15 @@ The cluster works in the following way when some of `vmstorage` nodes are unavai It is also possible to configure independent replication factor per distinct `vmstorage` groups - see [these docs](#vmstorage-groups-at-vmselect). -`vmselect` doesn't serve partial responses for API handlers returning raw datapoints - [`/api/v1/export*` endpoints](https://docs.victoriametrics.com/#how-to-export-time-series), since users usually expect this data is always complete. +`vmselect` doesn't serve partial responses for API handlers returning [raw datapoints](https://docs.victoriametrics.com/keyconcepts/#raw-samples), +since users usually expect this data is always complete. The following handlers return raw samples: + +- [`/api/v1/export*` endpoints](https://docs.victoriametrics.com/#how-to-export-time-series) +- [`/api/v1/query`](https://docs.victoriametrics.com/url-examples/#apiv1query) when the `query` contains [series selector](https://docs.victoriametrics.com/keyconcepts/#filtering) + ending with some duration in square brackets. For example, `/api/v1/query?query=up[1h]&time=2024-01-02T03:00:00Z`. + This query returns [raw samples](https://docs.victoriametrics.com/keyconcepts/#raw-samples) for [time series](https://docs.victoriametrics.com/keyconcepts/#time-series) + with the `up` name on the time range `(2024-01-02T02:00:00 .. 2024-01-02T03:00:00]`. See [this article](https://valyala.medium.com/analyzing-prometheus-data-with-external-tools-5f3e5e147639) + for details. Data replication can be used for increasing storage durability. See [these docs](#replication-and-data-safety) for details.