Move exemplars to separate module

autometrics/src/exemplars/mod.rs

@@ -0,0 +1,12 @@
+//! Attach exemplars to the generated metrics (used for connecting metrics to traces)
+//!
+//! Autometrics integrates with tracing libraries to extract details from the
+//! current span context and attach them as exemplars to the metrics it generates.
+//!
+//! See each of the submodules for details on how to integrate with each tracing library.
+//!
+//! **Note:** This is currently only supported with the `prometheus-client` metrics library,
+//! because that is the only one that currently supports producing metrics with exemplars.
+
+#[cfg(feature = "exemplars-tracing")]
+pub mod tracing;

autometrics/src/integrations/mod.rs

@@ -7,6 +7,3 @@
 pub mod prometheus_client {
     pub use crate::tracker::prometheus_client::REGISTRY;
 }
-
-#[cfg(feature = "exemplars-tracing")]
-pub mod tracing;

autometrics/src/lib.rs

@@ -6,6 +6,8 @@
 #![doc = include_str!("../README.md")]
 
 mod constants;
+#[cfg(feature = "exemplars-tracing")]
+pub mod exemplars;
 pub mod integrations;
 mod labels;
 pub mod objectives;

autometrics/src/tracker/prometheus_client.rs

@@ -1,6 +1,6 @@
 use super::TrackMetrics;
 #[cfg(feature = "exemplars-tracing")]
-use crate::integrations::tracing::get_exemplar;
+use crate::exemplars::tracing::get_exemplar;
 use crate::labels::{BuildInfoLabels, CounterLabels, GaugeLabels, HistogramLabels};
 use crate::{constants::*, HISTOGRAM_BUCKETS};
 use once_cell::sync::Lazy;

examples/tracing/src/main.rs

@@ -1,5 +1,5 @@
 use autometrics::{
-    autometrics, encode_global_metrics, integrations::tracing::AutometricsExemplarExtractor,
+    autometrics, encode_global_metrics, exemplars::tracing::AutometricsExemplarExtractor,
 };
 use tracing::{instrument, trace};
 use tracing_subscriber::{prelude::*, EnvFilter};