Files
CosmicClash/docs/OBSERVABILITY.md
T

24 lines
1.3 KiB
Markdown

# Multiplayer observability
The control plane exposes `/metrics` with bounded operation and status labels.
The API latency metric is a cumulative histogram, so Prometheus can evaluate
the documented 250 ms p95 SLO with `histogram_quantile`. The optional
`deploy/observability/prometheus-rules.yaml` resource provides the API p95 and
5xx alerts for clusters running the Prometheus Operator. The matching optional
`deploy/observability/prometheus-service-monitor.yaml` discovers the internal
control-plane Service on its named `http` port and scrapes only `/metrics`.
`scripts/verify_observability_manifests.py` is included in the local
multiplayer gate and checks this Service/monitor contract without requiring a
Kubernetes or Prometheus installation.
Install the rule only after confirming that the `PrometheusRule` CRD and the
`ServiceMonitor` CRD and the `cosmic-clash` namespace exist. The example
`runbook_url` values are
placeholders and must be replaced with the operator's incident documentation
before production use.
This artifact intentionally does not claim coverage for regional RTT,
allocation/connect latency, tick headroom, durable-result success, or cost.
Those SLOs need additional server, allocator, and game-server series before
they can be alerted on safely; the current exporter cannot manufacture them.