diff --git a/CHANGELOG.md b/CHANGELOG.md index 47094bce..4aefd815 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -30,6 +30,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - **Breaking**: Make `zfp` a private dependency by changing `Zfp{Bitstream,Field,Stream}` from `pub` to `pub(super)` - **Breaking**: Make `zip` a private dependency by not exposing `ZipError` in `ZipStorageAdapterCreateError` - Refine `UsageLogStorageTransformer` outputs and add docs + - Improve `PerformanceMetricsStorageTransformer` docs ### Removed - **Breaking**: Remove `StorePrefixError::new`, deprecated since `v0.7.3` diff --git a/src/storage/storage_transformer/performance_metrics.rs b/src/storage/storage_transformer/performance_metrics.rs index efb565a3..7866e25e 100644 --- a/src/storage/storage_transformer/performance_metrics.rs +++ b/src/storage/storage_transformer/performance_metrics.rs @@ -25,7 +25,10 @@ use std::sync::{ use super::StorageTransformerExtension; -/// The performance metrics storage transformer. +/// The performance metrics storage transformer. Accumulates metrics, such as bytes read and written. +/// +/// This storage transformer is for internal use and will not to be included in `storage_transformers` array metadata. +/// It is intended to aid in testing by allowing the application to validate that metrics (e.g., bytes read/written, total read/write operations, lock requests) match expected values for specific operations. #[derive(Debug, Default)] pub struct PerformanceMetricsStorageTransformer { bytes_read: AtomicUsize, @@ -79,6 +82,7 @@ impl PerformanceMetricsStorageTransformer { } impl StorageTransformerExtension for PerformanceMetricsStorageTransformer { + /// Returns [`None`], since this storage transformer is not intended to be included in array `storage_transformers` metadata. fn create_metadata(&self) -> Option { None }