Gauge - metrics-plugin/src/index.ts - Setu-TS documentation

Constructors



Gauge(name: string,
config: MetricConfig
)

Creates a new gauge.

Parameters



name: string

Metric name



config: MetricConfig

The metric configuration

readonly



valueEntries: ReadonlyMap<string, GaugeValue>

Gets all value entries with labels.

readonly



values: ReadonlyMap<string, number>

Gets all values.



dec(value?: number,
labels?: Readonly<Record<string, string>>
): void

Decrements the gauge.



getValue(labels?: Readonly<Record<string, string>>): number

Gets the current value for a label set.



inc(value?: number,
labels?: Readonly<Record<string, string>>
): void

Increments the gauge.



observe(value: number,
labels?: Readonly<Record<string, string>>
): void

Records an observation — equivalent to set() for gauges.



set(value: number,
labels?: Readonly<Record<string, string>>
): void

Sets the gauge to a specific value.