StableObservationOptionsType

StableObservationOptionsType = object

Defined in: src/cluster/bootstrap/StableObservationOptions.ts:39

Plain options-object shape accepted by StableObservation.

Properties

log?

readonly optional log?: (message) => void

Defined in: src/cluster/bootstrap/StableObservationOptions.ts:69

Where progress and reset lines go. Default: discarded.

Parameters

message

string

Returns

void

---

maxWaitMs?

readonly optional maxWaitMs?: number

Defined in: src/cluster/bootstrap/StableObservationOptions.ts:60

Total budget before the observation throws. Default: 60 000 ms.

---

pollIntervalMs?

readonly optional pollIntervalMs?: number

Defined in: src/cluster/bootstrap/StableObservationOptions.ts:58

Cadence of the lookup() polls. Default: 1 000 ms.

---

requiredContactPoints?

readonly optional requiredContactPoints?: number

Defined in: src/cluster/bootstrap/StableObservationOptions.ts:62

Fewest contact points a stable observation may contain. Default: 1.

---

seedProvider

readonly seedProvider: SeedProvider

Defined in: src/cluster/bootstrap/StableObservationOptions.ts:45

Where the contact points come from. Any SeedProvider — the DNS, K8s and config providers all work; the observation only cares that repeated lookup() calls converge.

---

selfAddress

readonly selfAddress: NodeAddress

Defined in: src/cluster/bootstrap/StableObservationOptions.ts:54

This node’s own address — both a contact point in its own right and the value the address-ordered election compares against.

It must be the address peers would dial, not a bind address: an election ordered on 0.0.0.0 puts every node first (see #944), so StableObservation refuses to run on a wildcard.

---

selfElectionGraceMs?

readonly optional selfElectionGraceMs?: number

Defined in: src/cluster/bootstrap/StableObservationOptions.ts:67

Millisecond grace handed to the elected initial seed as its ClusterOptions.selfElection. Default: 10 000 ms.

---

stableMarginMs?

readonly optional stableMarginMs?: number

Defined in: src/cluster/bootstrap/StableObservationOptions.ts:56

How long the observed set must stay unchanged. Default: 5 000 ms.