From 4b9cc39f9f22846e09c4bd406824409e573bdc78 Mon Sep 17 00:00:00 2001 From: Travis Patterson Date: Tue, 24 Jan 2023 14:24:04 -0700 Subject: [PATCH] fix remaining docs issues (#8263) --- Makefile | 2 +- docs/sources/configuration/examples.md | 3 ++- docs/sources/operations/storage/tsdb.md | 4 ++-- 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/Makefile b/Makefile index dd12e228bb..b8bab2d8d3 100644 --- a/Makefile +++ b/Makefile @@ -761,7 +761,7 @@ validate-example-configs: loki generate-example-config-doc: echo "Removing existing doc at loki/docs/configuration/examples.md and re-generating. . ." # Title and Heading - echo -e "---\ntitle: Examples\n---\n # Loki Configuration Examples" > ./docs/sources/configuration/examples.md + echo -e "---\ntitle: Examples\ndescription: Loki Configuration Examples\n---\n # Examples" > ./docs/sources/configuration/examples.md # Append each configuration and its file name to examples.md for f in ./docs/sources/configuration/examples/*.yaml; do echo -e "\n## $$(basename $$f)\n\n\`\`\`yaml\n$$(cat $$f)\n\`\`\`\n" >> ./docs/sources/configuration/examples.md; done diff --git a/docs/sources/configuration/examples.md b/docs/sources/configuration/examples.md index 4a0ef202d9..4d51158a05 100644 --- a/docs/sources/configuration/examples.md +++ b/docs/sources/configuration/examples.md @@ -1,7 +1,8 @@ --- title: Examples +description: Loki Configuration Examples --- - # Loki Configuration Examples + # Examples ## almost-zero-dependency.yaml diff --git a/docs/sources/operations/storage/tsdb.md b/docs/sources/operations/storage/tsdb.md index b2b95ed90b..c033b956ca 100644 --- a/docs/sources/operations/storage/tsdb.md +++ b/docs/sources/operations/storage/tsdb.md @@ -75,7 +75,7 @@ We've added a user per-tenant limit called `tsdb_max_query_parallelism` in the ` ### Dynamic Query Sharding -Previously we would statically shard queries based on the index row shards configured [here]({{< relref "../../configuration/_index#period_config" >}}). +Previously we would statically shard queries based on the index row shards configured [here]({{< relref "../../configuration/#period_config" >}}). TSDB does Dynamic Query Sharding based on how much data a query is going to be processing. We additionally store size(KB) and number of lines for each chunk in the TSDB index which is then used by the [Query Frontend]({{< relref "../../fundamentals/architecture/components#query-frontend" >}}) for planning the query. Based on our experience from operating many Loki clusters, we have configured TSDB to aim for processing 300-600 MBs of data per query shard. @@ -83,4 +83,4 @@ This means with TSDB we will be running more, smaller queries. ### Index Caching not required -TSDB is a compact and optimized format. Loki does not currently use an index cache for TSDB. If you are already using Loki with other index types, it is recommended to keep the index caching until all of your existing data falls out of [retention]({{< relref "./retention" >}}) or your configured `max_query_lookback` under [limits_config]({{< relref "../../configuration/_index#limits_config" >}}). After that, we suggest running without an index cache (it isn't used in TSDB). +TSDB is a compact and optimized format. Loki does not currently use an index cache for TSDB. If you are already using Loki with other index types, it is recommended to keep the index caching until all of your existing data falls out of [retention]({{< relref "./retention" >}}) or your configured `max_query_lookback` under [limits_config]({{< relref "../../configuration/#limits_config" >}}). After that, we suggest running without an index cache (it isn't used in TSDB).