MetricsModule

PackageAxial.Telemetry
Flow-native helpers for application-defined metrics over Meter.

Summary

NameSignatureSynopsis
Operations
meterMetrics.meter nameCreates a meter for application metrics.
counterMetrics.counter meter nameCreates a monotonic counter on the supplied meter.
histogramMetrics.histogram meter nameCreates a histogram on the supplied meter.
gaugeMetrics.gauge meter name measureCreates an observable gauge whose value is read on collection.
addMetrics.add counter valueRecords an increment on a counter.
recordMetrics.record histogram valueRecords a value on a histogram.

Operations

kind:member

meter

Metrics.meter name
Member
Creates a meter for application metrics.

Parameters

NameTypeDescription
namestring

Returns

Meter
kind:member

counter

Metrics.counter meter name
Member
Creates a monotonic counter on the supplied meter.

Parameters

NameTypeDescription
meterMeter
namestring

Returns

Counter<int64>
kind:member

histogram

Metrics.histogram meter name
Member
Creates a histogram on the supplied meter.

Parameters

NameTypeDescription
meterMeter
namestring

Returns

Histogram<float>
kind:member

gauge

Metrics.gauge meter name measure
Member
Creates an observable gauge whose value is read on collection.

Parameters

NameTypeDescription
meterMeter
namestring
measureunit -> float

Returns

ObservableGauge<float>
kind:member

add

Metrics.add counter value
Member
Records an increment on a counter.

Parameters

NameTypeDescription
counterCounter<int64>
valueint64

Returns

Flow<'env, 'error, unit>
kind:member

record

Metrics.record histogram value
Member
Records a value on a histogram.

Parameters

NameTypeDescription
histogramHistogram<float>
valuefloat

Returns

Flow<'env, 'error, unit>