A recorder collects observations within a time window (usually things like response sizes) and can provide aggregated information about the data sample, for example, count, sum, min, max and various quantiles.
class RecorderThis is the user-facing Recorder API.
Its behavior depends on the RecorderHandler implementation.
import CoreMetricsA Metrics API package for Swift.
final class CounterA counter is a cumulative metric that represents a single monotonically increasing counter whose value can only increase or be reset to zero. For example, you can use a counter to represent the number of requests served, tasks completed, or errors.
final class FloatingPointCounterA FloatingPointCounter is a cumulative metric that represents a single monotonically increasing FloatingPointCounter whose value can only increase or be reset to zero. For example, you can use a FloatingPointCounter to represent the number of requests served, tasks completed, or errors. FloatingPointCounter is not supported by all metrics backends, however a default implementation is provided which accumulates floating point values and records increments to a standard Counter after crossing integer boundaries.
final class MeterA meter is similar to a gauge, it is a metric that represents a single numerical value that can arbitrarily go up and down. Meters are typically used for measured values like temperatures or current memory usage, but also “counts” that can go up and down, like the number of active threads.
final class GaugeA gauge is a metric that represents a single numerical value that can arbitrarily go up and down. Gauges are typically used for measured values like temperatures or current memory usage, but also “counts” that can go up and down, like the number of active threads. Gauges are modeled as Recorder with a sample size of 1 and that does not perform any aggregation.
final class TimerA timer collects observations within a time window (usually things like request durations) and provides aggregated information about the data sample, for example, min, max and various quantiles. It is similar to a Recorder but specialized for values that represent durations.
protocol CopyableA type whose values can be implicitly or explicitly copied.
protocol CustomStringConvertibleA type with a customized textual representation.
protocol Escapableprotocol Sendableconvenience init(label: String, dimensions: [(String, String)] = [], aggregate: Bool = true) Create a new Recorder.
init(label: String, dimensions: [(String, String)], aggregate: Bool, handler: RecorderHandler) Alternative way to create a new Recorder, while providing an explicit RecorderHandler.
let _handler: RecorderHandler_handler is only public to allow access from MetricsTestKit. Do not consider it part of the public API.
let aggregate: Boolvar description: String { get }let dimensions: [(String, String)]let label: Stringfunc destroy() Signal the underlying metrics library that this recorder will never be updated again. In response the library MAY decide to eagerly release any resources held by this Recorder.
func record<DataType>(_ value: DataType) where DataType : BinaryFloatingPoint Record a value.
func record<DataType>(_ value: DataType) where DataType : BinaryInteger Record a value.