diff --git a/docs/sources/configuration/_index.md b/docs/sources/configuration/_index.md index fef9aef88a..d0e0ff7810 100644 --- a/docs/sources/configuration/_index.md +++ b/docs/sources/configuration/_index.md @@ -588,11 +588,11 @@ storage: local: # Directory to scan for rules # CLI flag: -ruler.storage.local.directory - [directory: | default = ""] + [directory: | default = ""] # File path to store temporary rule files # CLI flag: -ruler.rule-path -[rule_path: | default = "/rules"] +[rule_path: | default = "/rules"] # Comma-separated list of Alertmanager URLs to send notifications to. # Each Alertmanager URL is treated as a separate group in the configuration. @@ -895,6 +895,29 @@ lifecycler: # Use a value of -1 to allow the ingester to query the store infinitely far back in time. # CLI flag: -ingester.query-store-max-look-back-period [query_store_max_look_back_period: | default = 0] + + +# The ingester WAL records incoming logs and stores them on the local file system in order to guarantee persistence of acknowledged data in the event of a process crash. +wal: + # Enables writing to WAL. + # CLI flag: -ingester.wal-enabled + [enabled: | default = false] + + # Directory where the WAL data should be stored and/or recovered from. + # CLI flag: -ingester.wal-dir + [dir: | default = "wal"] + + # Recover data from existing WAL dir irrespective of WAL enabled/disabled. + # CLI flag: -ingester.recover-from-wal + [recover: | default = false] + +# When WAL is enabled, should chunks be flushed to long-term storage on shutdown. +# CLI flag: -ingester.flush-on-shutdown +[flush_on_shutdown: | default = false] + +# Interval at which checkpoints should be created. +# CLI flag: ingester.checkpoint-duration +[checkpoint_duration: | default = 5m] ``` ## consul_config diff --git a/docs/sources/operations/storage/wal.md b/docs/sources/operations/storage/wal.md index d6a0a8460c..a5c1e99db9 100644 --- a/docs/sources/operations/storage/wal.md +++ b/docs/sources/operations/storage/wal.md @@ -34,7 +34,7 @@ Note: the Prometheus metric `loki_ingester_wal_disk_full_failures_total` can be 2. Following flags needs to be set * `--ingester.wal-enabled` to `true` which enables writing to WAL during ingestion. - * `--ingester.wal-dir` to the directory where the WAL data should be stores and/or recovered from. Note that this should be on the mounted volume. + * `--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`.