From 654b543e4e05027f13f9822629ecce063b5f0b15 Mon Sep 17 00:00:00 2001 From: Owen Diehl Date: Wed, 18 Aug 2021 11:08:15 -0400 Subject: [PATCH] updates unordered writes config docs (#4131) * updates unordered writes config docs * removes experimental flag * Apply suggestions from code review Co-authored-by: Karen Miller <84039272+KMiller-Grafana@users.noreply.github.com> Co-authored-by: Karen Miller <84039272+KMiller-Grafana@users.noreply.github.com> --- docs/sources/configuration/_index.md | 4 ++++ docs/sources/operations/ordering.md | 4 ++-- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/sources/configuration/_index.md b/docs/sources/configuration/_index.md index 0321fd8eff..ef60a4225c 100644 --- a/docs/sources/configuration/_index.md +++ b/docs/sources/configuration/_index.md @@ -1817,6 +1817,10 @@ logs in Loki. # CLI flag: -ingester.max-global-streams-per-user [max_global_streams_per_user: | default = 0] +# When true, out of order writes are accepted. +# CLI flag: -ingester.unordered-writes +[unordered_writes: | default = false] + # Maximum number of chunks that can be fetched by a single query. # CLI flag: -store.query-chunk-limit [max_chunks_per_query: | default = 2000000] diff --git a/docs/sources/operations/ordering.md b/docs/sources/operations/ordering.md index 2639068a14..23d096f017 100644 --- a/docs/sources/operations/ordering.md +++ b/docs/sources/operations/ordering.md @@ -6,7 +6,7 @@ weight: 60 Enabling out of order writes involves two configuration options in Loki: -- `ingester.unordered-writes-enabled` must be enabled +- `ingester.unordered-writes` must be enabled. This is also configurable per tenants as part of [`limits_config`](../configuration#limits_config). - `ingester.max-chunk-age` (default 1h) is used to parameterize _how far back out of order data is accepted_. -When unordered writes are enabled, Loki will accept older data for each stream as far back as `most_recent_line - (max_chunk_age/2)`. For instance, if `ingester.max-chunk-age=2h` and the stream `{foo="bar"}` has one entry at `8:00`, Loki will accept data for that stream as far back in time as `7:00`. If another log line is wrritten at `10:00`, this boundary changes to `9:00`. Anything farther back than this range will still return an _out of order_ error. +When unordered writes are enabled, Loki will accept older data for each stream as far back as `most_recent_line - (max_chunk_age/2)`. For instance, if `ingester.max-chunk-age=2h` and the stream `{foo="bar"}` has one entry at `8:00`, Loki will accept data for that stream as far back in time as `7:00`. If another log line is written at `10:00`, Loki will accept data for that stream as far back in time as `9:00`. Anything farther back will return an out of order error.