> For the complete documentation index, see [llms.txt](https://vectis.liesware.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://vectis.liesware.com/observability.md).

# Observability

## Prometheus metrics

> Prometheus metrics in the text exposition format. Requires X-API-Key with root, admin, or metrics permission. Enabled by VECTIS\_METRICS\_ENABLED (default true); returns 404 when disabled after auth succeeds. Labels carry no sensitive data. Metrics include HTTP request counts/durations, auth and permission decisions, unsealed state, loaded keys/routes/ permissions, config and key reload results, message operation results, and cryptographic operation results.<br>

```json
{"openapi":"3.1.0","info":{"title":"Vectis HTTP API","version":"v1"},"tags":[{"name":"Observability"}],"servers":[{"url":"http://127.0.0.1:3000","description":"Local default server over HTTP"},{"url":"https://127.0.0.1:3000","description":"Local HTTPS server when VECTIS_MODE=prod"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key"}},"responses":{"Error":{"description":"Public error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"schemas":{"ErrorResponse":{"type":"object","required":["error"],"properties":{"error":{"$ref":"#/components/schemas/TextField"}}},"TextField":{"type":"string","minLength":1,"pattern":"^[^\\x00-\\x1F\\x7F-\\x9F]+$"}}},"paths":{"/metrics":{"get":{"tags":["Observability"],"summary":"Prometheus metrics","description":"Prometheus metrics in the text exposition format. Requires X-API-Key with root, admin, or metrics permission. Enabled by VECTIS_METRICS_ENABLED (default true); returns 404 when disabled after auth succeeds. Labels carry no sensitive data. Metrics include HTTP request counts/durations, auth and permission decisions, unsealed state, loaded keys/routes/ permissions, config and key reload results, message operation results, and cryptographic operation results.\n","responses":{"200":{"description":"Metrics in Prometheus text exposition format","content":{"text/plain":{"schema":{"type":"string"}}}},"404":{"description":"Metrics disabled via VECTIS_METRICS_ENABLED=false"},"default":{"$ref":"#/components/responses/Error"}}}}}}
```