changelogs and some docs

metrics-rs · Sep 21, 2024 · a270732 · a270732
1 parent fa95f3a
commit a270732
Show file tree

Hide file tree

Showing 8 changed files with 57 additions and 1 deletion.
diff --git a/metrics-exporter-prometheus/CHANGELOG.md b/metrics-exporter-prometheus/CHANGELOG.md
@@ -8,6 +8,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased] - ReleaseDate
 
+### Added
+
+- Added `Debug` derive to numerous types. ([#504](https://github.com/metrics-rs/metrics/pull/504))
+
+### Changed
+
+- Fixed a number of Clippy lints. ([#510](https://github.com/metrics-rs/metrics/pull/510))
+
 ## [0.15.3] - 2024-07-13
 
 Republishing 0.15.2 as 0.15.3 to fix an incorrect publish.

diff --git a/metrics-exporter-tcp/CHANGELOG.md b/metrics-exporter-tcp/CHANGELOG.md
@@ -8,6 +8,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased] - ReleaseDate
 
+### Added
+
+- Added `Debug` derive to numerous types. ([#504](https://github.com/metrics-rs/metrics/pull/504))
+
+### Changed
+
+- Updated `mio` to `1.0`.
+
 ## [0.10.0] - 2024-05-27
 
 ### Changed

diff --git a/metrics-exporter-tcp/Cargo.toml b/metrics-exporter-tcp/Cargo.toml
@@ -22,7 +22,7 @@ bytes = { version = "1", default-features = false }
 crossbeam-channel = { version = "0.5", default-features = false, features = ["std"] }
 prost = { version = "0.12", default-features = false }
 prost-types = { version = "0.12", default-features = false, features = ["std"] }
-mio = { version = "0.8", default-features = false, features = ["os-poll", "net"] }
+mio = { version = "1.0", default-features = false, features = ["os-poll", "net"] }
 tracing = { version = "0.1", default-features = false, features = ["attributes"] }
 
 [build-dependencies]

diff --git a/metrics-observer/CHANGELOG.md b/metrics-observer/CHANGELOG.md
@@ -8,6 +8,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased] - ReleaseDate
 
+### Changed
+
+- Switched from `tui` to `ratatui`. ([#505](https://github.com/metrics-rs/metrics/pull/505))
+- Bump MSRV to 1.74.0.
+
 ## [0.4.0] - 2024-05-27
 
 ### Changed

diff --git a/metrics-tracing-context/CHANGELOG.md b/metrics-tracing-context/CHANGELOG.md
@@ -8,6 +8,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased] - ReleaseDate
 
+### Added
+
+- Added `Debug` derive to numerous types. ([#504](https://github.com/metrics-rs/metrics/pull/504))
+
+### Changed
+
+- Fixed a number of Clippy lints. ([#510](https://github.com/metrics-rs/metrics/pull/510))
+
 ## [0.16.0] - 2024-05-27
 
 ### Changed

diff --git a/metrics-util/CHANGELOG.md b/metrics-util/CHANGELOG.md
@@ -9,6 +9,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased] - ReleaseDate
 
+### Added
+
+- Added `Debug` derive to numerous types. ([#504](https://github.com/metrics-rs/metrics/pull/504))
+
+### Changed
+
+- Replaced `num_cpus::get` with `std::thread::available_parallelism`.
+  ([#500](https://github.com/metrics-rs/metrics/pull/500))
+- Fixed a number of Clippy lints. ([#510](https://github.com/metrics-rs/metrics/pull/510))
+- Added `Sync` constraint to generic parameter in `RecoverableRecorder` and `Stack`. ([#511](https://github.com/metrics-rs/metrics/pull/511))
+
 ## [0.17.0] - 2024-05-27
 
 ### Changed

diff --git a/metrics/CHANGELOG.md b/metrics/CHANGELOG.md
@@ -8,6 +8,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased] - ReleaseDate
 
+### Added
+
+- Added `Debug` derive to numerous types. ([#504](https://github.com/metrics-rs/metrics/pull/504))
+
+### Changed
+
+- Changed `Unit::Gigibytes` to `Gibibytes` to match the proper SI prefix.
+  ([#508](https://github.com/metrics-rs/metrics/pull/508))
+- Fixed a number of Clippy lints. ([#510](https://github.com/metrics-rs/metrics/pull/510))
+- Updated the documentation for `with_local_recorder` to better explain limitations.
+- `set_global_recorder` now requires that the recorder is `Sync`. ([#511](https://github.com/metrics-rs/metrics/pull/511))
+
 ## [0.23.0] - 2024-05-27
 
 ### Added

diff --git a/metrics/src/recorder/mod.rs b/metrics/src/recorder/mod.rs
@@ -110,6 +110,10 @@ where
 }
 
 /// Runs the closure with the given recorder set as the global recorder for the duration.
+///
+/// This only applies as long as the closure is running, and on the thread where `with_local_recorder` is called. This
+/// does not extend to other threads, and so is not suitable for capturing metrics in asynchronous code where multiple
+/// threads are involved.
 pub fn with_local_recorder<T>(recorder: &dyn Recorder, f: impl FnOnce() -> T) -> T {
     let _local = LocalRecorderGuard::new(recorder);
     f()