What's Changed

• Raise minimum swift version to 5.8 by @PeterAdams-A in https://github.com/apple/swift-metrics/pull/147
• Add missing Sendable annotations by @FranzBusch in https://github.com/apple/swift-metrics/pull/148
• Fix Sendability warnings by @gjcairo in https://github.com/apple/swift-metrics/pull/137

New Contributors

• @PeterAdams-A made their first contribution in https://github.com/apple/swift-metrics/pull/147

Full Changelog: https://github.com/apple/swift-metrics/compare/2.4.4...2.5.0

What's Changed

• fix availability of record(:Duration) API by @ktoso in https://github.com/apple/swift-metrics/pull/146

Full Changelog: https://github.com/apple/swift-metrics/compare/2.4.3...2.4.4

Source break fix

This release fixes a minor source break caused between 2.4.1 and 2.4.2:

The PR https://github.com/apple/swift-metrics/pull/133 introduced the following method:

public func record(_ duration: Duration)

There was already a similar function

public func record(_ duration: DispatchTimeInterval)

This can cause ambiguity for the compiler when using . shortcuts because of an overlap in case names, e.g.

timer.record(.nanoseconds(123)) // <-- ambiguous, is this DispatchTimeInterval or Duration?

This release fixes this by having the new method be called record(duration:).

Fixed by https://github.com/apple/swift-metrics/pull/144 in 2.4.3, please use 2.4.3 instead. Thank you @hamzahrmalik for the diagnosis and fix.

What changed

• Change Timer.record(duration: Duration) signature to avoid source breakage by @hamzahrmalik in https://github.com/apple/swift-metrics/pull/144

Full Changelog: https://github.com/apple/swift-metrics/compare/2.4.2...2.4.3

What's Changed

• Support compiling against Musl by @simonjbeaumont in https://github.com/apple/swift-metrics/pull/142
• Introducing Timer.record(_ duration:), closes #114 by @natikgadzhi in https://github.com/apple/swift-metrics/pull/133
• Add CI for Swift 5.10 by @yim-lee in https://github.com/apple/swift-metrics/pull/138
• Align supported Swift versions with rest of the ecosystem by @FranzBusch in https://github.com/apple/swift-metrics/pull/141
• Update API breakage CI script by @simonjbeaumont in https://github.com/apple/swift-metrics/pull/143

New Contributors

• @natikgadzhi made their first contribution in https://github.com/apple/swift-metrics/pull/133
• @FranzBusch made their first contribution in https://github.com/apple/swift-metrics/pull/141
• @simonjbeaumont made their first contribution in https://github.com/apple/swift-metrics/pull/143

Full Changelog: https://github.com/apple/swift-metrics/compare/2.4.1...2.4.2

What's Changed

• add increment and decrement public API to Meter by @tomerd in https://github.com/apple/swift-metrics/pull/132

Full Changelog: https://github.com/apple/swift-metrics/compare/2.4.0...2.4.1

What's Changed

• Update CI by @yim-lee in https://github.com/apple/swift-metrics/pull/124
• Use UUID instead of NSUUID in MetricsTests by @fabianfett in https://github.com/apple/swift-metrics/pull/126
• Add Package.resolved to .gitignore by @fabianfett in https://github.com/apple/swift-metrics/pull/125
• add "meter" - a new type of metric and metric handler by @tomerd in https://github.com/apple/swift-metrics/pull/123
• Use the MetricsTestKit in the MetricsTests rather than using a copy of the TestMetrics utilities by @hamzahrmalik in https://github.com/apple/swift-metrics/pull/128
• MetricsTestKit: expose all metrics publicly. This allows users to run checks on counters when they might not know the exact label by @hamzahrmalik in https://github.com/apple/swift-metrics/pull/127
• Make 'values' on TestCounter, TestRecorder and TestMeter public by @hamzahrmalik in https://github.com/apple/swift-metrics/pull/129

New Contributors

• @hamzahrmalik made their first contribution in https://github.com/apple/swift-metrics/pull/128

Full Changelog: https://github.com/apple/swift-metrics/compare/2.3.4...2.4.0

What's Changed

• Propagate displayUnit when using MultiplexMetricsHandler by @gjcairo in https://github.com/apple/swift-metrics/pull/122

CI updates

• Add CI for Swift 5.8 and update nightly to Ubuntu 22.04 by @yim-lee in https://github.com/apple/swift-metrics/pull/121

New Contributors

• @gjcairo made their first contribution in https://github.com/apple/swift-metrics/pull/122 - thank you!

Full Changelog: https://github.com/apple/swift-metrics/compare/2.3.3...2.3.4

What's Changed

• Make MetricsFactory Sendable by @fabianfett in https://github.com/apple/swift-metrics/pull/116
• +docc prepare for docc publishing by @ktoso in https://github.com/apple/swift-metrics/pull/118
• Add .spi.yml for Swift Package Index DocC support by @yim-lee in https://github.com/apple/swift-metrics/pull/119

Full Changelog: https://github.com/apple/swift-metrics/compare/2.3.2...2.3.3

What's Changed

• better abstration for MetricsSystem state by @tomerd in https://github.com/apple/swift-metrics/pull/112
• adopt sendable by @tomerd in https://github.com/apple/swift-metrics/pull/109
• Remove testable import from TestMetrics. by @fabianfett in https://github.com/apple/swift-metrics/pull/113

Full Changelog: https://github.com/apple/swift-metrics/compare/2.3.1...2.3.2

What's Changed

• Expose MetricsTestKit as a product by @fabianfett in https://github.com/apple/swift-metrics/pull/111

New Contributors

• @fabianfett made their first contribution in https://github.com/apple/swift-metrics/pull/111

Full Changelog: https://github.com/apple/swift-metrics/compare/2.3.0...2.3.1

• https://github.com/apple/swift-metrics/pull/106 Introduced new MetricsTestKit module that allows asserting certain metrics have been emitted etc.
  • we will provide more documentation soon; meanwhile you can use this test as reference for how to use the testkit here's how one uses it for those curious https://github.com/apple/swift-cluster-membership/blob/main/Tests/SWIMTests/SWIMMetricsTests.swift

New addition allowing for floating point counters. This API will be right away supported by SwiftPrometheus, other libs may follow.

SemVer Minor

New API:

• Add FloatingPointCounter which allows reporting floating point metrics when necessary. Thanks @rauhul!

A minor new API to enable SystemMetrics from the new swift-metrics-extras (coming soon) repository.

SemVer Minor

New API:

• Expose MetricsSystem.withWriterLockso it can be invoked by alternate "bootstrap" functions, such as SystemMetrics; https://github.com/apple/swift-metrics/pull/86 Thanks @MrLotU !

For details on the changes please refer to the 0.2.1 milestone

SemVer Minor

New API:

• Timer.recordInterval(since:) for easier reporting of time since a "start" DispatchTime https://github.com/apple/swift-metrics/pull/83 - thank you @slashmo!

SemVer Patch

• Metrics now include their labels when printed to ease debugging https://github.com/apple/swift-metrics/pull/82

For details on the changes please refer to the 0.2.1 milestone

SemVer Major

• Add microseconds to the TimeUnit enum #64

Important note: The 1.x (previous) version of swift-metrics included a TimeUnit enum which was missing a microseconds case. Since adding a case to an enum is an API breaking change, we needed to release
this change as sever 2.0.0. We also used this opportunity to change the enum to a struct so we can add more time unit without breaking the API. That said, since 1.x and 2.x are almost API compatible, TimeUnit is not used by swift-metrics directly and only used by few libraries that depend on it, most libraries should use the following dependency to avoid a fragmentation of ecosystem:

.package(url: "https://github.com/apple/swift-metrics.git", "1.0.0" ..< "3.0.0")

SemVer Patch

• Update Timer.measure() to use DispatchTime instead of Date #52
• Print correct error message if bootstrap is called multiple times #57
• Improve precondition error messages in Lock functions #58

SemVer Minor

• support preferred display time units for Timers #42

SemVer Patch

• update conduct email group #41
• update conduct email address #44

SemVer Minor

• Add Timer.recordNanoseconds Generic Overload (#28)

SemVer Patch

• Add guards for Int64 overflow in Timer methods
• doc: #26 clarify which init to use, reformat docs for easier noticing this

The initial release

Pre-release of swift-metrics