Class Histogram<T>

A histogram samples observations (usually things like request durations or response sizes) and counts them in configurable buckets

Type Parameters

  • T extends string = string

Constructors

constructor

Methods

get labels observe remove reset startTimer zero

Constructors

constructor

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

  • Type Parameters

    • T extends string = string

    Parameters

    • configuration: HistogramConfiguration<T>

      Configuration when creating the Histogram. Name and Help is mandatory

    Returns Histogram<T>

Methods

get

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

  • Get histogram metric object

    Returns Promise<MetricObjectWithValues<MetricValueWithName<T>>>

labels

  • labels(...values): Histogram.Internal<T>

  • Return the child for given labels

    Parameters

    • Rest ...values: string[]

      Label values

    Returns Histogram.Internal<T>

    Configured histogram with given labels

  • labels(labels): Histogram.Internal<T>

  • Return the child for given labels

    Parameters

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

      Object with label keys and values

    Returns Histogram.Internal<T>

    Configured counter with given labels

observe

  • observe(value): void

  • Observe value

    Parameters

    • value: number

      The value to observe

    Returns void

  • observe(labels, value): void

  • Observe value for given labels

    Parameters

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

      Object with label keys and values

    • value: number

      The value to observe

    Returns void

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 histogram values

    Returns void

startTimer

  • startTimer(labels?): ((labels?) => number)

  • Start a timer. Calling the returned function will observe the duration in seconds in the histogram.

    Parameters

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

      Object with label keys and values

    Returns ((labels?) => number)

    Function to invoke when timer should be stopped. The value it returns is the timed duration.

      • (labels?): number

      • Parameters

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

        Returns number

zero

  • zero(labels): void

  • Initialize the metrics for the given combination of labels to zero

    Parameters

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

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorgetlabelsobserveremoveresetstartTimerzero