Class AgeCounters

A small helper object that counts into buckets the number of calls to its bump that fall into the given age categories. Counts are maintained within the object, and can be fetched to set into a gauge metric object.

This class is useful when exporting metrics that count the number of hourly/daily/weekly active instances of various types of object within the bridge.

Constructors

constructor

Methods

bump setGauge

Constructors

constructor

  • new AgeCounters(counterPeriods?): AgeCounters

  • Parameters

    • Optional counterPeriods: string[]

      A set of strings denoting the bucket periods used by the gauge. It is in the format of '#X' where # is the integer period and X is the unit of time. A unit can be one of 'h, d, w' for hours, days and weeks. 7d would be 7 days. If not given, the periods are 1h, 1d and 7d.

    Returns AgeCounters

Methods

bump

  • bump(age): void

  • Increment the values of the internal counters depending on the given age, in seconds.

    Parameters

    • age: number

      The age in seconds.

    Returns void

setGauge

  • setGauge(gauge, morelabels?): void

  • Fetch the counts in the age buckets and set them as labeled observations in the given gauge metric instance.

    Parameters

    • gauge: Gauge<string>

      The gauge metric instance.

    • Optional morelabels: {
          [label: string]: string;
      }

      An object containing more labels to add to the gauge when setting values.

      • [label: string]: string

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc