Skip to content

Commit

Permalink
Clarify that ingester WAL config applies only to chunks storage (cort…
Browse files Browse the repository at this point in the history
…exproject#3590)

Signed-off-by: Marco Pracucci <[email protected]>
  • Loading branch information
pracucci authored Dec 11, 2020
1 parent 638c78c commit 0605dad
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 16 deletions.
15 changes: 0 additions & 15 deletions docs/configuration/arguments.md
Original file line number Diff line number Diff line change
Expand Up @@ -385,21 +385,6 @@ It also talks to a KVStore and has it's own copies of the same flags used by the
Where you don't want to cache every chunk written by ingesters, but you do want to take advantage of chunk write deduplication, this option will make ingesters write a placeholder to the cache for each chunk.
Make sure you configure ingesters with a different cache to queriers, which need the whole value.

#### WAL

- `-ingester.wal-dir`
Directory where the WAL data should be stored and/or recovered from.

- `-ingester.wal-enabled`

Setting this to `true` enables writing to WAL during ingestion.

- `-ingester.checkpoint-duration`
This is the interval at which checkpoints should be created.

- `-ingester.recover-from-wal`
Set this 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.

#### Flusher

- `-flusher.wal-dir`
Expand Down
2 changes: 2 additions & 0 deletions docs/configuration/config-file-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -549,6 +549,8 @@ ring:
The `ingester_config` configures the Cortex ingester.

```yaml
# Configures the Write-Ahead Log (WAL) for the Cortex chunks storage. This
# config is ignored when running the Cortex blocks storage.
walconfig:
# Enable writing of ingested data into WAL.
# CLI flag: -ingester.wal-enabled
Expand Down
2 changes: 1 addition & 1 deletion pkg/ingester/ingester.go
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ var (

// Config for an Ingester.
type Config struct {
WALConfig WALConfig `yaml:"walconfig"`
WALConfig WALConfig `yaml:"walconfig" doc:"description=Configures the Write-Ahead Log (WAL) for the Cortex chunks storage. This config is ignored when running the Cortex blocks storage."`
LifecyclerConfig ring.LifecyclerConfig `yaml:"lifecycler"`

// Config for transferring chunks. Zero or negative = no retries.
Expand Down

0 comments on commit 0605dad

Please sign in to comment.