From 25c8bcbc0a1632906209b1787761a8184cdfa7cb Mon Sep 17 00:00:00 2001 From: "peter.leeh" Date: Sat, 4 Jan 2025 11:10:08 +0100 Subject: [PATCH] bump crate version to 0.8.0; Write the changelog --- CHANGELOG.md | 14 ++++++++++---- Cargo.toml | 2 +- README.md | 5 +++-- src/lib.rs | 4 ++-- 4 files changed, 16 insertions(+), 9 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b199890..b2cbb3b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,17 +4,22 @@ All notable changes to this project will be documented in this file. # [Unreleased] +# [0.8.0] + ### Changed -- Remove the `once_cell` dependency since we are on MSRV 1.75. [\#30] -- Compatibility with `axum = "0.8"`. This also updates `matchit` to `0.8`, changing how group pattern are described: +- Compatibility with `axum = "0.8"`. This also updates `matchit` to `0.8`, changing how group patterns are described: for example, `with_group_patterns_as("/foo", &["/foo/:bar"])` needs to be changed to `with_group_patterns_as("/foo", &["/foo/{bar}"])`. - The metrics values are also impacted: for example, the value `"/foo/:bar"` is now `"/foo/{bar}"`. [\#69] + The metrics values are also impacted: for example, the value `"/foo/:bar"` is now `"/foo/{bar}"`. + This change bumps MSRV to 1.75. [\#69] - Disable the default features in `metrics-exporter-prometheus` to skip the binding of port 9000, and the upkeep task is manually spawned. [\#75] +- Add a new feature `http-listener` to enable that exact feature in `metrics-exporter-prometheus`. [\#79] +- Replace the `once_cell` dependency with `std::sync::OnceLock` [\#78] ### Fixed - Fixed the long-standing pending requests metric leak. [\#74] +- Removed the sideeffect of binding port 9000. [\#75] # [0.7.0] - 2024-07-20 @@ -130,7 +135,7 @@ All notable changes to this project will be documented in this file. First version. -[unreleased]: https://github.com/Ptrskay3/axum-prometheus/compare/release/0.7.0..master +[unreleased]: https://github.com/Ptrskay3/axum-prometheus/compare/release/0.8.0..master [0.2.0]: https://github.com/Ptrskay3/axum-prometheus/compare/9fb600d7d9ac2e6d38e6399119fc7ba7f25d5fe0...756dc67bf2baae2de406e012bdaa2334ce0fcdcb [0.3.0]: https://github.com/Ptrskay3/axum-prometheus/compare/axum-0.6...release/0.3 [0.3.1]: https://github.com/Ptrskay3/axum-prometheus/compare/release/0.3...release/0.3.1 @@ -142,4 +147,5 @@ First version. [0.6.0]: https://github.com/Ptrskay3/axum-prometheus/compare/release/0.5.0...release/0.6.0 [0.6.1]: https://github.com/Ptrskay3/axum-prometheus/compare/release/0.6.0...release/0.6.1 [0.7.0]: https://github.com/Ptrskay3/axum-prometheus/compare/release/0.6.1...release/0.7.0 +[0.8.0]: https://github.com/Ptrskay3/axum-prometheus/compare/release/0.7.0...release/0.8.0 [\#28]: https://github.com/Ptrskay3/axum-prometheus/pull/28 diff --git a/Cargo.toml b/Cargo.toml index 4785da2..449d598 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "axum-prometheus" -version = "0.7.0" +version = "0.8.0" edition = "2021" homepage = "https://github.com/Ptrskay3/axum-prometheus" license = "MIT" diff --git a/README.md b/README.md index 1bfa33f..75b7cc2 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,7 @@ AXUM_HTTP_RESPONSE_BODY_SIZE = "my_app_response_body_size" | `0.5` | `0.1` | | `0.6` | `0.2`, `0.3`, `0.4` | | `0.7` | `0.5`, `0.6`, `0.7` | +| `0.8` | `0.8` | #### MSRV @@ -67,7 +68,7 @@ Add `axum-prometheus` to your `Cargo.toml`. ```toml [dependencies] -axum-prometheus = "0.7.0" +axum-prometheus = "0.8.0" ``` Then you instantiate the prometheus middleware: @@ -134,7 +135,7 @@ This crate currently has no higher level API for the `push-gateway` feature. If This crate may be used with other exporters than Prometheus. First, disable the default features: ```toml -axum-prometheus = { version = "0.7.0", default-features = false } +axum-prometheus = { version = "0.8.0", default-features = false } ``` Then implement the `MakeDefaultHandle` for the provider you'd like to use. For `StatsD`: diff --git a/src/lib.rs b/src/lib.rs index cc6e5d6..09da4f2 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -37,7 +37,7 @@ //! Add `axum-prometheus` to your `Cargo.toml`. //! ```not_rust //! [dependencies] -//! axum-prometheus = "0.7.0" +//! axum-prometheus = "0.8.0" //! ``` //! //! Then you instantiate the prometheus middleware: @@ -98,7 +98,7 @@ //! This crate may be used with other exporters than Prometheus. First, disable the default features: //! //! ```toml -//! axum-prometheus = { version = "0.7.0", default-features = false } +//! axum-prometheus = { version = "0.8.0", default-features = false } //! ``` //! //! Then implement the `MakeDefaultHandle` for the provider you'd like to use. For `StatsD`: