feat: macros 💀

Cargo.toml

@@ -44,7 +44,7 @@ analytics = { path = "./crates/analytics", optional = true }
 collections = { path = "./crates/collections", optional = true }
 future = { path = "./crates/future", optional = true }
 geoip = { path = "./crates/geoip", optional = true }
-metrics = { path = "./crates/metrics", optional = true }
+metrics = { package = "wc_metrics", path = "./crates/metrics", optional = true }
 rate_limit = { path = "./crates/rate_limit", optional = true }
 
 [dev-dependencies]

crates/alloc/Cargo.toml

@@ -10,7 +10,7 @@ profiler = ["dep:dhat", "dep:tokio"]
 metrics = ["dep:metrics"]
 
 [dependencies]
-metrics = { path = "../metrics", optional = true }
+metrics = { package = "wc_metrics", path = "../metrics", optional = true }
 tikv-jemallocator = { version = "0.5", features = ["stats"] }
 tikv-jemalloc-ctl = { version = "0.5", features = ["use_std"] }
 serde = { version = "1", features = ["derive"] }

crates/metrics/Cargo.toml

@@ -1,5 +1,5 @@
 [package]
-name = "metrics"
+name = "wc_metrics"
 version = "0.1.0"
 edition = "2021"
 
@@ -8,7 +8,7 @@ default = ["future"]
 future = ["dep:pin-project"]
 
 [dependencies]
-backend = { package = "metrics", version = "0.23" }
+metrics = "0.23"
 smallvec = "1"
 parking_lot = "0.12"
 enum-ordinalize = "4.3"

crates/metrics/src/future.rs

@@ -3,7 +3,15 @@
 //! Usage:
 //!
 //! ```
-//! use metrics::{label_name, BoolLabel, FutureExt, FutureMetrics, LabeledFutureMetrics2, Lazy};
+//! use wc_metrics::{
+//!     self as metrics,
+//!     label_name,
+//!     BoolLabel,
+//!     FutureExt,
+//!     FutureMetrics,
+//!     LabeledFutureMetrics2,
+//!     Lazy,
+//! };
 //!
 //! type MyBoolLabelA = BoolLabel<{ label_name("my_bool_label_a") }>;
 //! type MyBoolLabelB = BoolLabel<{ label_name("my_bool_label_b") }>;
@@ -25,7 +33,7 @@ use {
         sealed::{Attrs, Metric},
         Lazy,
     },
-    backend::{counter, gauge, histogram, Counter, Gauge, Histogram, Label},
+    metrics::{counter, gauge, histogram, Counter, Gauge, Histogram, Label},
     std::{
         future::Future,
         pin::Pin,

crates/metrics/src/label.rs

@@ -4,8 +4,8 @@ use {
         Metric,
     },
     arc_swap::ArcSwap,
-    backend::Label,
     enum_ordinalize::Ordinalize,
+    metrics::Label,
     parking_lot::Mutex,
     smallvec::SmallVec,
     std::{borrow::Borrow, collections::HashMap, marker::PhantomData, sync::Arc},
@@ -157,7 +157,7 @@ where
 /// name should be specified using the following hack:
 ///
 /// ```
-/// use metrics::{label_name, BoolLabel};
+/// use wc_metrics::{label_name, BoolLabel};
 ///
 /// type MyLabel = BoolLabel<{ label_name("my_label") }>;
 /// ```
@@ -229,7 +229,7 @@ where
 /// name should be specified using the following hack:
 ///
 /// ```
-/// use metrics::{label_name, StringLabel};
+/// use wc_metrics::{label_name, StringLabel};
 ///
 /// type MyLabel = StringLabel<{ label_name("my_label") }>;
 /// ```

crates/metrics/src/lazy.rs

@@ -6,7 +6,7 @@ use {
         Metric,
         StaticAttrs,
     },
-    backend::{Counter, Gauge, Histogram, IntoF64},
+    metrics::{Counter, Gauge, Histogram, IntoF64},
     std::sync::OnceLock,
 };
 

crates/metrics/src/lib.rs

@@ -6,21 +6,27 @@
 //! hurting the code ergonomics.
 //!
 //! A trivial atomic counter increment MUST NOT allocate stuff on the heap
-//! (looking at you [`metrics::counter`]) and it SHOULD NOT acquire locks or
-//! do [`HashMap`](std::collections::HashMap) lookups unless absolutely
-//! necessary.
+//! (looking at you [`metrics::counter`] and it SHOULD NOT acquire locks or do
+//! [`HashMap`](std::collections::HashMap) lookups unless absolutely necessary.
 //!
+//! If your metric is only being used once, or you can cache it somewhere
+//! consider using [`counter`], [`gauge`] or [`histogram`] convinience macros.
+//! The macros are completely optional and the machinery can be used
+//! as is without them.
 //!
 //! # Usage
 //!
 //! ```
-//! use metrics::{
-//!     backend::{Counter, Gauge, Histogram},
+//! use wc_metrics::{
+//!     self as metrics,
 //!     enum_ordinalize::Ordinalize,
 //!     label_name,
 //!     BoolLabel,
+//!     Counter,
 //!     Enum,
 //!     EnumLabel,
+//!     Gauge,
+//!     Histogram,
 //!     LabeledCounter2,
 //!     LabeledGauge3,
 //!     LabeledHistogram,
@@ -77,19 +83,20 @@
 //! ```
 
 pub use {
-    backend,
     enum_ordinalize,
     label::{label_name, BoolLabel, Enum, EnumLabel, LabelName, Optional, StringLabel, WithLabel},
     lazy::Lazy,
+    metrics::{self as backend, Counter, Gauge, Histogram},
 };
 use {
-    backend::{Counter, Gauge, Histogram, IntoF64, Label},
     label::{DynamicLabels, Labeled, Labeled2, Labeled3, Labeled4, StaticLabels},
+    metrics::{IntoF64, Label},
     sealed::{Attrs, Decrement, Execute, Increment, Metric, Record, Set},
 };
 
 mod label;
 mod lazy;
+mod macros;
 
 #[cfg(feature = "future")]
 pub mod future;