From 021a7fdc33e7700a8757257aeab2663396ba4e1c Mon Sep 17 00:00:00 2001 From: Kristian Klausen Date: Thu, 8 Jul 2021 15:39:27 +0200 Subject: [PATCH] Doc: Remove removed --ingester.recover-from-wal option and fix out-of-date defaults (#3559) * Doc: Remove removed --ingester.recover-from-wal option Removed in: 8a9b94a8 ("removes recover flag (#3326)") * Doc: Fix out-of-date defaults 0b1dbe26 ("Promtail: Add a stream lagging metric (#2618)") d3bf21e7 ("Promtail: (and also fluent-bit) change the max batch size to 1MB (#2710)") --- docs/sources/clients/aws/eks/values.yaml | 8 ++++---- docs/sources/clients/docker-driver/configuration.md | 6 +++--- docs/sources/clients/promtail/configuration.md | 2 +- docs/sources/operations/storage/wal.md | 2 -- 4 files changed, 8 insertions(+), 10 deletions(-) diff --git a/docs/sources/clients/aws/eks/values.yaml b/docs/sources/clients/aws/eks/values.yaml index 966e679220..927ac9857e 100644 --- a/docs/sources/clients/aws/eks/values.yaml +++ b/docs/sources/clients/aws/eks/values.yaml @@ -160,18 +160,18 @@ config: # Maximum wait period before sending batch batchwait: 1s # Maximum batch size to accrue before sending, unit is byte - batchsize: 102400 + batchsize: 1048576 # Maximum time to wait for server to respond to a request timeout: 10s backoff_config: # Initial backoff time between retries - min_period: 100ms + min_period: 500ms # Maximum backoff time between retries - max_period: 5s + max_period: 5m # Maximum number of retries when sending batches, 0 means infinite retries - max_retries: 20 + max_retries: 10 # The labels to add to any time series or alerts when communicating with loki external_labels: {} diff --git a/docs/sources/clients/docker-driver/configuration.md b/docs/sources/clients/docker-driver/configuration.md index b7b56f31bf..cfe6a6bf3d 100644 --- a/docs/sources/clients/docker-driver/configuration.md +++ b/docs/sources/clients/docker-driver/configuration.md @@ -201,9 +201,9 @@ To specify additional logging driver options, you can use the --log-opt NAME=VAL | `loki-external-labels` | No | `container_name={{.Name}}` | Additional label value pair separated by `,` to send with logs. The value is expanded with the [Docker tag template format](https://docs.docker.com/config/containers/logging/log_tags/). (eg: `container_name={{.ID}}.{{.Name}},cluster=prod`) | | `loki-timeout` | No | `10s` | The timeout to use when sending logs to the Loki instance. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". | | `loki-batch-wait` | No | `1s` | The amount of time to wait before sending a log batch complete or not. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". | -| `loki-batch-size` | No | `102400` | The maximum size of a log batch to send. | -| `loki-min-backoff` | No | `100ms` | The minimum amount of time to wait before retrying a batch. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". | -| `loki-max-backoff` | No | `10s` | The maximum amount of time to wait before retrying a batch. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". | +| `loki-batch-size` | No | `1048576` | The maximum size of a log batch to send. | +| `loki-min-backoff` | No | `500ms` | The minimum amount of time to wait before retrying a batch. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". | +| `loki-max-backoff` | No | `5m` | The maximum amount of time to wait before retrying a batch. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". | | `loki-retries` | No | `10` | The maximum amount of retries for a log batch. | | `loki-pipeline-stage-file` | No | | The location of a pipeline stage configuration file ([example](https://github.com/grafana/loki/blob/master/cmd/docker-driver/pipeline-example.yaml)). Pipeline stages allows to parse log lines to extract more labels, [see associated documentation](../promtail/pipelines.md). | | `loki-pipeline-stages` | No | | The pipeline stage configuration provided as a string [see pipeline stages](#pipeline-stages) and [associated documentation](../promtail/stages/). | diff --git a/docs/sources/clients/promtail/configuration.md b/docs/sources/clients/promtail/configuration.md index 36cb3cf443..4a87088f34 100644 --- a/docs/sources/clients/promtail/configuration.md +++ b/docs/sources/clients/promtail/configuration.md @@ -177,7 +177,7 @@ url: # Maximum batch size (in bytes) of logs to accumulate before sending # the batch to Loki. -[batchsize: | default = 102400] +[batchsize: | default = 1048576] # If using basic auth, configures the username and password # sent. diff --git a/docs/sources/operations/storage/wal.md b/docs/sources/operations/storage/wal.md index 93f5df18d1..718a9028f4 100644 --- a/docs/sources/operations/storage/wal.md +++ b/docs/sources/operations/storage/wal.md @@ -41,8 +41,6 @@ The WAL also includes a backpressure mechanism to allow a large WAL to be replay * `--ingester.wal-enabled` to `true` which enables writing to WAL during ingestion. * `--ingester.wal-dir` to the directory where the WAL data should be stored and/or recovered from. Note that this should be on the mounted volume. * `--ingester.checkpoint-duration` to the interval at which checkpoints should be created. - * `--ingester.recover-from-wal` to `true` to recover data from an existing WAL. The data is recovered even if WAL is disabled and this is set to `true`. The WAL dir needs to be set for this. - * If you are going to enable WAL, it is advisable to always set this to `true`. * `--ingester.wal-replay-memory-ceiling` (default 4GB) may be set higher/lower depending on your resource settings. It handles memory pressure during WAL replays, allowing a WAL many times larger than available memory to be replayed. This is provided to minimize reconciliation time after very bad situations, i.e. an outage, and will likely not impact regular operations/rollouts _at all_. We suggest setting this to a high percentage (~75%) of available memory. ## Changes in lifecycle when WAL is enabled