Metric42

Constructors

counterconstRepresents a Counter metric that tracks cumulative numerical values over time.frequencyconstCreates a Frequency metric which can be used to count the number of occurrences of a string.gaugeconstRepresents a Gauge metric that tracks and reports a single numerical value at a specific moment.histogramconstRepresents a Histogram metric that records observations into buckets.summaryconstCreates a Summary metric that records observations and calculates quantiles which takes a value as input and uses the current time.summaryWithTimestampconstCreates a Summary metric that records observations with explicit timestamps and calculates quantiles.timerconstCreates a timer metric, based on a Histogram, which keeps track of durations in milliseconds.

Models

MetricinterfaceA Metric<Input, State> represents a concurrent metric which accepts update values of type Input and are aggregated to a value of type State.

Guards

isMetricconstReturns true if the specified value is a Metric, otherwise returns false.

Getters

valueconstRetrieves the current state of the specified Metric.

Mapping

mapInputconstReturns a new metric that is powered by this one, but which accepts updates of the specified new type, which must be transformable to the input type of this metric.

Mutations

modifyconstModifies the metric with the specified input.updateconstUpdates the metric with the specified input.

Attributes

withAttributesconstReturns a new metric that applies the specified attributes to all operations.

Boundaries

boundariesFromIterableconstCreates histogram bucket boundaries from an iterable set of values.exponentialBoundariesconstCreates histogram bucket boundaries with exponentially increasing values.linearBoundariesconstCreates histogram bucket boundaries from a linear sequence and appends positive infinity.

Counter

CounterStateinterfaceState interface for Counter metrics containing the current count and increment mode.

Debugging

dumpconstReturns a human-readable string representation of all currently registered metrics in a tabular format.

Input

withConstantInputconstReturns a new metric that is powered by this one, but which accepts updates of any type, and translates them to updates with the specified constant update value.

Metrics

CounterinterfaceA Counter metric that tracks cumulative values that typically only increase.disableRuntimeMetricsconstDisables automatic collection of fiber runtime metrics for the provided Effect.disableRuntimeMetricsLayerconstLayer that disables automatic collection of fiber runtime metrics.enableRuntimeMetricsconstEnables automatic collection of fiber runtime metrics for the provided Effect.enableRuntimeMetricsLayerconstLayer that enables automatic collection of fiber runtime metrics across an entire Effect application.FiberRuntimeMetricsImplconstDefault implementation of the fiber runtime metrics service.FiberRuntimeMetricsKeyconstService key for the fiber runtime metrics service.FiberRuntimeMetricsServiceinterfaceInterface for the fiber runtime metrics service that tracks fiber lifecycle events.FrequencyinterfaceA Frequency metric interface that counts occurrences of discrete string values.FrequencyStateinterfaceState interface for Frequency metrics containing occurrence counts for discrete string values.GaugeinterfaceA Gauge metric that tracks instantaneous values that can go up or down.GaugeStateinterfaceState interface for Gauge metrics containing the current instantaneous value.HistograminterfaceA Histogram metric that records observations in configurable buckets to analyze value distributions.HistogramStateinterfaceState interface for Histogram metrics containing bucket distributions and aggregate statistics.SummaryinterfaceA Summary metric that calculates quantiles over a sliding time window of observations.SummaryStateinterfaceState interface for Summary metrics containing quantile calculations and aggregate statistics.

References

CurrentMetricAttributesconstContext reference for metric attributes applied from the current Effect context.CurrentMetricAttributesKeyconstService key for the current metric attributes context.MetricRegistryconstContext reference for the metric registry in the current context.

Runtime Metrics

FiberRuntimeMetricsconstContext reference for the optional service that records fiber runtime metrics.

Snapshotting

snapshotconstCaptures a snapshot of all registered metrics in the current context.snapshotUnsafeconstCaptures a snapshot of all registered metrics synchronously using the provided service context.