Skip to content

Commit 25cc4be

Browse files
mikhail-dclclaude
andcommitted
docs: record that clustering ships enabled
Clusters:Enabled is on by default; the feed stays off until a broker URL is set, so the shipped default is shadow mode. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
1 parent 8f5fdf4 commit 25cc4be

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

docs/clustering-on-aoi.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ This surfaced a latent gap: `ServiceStatus` / `ServiceDiscoveryMessage` were **n
171171

172172
| Option (`Clusters`) | Default | Meaning |
173173
| --- | --- | --- |
174-
| `Enabled` | false | Feature flag |
174+
| `Enabled` | true | Feature flag (set in both `appsettings.json` and `appsettings.Development.json`) |
175175
| `PassIntervalMs` | 1000 | Tracker pass cadence |
176176
| `DwellPasses` | 3 | Passes before a reassignment publishes |
177177
| `IdPrefix` | `C` | Cluster ID prefix (replaces archipelago `ROOM_PREFIX`) |
@@ -186,6 +186,8 @@ This surfaced a latent gap: `ServiceStatus` / `ServiceDiscoveryMessage` were **n
186186

187187
The broker URL is read from **either** `Nats__Url` or the flat `NATS_URL` — the latter is the name archipelago's services read (`config.requireString("NATS_URL")`), so one CI-injected secret serves both. `Nats__Url` wins if both are set. Because an unresolved URL fails soft rather than erroring, `dcl_pulse_nats_connected` and the startup log are the only signals that a secret never arrived.
188188

189+
**The two flags are independent, and that is the safe default.** `Clusters:Enabled` ships **true**, so the tracker runs everywhere and its metrics are populated; `Nats:Url` ships empty, so nothing is published. A deployment therefore gets shadow mode (§5 step 1) by default and becomes an author only once a broker URL is injected — which is also the rollback: clear the URL and the feed stops while clustering keeps running.
190+
189191
**Metrics** (see [metrics.md](metrics.md)): `dcl_pulse_clusters`, `dcl_pulse_cluster_passes_total`, `dcl_pulse_cluster_pass_duration_us_total`, `dcl_pulse_cluster_reassignments_total`, and for the feed `dcl_pulse_nats_{published,dropped,superseded,reconnects}_total` plus `dcl_pulse_nats_connected`. `dropped` is the actionable one; `superseded` is expected under load.
190192

191193
## 4. Comparison

0 commit comments

Comments
 (0)