Merged
Conversation
Removed the `new` method from `MetricsCell` to simplify its usage, as it is now directly initialized with a `Cell<u64>`. Updated the documentation for `metrics_impl.rs` to provide clearer insights into the metrics structures and their visibility, emphasizing the encapsulation of internal metrics management. Added concise summaries for each metrics struct to improve clarity and usability.
Introduced optional `serde` dependency for cache metrics snapshots, enabling serialization and deserialization of metrics structures. Enhanced documentation for `CacheMetricsSnapshot` and other metrics structs to clarify their purpose and usage, including examples demonstrating serialization capabilities. This change improves usability and facilitates integration with external systems requiring metrics data in a serialized format.
Added example usage for `CoreMetricsRecorder` and its related traits, improving the documentation for cache metrics. Clarified the purpose of each metrics trait and their relationships, including references to mutable and read-only counterparts. This change enhances usability and understanding of the metrics system within the cache library.
Replaced the `iter_entries` method with `iter` in the frequency buckets property tests to ensure accurate minimum frequency calculations. This change aligns with recent updates to the `FrequencyBuckets` module, enhancing consistency and correctness in the test implementation.
Updated the documentation for `MetricsCell` in `metrics_impl.rs` to include a direct reference to its location within the module. This change enhances clarity regarding the internal structure and visibility of the metrics management system, ensuring users understand the encapsulation of internal metrics management.
Updated the documentation for `MetricsCell` in `metrics_impl.rs` to remove redundant phrasing, enhancing clarity regarding its usage and visibility within the module. This change aims to improve understanding of the internal metrics management system.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Related Issue
Fixes #
Type of Change
How Has This Been Tested?
Test environment:
Checklist
cargo fmtandcargo clippycargo test)Screenshots (if applicable)
Additional Notes