Observability

← xrmverse documentation

• GET /healthz: anonymous liveness (ok). GET /admin/health and GET /admin/doctor: admin-only detail (see Admin API).
• GET /metrics: Prometheus text format, anonymous (a scraper has no token), so do not expose it to untrusted networks. Instruments (meter Xrmd): xrmd.requests (tags route, status), xrmd.async.queue (tag state: waiting or inProgress), xrmd.pipeline.stage.duration.
• Disable it with the configuration key Observability:Metrics:Enabled=false (environment variable Observability__Metrics__Enabled=false on the xrmd service); /metrics then answers 404. It is enabled by default.
• Tracing (ASP.NET Core and the Xrmd activity source, including pipeline.* activities) is exported over OTLP when Observability:Otlp:Endpoint (Observability__Otlp__Endpoint) is set; otherwise nothing is exported.
• xrmd logs (and -f) reads the server's recent log entries without shell access to the container.