Graphorin API reference v0.1.0
Graphorin API reference / @graphorin/server / / MetricsRoutesOptions
Interface: MetricsRoutesOptions
Defined in: packages/server/src/health/routes.ts:112
Stable
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
onError? | readonly | (err) => void | - | packages/server/src/health/routes.ts:126 |
refresh? | readonly | () => void | Promise<void> | Optional refresh callback invoked before every scrape. Use it to sample live signals (WAL size, in-flight runs, daemon status, replay buffer occupancy) into the registry so the scraped output reflects the moment of the request. Refresh failures are swallowed — a broken probe never blocks a Prometheus scrape — and surfaced through the optional onError sink. | packages/server/src/health/routes.ts:125 |
registry | readonly | MetricRegistry | - | packages/server/src/health/routes.ts:113 |
requireAuth? | readonly | boolean | - | packages/server/src/health/routes.ts:114 |