PURISTA

Appearance

PURISTA API

PURISTA API / @purista/core / PuristaMetricsRecorder

Class: PuristaMetricsRecorder ​

Defined in: core/metrics/PuristaMetricsRecorder.ts:34

OpenTelemetry API backed PURISTA metrics recorder.

The recorder depends only on @opentelemetry/api. Applications provide the actual MeterProvider and exporters at runtime.

Example ​

ts
const recorder = new PuristaMetricsRecorder({
  defaultAttributes: { 'purista.service.name': 'orders' },
})
recorder.recordFrameworkMetric('purista.command.executions', 1, {
  'purista.command.name': 'createOrder',
})

Implements ​

Constructors ​

Constructor ​

new PuristaMetricsRecorder(options?): PuristaMetricsRecorder

Defined in: core/metrics/PuristaMetricsRecorder.ts:42

Parameters ​

options? ​

PuristaMetricsRuntimeOptions = {}

Returns ​

PuristaMetricsRecorder

Methods ​

recordCustomMetric() ​

recordCustomMetric(name, definition, value, attributes?): void

Defined in: core/metrics/PuristaMetricsRecorder.ts:63

Parameters ​

name ​

string

definition ​

PuristaMetricDefinition<any>

value ​

number

attributes? ​

Record<string, string | number | boolean>

Returns ​

void

Implementation of ​

PuristaMetricsRecorderInterface.recordCustomMetric

recordFrameworkMetric() ​

recordFrameworkMetric(name, value, attributes?): void

Defined in: core/metrics/PuristaMetricsRecorder.ts:50

Parameters ​

name ​

string

value ​

number

attributes? ​

Record<string, string | number | boolean>

Returns ​

void

Implementation of ​

PuristaMetricsRecorderInterface.recordFrameworkMetric