StatsdClient is a metrics backend for SwiftMetrics, designed to integrate applications with observability servers that support statsd protocol. The client uses SwiftNIO to establish a UDP connection to the statsd server.
final class StatsdClientimport StatsdClientA metrics backend implementation using the StatsD protocol.
protocol MetricsFactory : _SwiftMetricsSendableProtocolThe MetricsFactory is the bridge between the MetricsSystem and the metrics backend implementation. MetricsFactory’s role is to initialize concrete implementations of the various metric types:
protocol Sendable@preconcurrency protocol _SwiftMetricsSendableProtocol : Sendableinit(eventLoopGroupProvider: EventLoopGroupProvider = .createNew, host: String, port: Int, metricNameSanitizer: @escaping StatsdClient.MetricNameSanitizer = StatsdClient.defaultMetricNameSanitizer) throws Create a new instance of StatsdClient.
static let defaultMetricNameSanitizer: StatsdClient.MetricNameSanitizerDefault implementation of LabelSanitizer that sanitizes any “:” occurrences by replacing them with a replacement character. Defaults to replacing the illegal characters with “_”, e.g. “offending:example” becomes “offending_example”.
func destroyCounter(_ handler: CounterHandler) func destroyMeter(_ handler: MeterHandler) func destroyRecorder(_ handler: RecorderHandler) func destroyTimer(_ handler: TimerHandler) func makeCounter(label: String, dimensions: [(String, String)]) -> CounterHandler func makeMeter(label: String, dimensions: [(String, String)]) -> MeterHandler func makeRecorder(label: String, dimensions: [(String, String)], aggregate: Bool) -> RecorderHandler func makeTimer(label: String, dimensions: [(String, String)]) -> TimerHandler @preconcurrency func shutdown(_ callback: @escaping (Error?) -> Void) Shutdown the client. This is a noop when using the shared(_:) strategy.
enum EventLoopGroupProviderA EventLoopGroupProvider defines how the underlying EventLoopGroup used to create the EventLoop is provided.
typealias MetricNameSanitizer = (String) -> StringUsed to sanitize labels (and dimensions) into a format compatible with statsd’s wire format.
func destroyFloatingPointCounter(_ handler: FloatingPointCounterHandler) Invoked when the corresponding FloatingPointCounter’s destroy() function is invoked. Upon receiving this signal the factory may eagerly release any resources related to this counter.
func makeFloatingPointCounter(label: String, dimensions: [(String, String)]) -> FloatingPointCounterHandler Create a default backing FloatingPointCounterHandler for backends which do not naively support floating point counters.