Skip to content

RESTMetrics

Defined in: packages/rest/src/telemetry.ts:149

An in-memory metrics aggregator for RESTTelemetry: counters, gauges and latency histograms, with a hard cap on distinct label sets so an unexpected route shape cannot grow it without bound.

const metrics = new RESTMetrics();
const rest = new REST({ token, telemetry: metrics });
// later: metrics.snapshot(), or metrics.toPrometheus() for a /metrics endpoint

new RESTMetrics(options?): RESTMetrics

Defined in: packages/rest/src/telemetry.ts:157

maxRoutes: distinct route labels kept before the rest become other (default 500).

number

RESTMetrics

emit(event): void

Defined in: packages/rest/src/telemetry.ts:195

RESTTelemetryEvent

void

RESTTelemetry.emit


reset(): void

Defined in: packages/rest/src/telemetry.ts:301

Clears every value.

void


snapshot(): RESTMetricsSnapshot

Defined in: packages/rest/src/telemetry.ts:281

The current values.

RESTMetricsSnapshot


toPrometheus(prefix?): string

Defined in: packages/rest/src/telemetry.ts:309

The values in the Prometheus text exposition format.

string = "lunibee_rest"

string