2.0.0

Highlights

The 2.0 release brings new and improved APIs which provide a more correct user-experience and overall higher performance.

This release is a major version that contains breaking changes compared to the 1.x versions:

• PrometheusClient has been renamed to PrometheusCollectorRegistry
  • Most method names on PrometheusCollectorRegistry have been changed as well createMetric has been renamed to makeMetric in most cases
• Summaries are no longer supported
• The PromMetric protocol has been removed
• The Collector types are no longer prefixed with Prom

Please refer to our [documentation] hosted on the Swift Package Index for more details regarding the new API.

What's Changed (since 1.x series)

• Add package index config file, so docs are generated by @ktoso in #85
• Remove FUNDING.yml by @fabianfett in #88
• Remove Package.resolved from repo by @fabianfett in #87
• Remove XCTestManifest & LinuxMain by @fabianfett in #89
• Prepare Dockerfiles and scripts for swift-server CI by @fabianfett in #90
• Remove GitHub actions CI by @fabianfett in #91
• New Version 2.0 API by @fabianfett in #92
• Remove .jazzy.yaml by @fabianfett in #96
• Rename .spi.yaml to .spi.yml by @finestructure in #99
• Gauge implements MeterHandler by @fabianfett in #97
• Don't require to pass a registry on MetricsFactory initialization by @fabianfett in #98
• Add docs for version 2.0 by @fabianfett in #100
• Document how to use labels by @fabianfett in #101
• Rename destroyMetric to unregisterMetric by @fabianfett in #102
• Update README.md by @sbeitzel in #105
• Switch from swiftformat to swift-format by @armandgrillet in #107
• Fix: MetricSystem => MetricsSystem by @yeahdongcn in #108
• Rename unregisterTimeHistogram to unregisterDurationHistogram by @simonjbeaumont in #109
• Unregister the metric fully when last labelled metric is unregistered by @simonjbeaumont in #110
• Add missing call to label customization closure for meter by @simonjbeaumont in #111
• Fix recommended email in security guidelines by @ktoso in #112

See also: 2.0.0-alpha.1, 2.0.0-alpha.2 for the previous alpha releases of the 2.x series.

New Contributors

• @finestructure made their first contribution in #99
• @sbeitzel made their first contribution in #105
• @armandgrillet made their first contribution in #107
• @yeahdongcn made their first contribution in #108
• @simonjbeaumont made their first contribution in #109

Full Changelog: 1.0.2...2.0.0

2.0.0-alpha.2

Security Vulnerability Report

• Un-sanitized metric name or labels can be used to take over exported metrics GHSA-x768-cvr2-345r

What's Changed

• Rename destroyMetric to unregisterMetric by @fabianfett in #102
• Update README.md by @sbeitzel in #105
• Switch from swiftformat to swift-format by @armandgrillet in #107
• Fix: MetricSystem => MetricsSystem by @yeahdongcn in #108
• Rename unregisterTimeHistogram to unregisterDurationHistogram by @simonjbeaumont in #109
• Unregister the metric fully when last labelled metric is unregistered by @simonjbeaumont in #110
• Add missing call to label customization closure for meter by @simonjbeaumont in #111
• Fix recommended email in security guidelines by @ktoso in #112

New Contributors

• @sbeitzel made their first contribution in #105
• @armandgrillet made their first contribution in #107
• @yeahdongcn made their first contribution in #108
• @simonjbeaumont made their first contribution in #109

Full Changelog: 2.0.0-alpha.1...2.0.0-alpha.2

Swift Prometheus 2.0.0 Alpha 1

🚨 Breaking changes

This 2.0 pre-release contains breaking changes compared to the current released version 1.x:

• PrometheusClient has been renamed to PrometheusCollectorRegistry
  • Most method names on PrometheusCollectorRegistry have been changed as well createMetric has been renamed to makeMetric in most cases
• Summaries are no longer supported
• The PromMetric protocol has been removed
• The Collector types are no longer prefixed with Prom

Please refer to our documentation hosted on the Swift Package Index for more details regarding the new API.

Changes

SemVer Major

• New Version 2.0 API (#92, #97, #98)

Other changes

• Add package index config file, so docs are generated (#85, #99 patch credit @finestructure)
• Remove FUNDING.yml (#88)
• Remove Package.resolved (#87)
• Remove XCTestManifest & LinuxMain (#89)
• Prepare Dockerfiles and scripts for swift-server CI (#90)
• Remove GitHub actions CI (#91)
• Remove .jazzy.yaml (#96)
• Add docc documentation (#100, #101)

1.0.2

Patch fixes

• Solved race condition in sub-summary #79
  • thank you for the contribution @blindspotbounty

Full Changelog: 1.0.1...1.0.2

1.0.1

What's Changed

• Add missing availability annotations by @rauhul in #71
• Remove unused weak references by @fabianfett in #76
• Fix Histogram Concurrency Issue by @Sam-Amin in #78

New Contributors

• @fabianfett made their first contribution in #76
• @Sam-Amin made their first contribution in #78

Full Changelog: 1.0.0...1.0.1

V 1.0.0

SemVer Minor

• Add Async/Await collect APIs (#67, @MrLotU )

SemVer Patch

• Fix Display Unit (#64, @avolokhov )
• Remove labels parametrisation (#63 , @avolokhov )
• Sanitize Dimensions (#68 , @0xTim )

V 1.0.0 Alpha 15

SemVer Patch

• Finer concurrency in 'MetricType.observe' / 'MetricType.collect' (#59, @avolokhov )
• Make metrics collection independent from metrics creation (#60, @avolokhov )
• Move labels equality check out of critical section in summary/histogram (#61, @avolokhov )

V 1.0.0 Alpha 14

SemVer Minor

• Add native support for floating point counter (#55, @MrLotU)

V 1.0.0 Alpha 13

SemVer Minor

• Introduce PromSummary.capacity to improve performance (#57, @wacumov)

V 1.0.0 Alpha 12.1

SemVer Patch

• Fix bug in DimensionLabel equality. (daf102f)