Skip to content

Commit 45d191a

Browse files
committed
Document some command-line options for hand-over
Signed-off-by: Bryan Boreham <[email protected]>
1 parent 2a3a950 commit 45d191a

File tree

2 files changed

+16
-5
lines changed

2 files changed

+16
-5
lines changed

docs/arguments.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Cortex Arguments Explained
22

3+
Duration arguments should be specified with a unit like `5s` or `3h`. Valid time units are "ms", "s", "m", "h".
4+
35
## Querier
46

57
- `-querier.max-concurrent`
@@ -155,6 +157,14 @@ It also talks to a KVStore and has it's own copies of the same flags used by the
155157

156158
## Ingester
157159

160+
- `-ingester.join-after`
161+
162+
How long to wait in PENDING state during the [hand-over process](ingester-handover.md). (default 0s)
163+
164+
- `-ingester.ingester.max-transfer-retries`
165+
166+
How many times a LEAVING ingester tries to find a PENDING ingester during the [hand-over process](ingester-handover.md). Each attempt takes a second or so. (default 10)
167+
158168
- `-ingester.normalise-tokens`
159169

160170
Write out "normalised" tokens to the ring. Normalised tokens consume less memory to encode and decode; as the ring is unmarshalled regularly, this significantly reduces memory usage of anything that watches the ring.

docs/ingester-handover.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ Each ingester goes through different states in its lifecycle. When
99
working normally, the state is `ACTIVE`.
1010

1111
On start-up, an ingester first goes into state `PENDING`. After a
12-
short time, if nothing happens, it adds itself to the ring and goes
13-
into state ACTIVE.
12+
[short time](arguments.md#ingester), if nothing happens, it adds
13+
itself to the ring and goes into state ACTIVE.
1414

1515
A running ingester is notified to shut down by Unix signal
1616
`SIGINT`. On receipt of this signal it goes into state `LEAVING` and
@@ -21,9 +21,10 @@ removes itself from the ring and exits and the joiner changes to
2121
`ACTIVE`, taking over ownership of the leaver's
2222
[ring tokens](architecture.md#hashing).
2323

24-
If a leaving ingester does not find a pending ingester, it will flush
25-
all of its chunks to the backing database, then remove itself from the
26-
ring and exit. This may take tens of minutes to complete.
24+
If a leaving ingester does not find a pending ingester after [several
25+
attempts](arguments.md#ingester), it will flush all of its chunks to
26+
the backing database, then remove itself from the ring and exit. This
27+
may take tens of minutes to complete.
2728

2829
During hand-over, neither the leaving nor joining ingesters will
2930
accept new samples. Distributors are aware of this, and "spill" the

0 commit comments

Comments
 (0)