metrics-util

chore: Release metrics-util version 0.20.4

Fixed

• Tightened the metrics dependency constraint to ^0.24.6 so that consumers of metrics-util resolve a fixed metrics. The metrics 0.24.6 release fixes a duplicate-entry regression in metrics::KeyHasher that affected metrics_util::registry::Registry in versions 0.19.0 through 0.20.1. metrics-util 0.20.2+ carries its own no-op KeyHasher and is unaffected by metrics::KeyHasher's behavior, but the dep bump documents the intended pairing. (#694)

chore: Release metrics-util version 0.20.3

Fixed

• Tightened the metrics dependency constraint to ^0.24.5 to avoid build failures when an older metrics 0.24.x is locked. (#692)

chore: Release metrics-util version 0.20.2

Added

• New metrics_util::common::KeyHasher, replacing the now-deprecated metrics::KeyHasher. (#669)
• Drain::count() and Drain::sum() methods to expose true-value counts/sums on reservoir-sampled storage. (#681)
• Blanket Storage<K> implementation for Arc<T> where T: Storage<K>. (#657)
• Summary::sum() method to retrieve the running sum of recorded values. (#650)

Changed

• DebuggingRecorder uses Key::to_retained() for more efficient long-lived key storage. (#688)

Fixed

• Fixed an atomicity violation in AtomicSamplingReservoir::consume. (#606)

Changed

• No changes. This release replaces 0.19.2, as #588 introduced a breaking change that should not have been released as a patch version.

Changed

• Taking a snapshot from DebuggingRecorder now has "consume" semantics for counters and gauges, matching the behavior observed for histograms. (#588)

Fixed

• Use the AtomicU64 type exposed from metrics::atomics in AtomicSamplingReservoir to allow building on 32-bit platforms. (#585)

Changed

• Updated rand to 0.9. (#556)

Added

• Added new module storage -- behind a feature flag of the same name -- which contains all storage implementations such as Summary, Histogram, AtomicBucket, etc.
• Added new histogram storage type, AtomicSamplingReservoir, which provides a memory-bounded histogram storage container utilizing reservoir sampling for statistically accurate sampling.

Changed

• FanoutBuilder and RouterBuilder now both require recorders to be Sync to facilitate usage with being installed as the global recorder.
• Moved AtomicBucket, Histogram, and Summary to new storage module.

Removed

• Removed handles feature which has been subsumed by the new storage feature flag.

Added

• Added Debug derive to numerous types. (#504)

Changed

• Replaced num_cpus::get with std::thread::available_parallelism. (#500)
• Fixed a number of Clippy lints. (#510)
• Added Sync constraint to generic parameter in RecoverableRecorder and Stack. (#511)
• Bump MSRV to 1.71.1. (#530)

Changed

• Bump MSRV to 1.70.0.
• Snapshotter now implements Clone. (#472)
• Relaxed some bounds for different categories of methods on Registry<K, S>. (#484)

Added

• New set of methods on Registry for getting a metric handle if it exists. (#457)
• New set of methods on Registry for retaining metric handles that match a given predicate. (#461)

Fixed

• Bump ahash back to 0.8.8 to remove range constraint after an upstream fix was provided to remove the unnecessary MSRV bump.

Fixed

• Lock down the version of ahash to avoid unnecessary MSRV bumping.

Fixed

• Fixed the Debug implementation for bucket::Block<T> which represented both an unsafe and logically incorrect usage of crossbeam-epoch.

Changed

• Bump MSRV to 1.65.0.
• RecoverableRecorder no longer functions as a drop guard itself, and instead returns a new type, RecoveryHandle<R>, which provides that functionality. (#414)

Removed

• Support for per-thread mode in DebuggingRecorder. Users should now use metrics::with_local_recorder instead, which is inherently per-thread.

Added

• Added a new helper type, RecoverableRecorder, that allows installing a recorder and then recovering it later.

Changed

• Update aho-corasick to 1.0.
• Pinned hashbrown to 0.13.1 to avoid MSRV bump.

Changed

• Bump MSRV to 1.61.0.
• Switch to metrics-exposed version of AtomicU64.

Changed

• Updated sketches-ddsketch to 0.2.0.
• Switched to using portable_atomic for 64-bit atomics on more architectures. (#313)

Fixed

• In Summary, some quantiles were previously mapped to an incorrect rank at low sample counts, leading to large swings in estimated values. (#304)

Changed

• Bumped the dependency on metrics to deal with a public API change.

Added

• A new per-thread mode for DebuggingRecorder that allows recording metrics on a per-thread basis to better supporting the testing of metrics in user applications where many tests are concurrently emitting metrics.

Added

• New storage type, GenerationalStorage, that provides the generational behavior of GenerationalAtomicStorage, nee GenerationalPrimitives, without being inherently coupled to using atomic storage.

Changed

• Renamed Primitives to Storage, and publicly exposed it so that users can implement their own storage strategies.
• Renamed StandardPrimitives and GenerationalPrimitives to AtomicStorage and GenerationalAtomicStorage, respectively.
• Created a new top-level module, registry, that encompasses Registry and all Registry-related and dependent types.
• Exposed DefaultHashable publicly.
• Debugging utilities have been moved to a new debugging module, and Snapshot is now public.

Fixed

• Recency incorrectly failed to keep track of the latest generation when a previously-observed metric had changed generations since the first time it was observed.

Changed

• Updated various dependencies in order to properly scope dependencies to only the necessary feature flags, and thus optimize build times and reduce transitive dependencies.
• Many types are now behind their own feature flags to allow for optimizing build times and dependency tree.
• Updated to the new handle-based design of metrics.
• Updated AtomicBucket to use MaybeUninit and better documented the safety invariants in the various areas that use unsafe.
• AtomicBucket now correctly drops only initialized slots in a Block.

Changed

• Bump atomic-shim from 0.1 to 0.2.

Changed

• Simple release to bump dependencies.

Changed

• Bumped metrics dependency to correspond to the change in key hasher.

Changed

• Pin crossbeam-epoch to the correct version where Atomic::compare_exchange support was added.

Changed

• Reworked Registry to make generation tracking a configurable property at the type level.

Added

• New layer -- Router -- for routing specific metrics to target downstream recorders.
• Registry::clear allows clearing all metrics from the registry.

Changed

• Updated all deprecated usages of crossbeam_epoch::Atomic<T>::compare_and_set to compare_exchange.

Changed

• Switched Registry over to supporting &Key.
• Switched from dashmap to hashbrown/parking_lot for Registry.
• Updated all layers to support the change from Key to &Key in metrics::Recorder.`

Added

• Support for using the pre-hashed value of Key to speed up Registry operations.

Changed

• Fixed issue with ordering on CompositeKey. (#182)

Added

• Added AbsoluteLayer for supporting counters reported via absolute value.

Changed

• Bumped metrics dependency to 0.14.

Changed

• MetricKind is now MetricKindMask, and MetricKind is used to define the source side i.e. MetricKindMask is used to match against MetricKind.

• No changes.

Added

• Added multiple utility layers: prefix, filter, and fanout.
• Added CompositeKey for defining a metric kind/key combination.
• Added Histogram for defining a bucket-based histogram.
• Added Registry for storing metric handles mapped to a given key.
• Added Summary, based on DDSketch, as a more lightweight alternative to hdrhistogram.
• Added DebuggingRecorder to help tet various types that depend on a Recorder.
• Added Recency for tracking idle metrics.

Removed

• Removed StreamingIntegers as we no longer use it, and compressed_vec is a better option.
• Removed MetricsTree as we no longer use it.

Changed

• AtomicBucket now exposes clear and clear_with for both emptying the bucket and reading the values that were cleared, allowing behavior similiar to atomically swapping a fresh data structure in for another.

Changed

• Updated to crossbeam-epoch 0.8 and switched directly to crossbeam-utils for tests.

Added

• MetricTree allows storing hierarchical metric values while being serializable by serde. (#38)

Erroneously bumped/published. No changes.

Added

• StreamingIntegers allows holding a set of integers in a compressed format in-memory. (#13)
• AtomicBucket provides an append-only list of items that can be snapshot without stopping writes. (#13)

Added

• Effective birth of the crate.