class Counter
extends MetricBase

Constructors

Counter(
name: string,
config: MetricConfig
)

Creates a new counter.

Parameters
name: string

Metric name

The metric configuration

Properties

readonly
valueEntries: ReadonlyMap<string, CounterValue>

Gets all value entries with labels.

readonly
values: ReadonlyMap<string, number>

Gets all values.

Methods

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 counter.

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

Records an observation — equivalent to inc() for counters.

Usage

import { Counter } from "metrics-plugin/src/index.ts";