Interface IMetricsService

Metrics service resolved via ctx.services.get<IMetricsService>('metrics').

Since

0.2.0

interface IMetricsService {
    counter(name: string, options?: MetricOptions): ICounter;
    gauge(name: string, options?: MetricOptions): IGauge;
    get(name: string): IMetric | undefined;
    histogram(name: string, options?: MetricOptions): IHistogram;
    summary(name: string, options?: MetricOptions): ISummary;
}

Implemented by

MetricsService

Index

Methods

counter gauge get histogram summary

Methods

counter

counter(name: string, options?: MetricOptions): ICounter
Gets or creates a counter.
Parameters
- name: string
  Metric name
- Optionaloptions: MetricOptions
  Optional configuration
Returns ICounter
The counter instance
- Defined in packages/common/src/services/metrics.ts:162

gauge

gauge(name: string, options?: MetricOptions): IGauge
Gets or creates a gauge.
Parameters
- name: string
  Metric name
- Optionaloptions: MetricOptions
  Optional configuration
Returns IGauge
The gauge instance
- Defined in packages/common/src/services/metrics.ts:170

get

get(name: string): IMetric | undefined
Gets a metric by name.
Parameters
- name: string
  Metric name
Returns IMetric | undefined
The metric, or undefined if not found
- Defined in packages/common/src/services/metrics.ts:193

histogram

histogram(name: string, options?: MetricOptions): IHistogram
Gets or creates a histogram.
Parameters
- name: string
  Metric name
- Optionaloptions: MetricOptions
  Optional configuration
Returns IHistogram
The histogram instance
- Defined in packages/common/src/services/metrics.ts:178

summary

summary(name: string, options?: MetricOptions): ISummary
Gets or creates a summary.
Parameters
- name: string
  Metric name
- Optionaloptions: MetricOptions
  Optional configuration
Returns ISummary
The summary instance
- Defined in packages/common/src/services/metrics.ts:186