diff --git a/Cargo.toml b/Cargo.toml index a35d145..26356dd 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -14,6 +14,12 @@ documentation = "https://docs.rs/prometheus-client" default = [] protobuf = ["dep:prost", "dep:prost-types", "dep:prost-build"] +# This feature provides additional interfaces for testing. +# +# NB: Interfaces gated by this feature flag are not subject to stability +# guarantees and may be changed or removed in patch releases. +test-util = [] + [workspace] members = ["derive-encode"] diff --git a/src/lib.rs b/src/lib.rs index cfff623..9d2bf3a 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -77,6 +77,12 @@ //! ``` //! See [examples] directory for more. //! +//! # Features +//! +//! The `test-util` gates additional interfaces, such as accessors, to facilitate integration and +//! unit testing of metrics. Note that interfaces gated by this feature flag are not subject to +//! stability guarantees and may be changed or removed in patch releases. +//! //! [examples]: https://github.com/prometheus/client_rust/tree/master/examples pub mod collector;