Class Counter<T>

A counter is a cumulative metric that represents a single numerical value that only ever goes up

Type Parameters

  • T extends string = string

Constructors

constructor

Methods

get inc labels remove reset

Constructors

constructor

  • new Counter<T>(configuration): Counter<T>

  • Type Parameters

    • T extends string = string

    Parameters

    • configuration: CounterConfiguration<T>

      Configuration when creating a Counter metric. Name and Help is required.

    Returns Counter<T>

Methods

get

  • get(): Promise<MetricObjectWithValues<MetricValue<T>>>

  • Get counter metric object

    Returns Promise<MetricObjectWithValues<MetricValue<T>>>

inc

  • inc(labels, value?): void

  • Increment for given labels

    Parameters

    • labels: Partial<Record<T, string | number>>

      Object with label keys and values

    • Optional value: number

      The number to increment with

    Returns void

  • inc(value?): void

  • Increment with value

    Parameters

    • Optional value: number

      The value to increment with

    Returns void

labels

  • labels(...values): Counter.Internal

  • Return the child for given labels

    Parameters

    • Rest ...values: string[]

      Label values

    Returns Counter.Internal

    Configured counter with given labels

  • labels(labels): Counter.Internal

  • Return the child for given labels

    Parameters

    • labels: Partial<Record<T, string | number>>

      Object with label keys and values

    Returns Counter.Internal

    Configured counter with given labels

remove

  • remove(...values): void

  • Remove metrics for the given label values

    Parameters

    • Rest ...values: string[]

      Label values

    Returns void

  • remove(labels): void

  • Remove metrics for the given label values

    Parameters

    • labels: Partial<Record<T, string | number>>

      Object with label keys and values

    Returns void

reset

  • reset(): void

  • Reset counter values

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorgetinclabelsremovereset