From 85e111575a9fccd8f3bfce60ff56feddbc79ca3b Mon Sep 17 00:00:00 2001 From: Kevin Burek Date: Wed, 18 Oct 2023 16:12:56 -0400 Subject: [PATCH] Document `offset` modifier Bring back offset modifier doc section from https://github.com/grafana/loki/pull/3455 and lost in https://github.com/grafana/loki/pull/4012 --- docs/sources/query/metric_queries.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/sources/query/metric_queries.md b/docs/sources/query/metric_queries.md index 5501d2539cd37..ca4fe38b09cae 100644 --- a/docs/sources/query/metric_queries.md +++ b/docs/sources/query/metric_queries.md @@ -57,6 +57,15 @@ Examples: sum by (host) (rate({job="mysql"} |= "error" != "timeout" | json | duration > 10s [1m])) ``` +#### Offset modifier +The offset modifier allows changing the time offset for individual range vectors in a query. + +For example, the following expression counts all the logs within the last ten minutes to five minutes rather than last five minutes for the MySQL job. Note that the `offset` modifier always needs to follow the range vector selector immediately. +```logql +count_over_time({job="mysql"}[5m] offset 5m) // GOOD +count_over_time({job="mysql"}[5m]) offset 5m // INVALID +``` + ### Unwrapped range aggregations Unwrapped ranges uses extracted labels as sample values instead of log lines. However to select which label will be used within the aggregation, the log query must end with an unwrap expression and optionally a label filter expression to discard [errors]({{< relref ".#pipeline-errors" >}}).