Interface Meter

Meter interface

The meter is responsible for creating metric instruments.

interface Meter {
    createCounter(name: string, options?: MetricOptions): Counter;
    createGauge?(name: string, options?: MetricOptions): Gauge;
    createHistogram(name: string, options?: MetricOptions): Histogram;
}

Index

Methods

createCounter createGauge? createHistogram

Methods

createCounter

createCounter(name: string, options?: MetricOptions): Counter
Creates a new Counter metric instrument.
Parameters
- name: string
  the name of the counter
- Optionaloptions: MetricOptions
  optional configuration for the counter
Returns Counter
a Counter instance
- Defined in interfaces/telemetry.ts:50

`Optional`createGauge

createGauge?(name: string, options?: MetricOptions): Gauge
Creates a new Gauge metric instrument.

A gauge is a metric that represents a single numerical value that can arbitrarily go up and down. Gauges are typically used for measured values like queue sizes.
Parameters
- name: string
  the name of the gauge
- Optionaloptions: MetricOptions
  optional configuration for the gauge
Returns Gauge
a Gauge instance
- Defined in interfaces/telemetry.ts:72

createHistogram

createHistogram(name: string, options?: MetricOptions): Histogram
Creates a new Histogram metric instrument.
Parameters
- name: string
  the name of the histogram
- Optionaloptions: MetricOptions
  optional configuration for the histogram
Returns Histogram
a Histogram instance
- Defined in interfaces/telemetry.ts:59