← The board

K1 Metrics & dashboards

Area
K — Observability
Audience
operator
Kind
feature
Status
accepted
Maturity
planned
Labels
observability, verification
Relates to
B3G7

The feature in the specification · Read at

Requirements

  1. K1-R1acceptedMUST

    Metrics collection, storage and dashboards MUST use open-source, self-hostable components, and MUST NOT ship operational data to a proprietary or hosted observability plane.

    locked by
    0.23.0 open
  2. K1-R2acceptedMUST

    A collector MUST scrape per-service exporters for the \arr apps and the download client on a schedule.

    locked by
    0.23.0 open
  3. K1-R3acceptedMUST

    Scrape targets MUST be file-provisioned as generated configuration, not configured by click-ops.

    locked by
    0.23.0 open
  4. K1-R4acceptedMUST

    Dashboards MUST be file-provisioned as generated configuration, not saved by hand in the renderer.

    locked by
    0.23.0 open
  5. K1-R5acceptedMUST

    The tool MUST assert that the collector reports each configured target as up, and MUST NOT treat a running exporter container as a healthy target.

    locked by
    0.23.0 open
  6. K1-R6acceptedMUST

    The tool MUST assert that the expected per-service metric series are present in the store, catching an exporter that starts but emits nothing.

    locked by
    0.23.0 open
  7. K1-R7acceptedMUST

    The tool MUST ship a curated dashboard set and assert that its panels resolve their queries against real data rather than rendering as empty.

    locked by
    0.23.0 open
  8. K1-R8acceptedMUST

    Adding a service that has an exporter MUST add it to the scrape configuration so coverage tracks the stack.

    locked by
    0.23.0 open
  9. K1-R9acceptedMUST

    The metrics store MUST enforce a retention bound and MUST surface projected disk growth.

    locked by
    0.23.0 open
  10. K1-R10acceptedMUST

    A target reachable only inside the VPN namespace MUST be scraped across the correct network path and MUST NOT be reported down for a namespace mismatch.

    locked by
    0.23.0 open
  11. K1-R11acceptedMUST

    A collector that is scraping but not retaining MUST be distinguished from a healthy pipeline.

    locked by
    0.23.0 open
  12. K1-R12acceptedMUST

    A service with no available exporter MUST be reported as unmonitored rather than implied to be covered.

    locked by
    0.23.0 open
  13. K1-R13acceptedMUST

    Provisioning, regenerating targets and dashboards, and running the pipeline proof MUST each be reachable non-interactively.

    locked by
    0.23.0 open
  14. K1-R14acceptedMUST

    A failed target, series or render check MUST be distinguished from success, and each failure MUST carry a remedy (G4).

    locked by
    0.23.0 open