A 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.
final class TimerThis is the user-facing Timer API.
Its behavior depends on the TimerHandler 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.
class RecorderA 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.
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.
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)] = []) Create a new Timer.
init(label: String, dimensions: [(String, String)], handler: TimerHandler) Alternative way to create a new Timer, while providing an explicit TimerHandler.
convenience init(label: String, dimensions: [(String, String)] = [], preferredDisplayUnit displayUnit: TimeUnit) Create a new Timer.
let _handler: TimerHandler_handler is only public to allow access from MetricsTestKit. Do not consider it part of the public API.
var description: String { get }let dimensions: [(String, String)]let label: Stringfunc destroy() Signal the underlying metrics library that this timer will never be updated again. In response the library MAY decide to eagerly release any resources held by this Timer.
func recordMicroseconds<DataType>(_ duration: DataType) where DataType : BinaryFloatingPoint Record a duration in microseconds.
func recordMicroseconds<DataType>(_ duration: DataType) where DataType : BinaryInteger Record a duration in microseconds.
func recordMilliseconds<DataType>(_ duration: DataType) where DataType : BinaryFloatingPoint Record a duration in milliseconds.
func recordMilliseconds<DataType>(_ duration: DataType) where DataType : BinaryInteger Record a duration in milliseconds.
func recordNanoseconds(_ duration: Int64) Record a duration in nanoseconds.
func recordNanoseconds<DataType>(_ duration: DataType) where DataType : BinaryInteger Record a duration in nanoseconds.
func recordSeconds<DataType>(_ duration: DataType) where DataType : BinaryFloatingPoint Record a duration in seconds.
func recordSeconds<DataType>(_ duration: DataType) where DataType : BinaryInteger Record a duration in seconds.
import MetricsA Metrics API package for Swift.
static func measure<T>(label: String, dimensions: [(String, String)] = [], body: @escaping () throws -> T) rethrows -> T Convenience for measuring duration of a closure.
func measure<Result, Failure, Clock>(clock: Clock = .continuous, body: () throws(Failure) -> Result) throws(Failure) -> Result where Failure : Error, Clock : Clock, Clock.Duration == Duration Convenience for measuring duration of a closure.
func measure<Result, Failure, Clock>(clock: Clock = .continuous, isolation: isolated (any Actor)? = #isolation, body: () async throws(Failure) -> sending Result) async throws(Failure) -> sending sending Result where Failure : Error, Clock : Clock, Clock.Duration == Duration Convenience for measuring duration of a closure.
func record(_ duration: DispatchTimeInterval) Convenience for recording a duration based on DispatchTimeInterval.
func record(_ duration: TimeInterval) Convenience for recording a duration based on TimeInterval.
func record(duration: Duration) Convenience for recording a duration based on Duration.
func recordInterval(since: DispatchTime, end: DispatchTime = .now()) Record the time interval (with nanosecond precision) between the passed since dispatch time and end dispatch time.