Skip to main content

Interface: IMetricsProducer

Contract for a metrics producer.

A producer declares its metrics with register() once and pushes current values with collect() on every poll cycle. Producers are discovered via MetricsProducerFactory and orchestrated by a MetricsCollectorService.

Producers are factory-only entries - they are not lifecycle components of the engine. The orchestrating service owns the polling timer.

Extends​

  • IComponent

Methods​

register()​

register(): Promise<void>

Register every metric this producer emits with the telemetry component. Called once when the orchestrating service starts.

Returns​

Promise<void>

A promise that resolves when all metrics have been registered.

collect()​

collect(): Promise<ITelemetryMetricValueEntry[]>

Read the current values for every metric this producer emits. Called on every poll cycle. The values are returned rather than recorded, so the orchestrating service can record a whole cycle in one operation.

Returns​

Promise<ITelemetryMetricValueEntry[]>

The current values for this producer's metrics.