Interface MetricsCollector

Sink for operational metrics emitted by RTCForge.

Remarks

Metric names are typically drawn from Metric. All methods accept optional string labels for dimensional breakdowns. Supply noopMetrics to disable collection.

interface MetricsCollector {
    gauge(
        metric: string,
        value: number,
        labels?: Record<string, string>,
    ): void;
    histogram(
        metric: string,
        value: number,
        labels?: Record<string, string>,
    ): void;
    increment(metric: string, labels?: Record<string, string>): void;
    timing(metric: string, ms: number, labels?: Record<string, string>): void;
}

Index

Methods

gauge histogram increment timing

Methods

gauge

gauge(metric: string, value: number, labels?: Record<string, string>): void
Records the current value of a gauge metric.
Parameters
- metric: string
  The metric name.
- value: number
  The instantaneous value to record.
- Optionallabels: Record<string, string>
  Optional key/value labels for dimensional aggregation.
Returns void
- Defined in packages/core/src/types.ts:109

histogram

histogram(metric: string, value: number, labels?: Record<string, string>): void
Records a value into a histogram/distribution metric.
Parameters
- metric: string
  The metric name.
- value: number
  The observed value to add to the distribution.
- Optionallabels: Record<string, string>
  Optional key/value labels for dimensional aggregation.
Returns void
- Defined in packages/core/src/types.ts:116

increment

increment(metric: string, labels?: Record<string, string>): void
Increments a counter metric by one.
Parameters
- metric: string
  The metric name.
- Optionallabels: Record<string, string>
  Optional key/value labels for dimensional aggregation.
Returns void
- Defined in packages/core/src/types.ts:102

timing

timing(metric: string, ms: number, labels?: Record<string, string>): void
Records a duration measurement in milliseconds.
Parameters
- metric: string
  The metric name.
- ms: number
  The measured duration in milliseconds.
- Optionallabels: Record<string, string>
  Optional key/value labels for dimensional aggregation.
Returns void
- Defined in packages/core/src/types.ts:123

Interface MetricsCollector

Remarks

Index

Methods

Methods

gauge

Parameters

Returns void

histogram

Parameters

Returns void

increment

Parameters

Returns void

timing

Parameters

Returns void

Settings

On This Page