Class PrometheusMetricsService

Default metrics service implementation of Zibri.

Implements

MetricsServiceInterface

Index

Constructors

Methods

attachTo collect getCounter getGauge getHistogram getMetricSnapshots measureFinishedRequest

Constructors

constructor

new PrometheusMetricsService(): PrometheusMetricsService
Returns PrometheusMetricsService
- Defined in src/metrics/metrics.service.ts:66

Methods

attachTo

attachTo(app: ZibriApplication): void
Attaches the service to the Zibri application.
Parameters
- app: ZibriApplication
Returns void
Implementation of MetricsServiceInterface.attachTo
- Defined in src/metrics/metrics.service.ts:77

collect

collect(): Promise<void>
Collect a snapshot of every metric’s current samples. This will usually be called in regular intervals, eg. From a cron job.

To retrieve the metrics use the getMetricSnapshots method.

Returns Promise<void>
Implementation of MetricsServiceInterface.collect
- Defined in src/metrics/metrics.service.ts:140

getCounter

getCounter(name: CounterMetricName, labelNames?: string[]): PromCounter
Create or retrieve a counter metric.
Parameters
- name: CounterMetricName
- OptionallabelNames: string[]
Returns PromCounter
Implementation of MetricsServiceInterface.getCounter
- Defined in src/metrics/metrics.service.ts:113

getGauge

getGauge(name: string, labelNames?: string[]): PromGauge
Create or retrieve a gauge metric.
Parameters
- name: string
- OptionallabelNames: string[]
Returns PromGauge
Implementation of MetricsServiceInterface.getGauge
- Defined in src/metrics/metrics.service.ts:122

getHistogram

getHistogram(
    name: HistogramMetricName,
    labelNames?: string[],
    buckets?: number[],
): PromHistogram
Create or retrieve a histogram metric.
Parameters
- name: HistogramMetricName
- OptionallabelNames: string[]
- Optionalbuckets: number[]
Returns PromHistogram
Implementation of MetricsServiceInterface.getHistogram
- Defined in src/metrics/metrics.service.ts:131

getMetricSnapshots

getMetricSnapshots(): MetricsSnapshot[]
Returns all 60 buffered snapshots.

IF YOU WANT A LONGER HISTORY YOU SHOULD USE AN EXTERNAL TOOL LIKE PROMETHEUS TO SCRAPE THE DATA.

Returns MetricsSnapshot[]
Implementation of MetricsServiceInterface.getMetricSnapshots
- Defined in src/metrics/metrics.service.ts:175

measureFinishedRequest

measureFinishedRequest(
    req: HttpRequest,
    res: HttpResponse,
    durationInMs: number,
): void
Collects metrics about a finished request.
Parameters
- req: HttpRequest
- res: HttpResponse
- durationInMs: number
Returns void
Implementation of MetricsServiceInterface.measureFinishedRequest
- Defined in src/metrics/metrics.service.ts:90