Add toggleable default metrics

Author: jasgin

examples/pokemon-service/src/main.rs

@@ -111,6 +111,7 @@ pub async fn main() {
         .expect("failed to build an instance of PokemonService");
 
     let metrics_layer = MetricsLayer::new();
+
     let service = metrics_layer.layer(app);
 
     // Using `IntoMakeServiceWithConnectInfo`, rather than `into_make_service`, to adjoin the `SocketAddr`

rust-runtime/aws-smithy-http-server-metrics/src/default.rs

@@ -1,4 +1,5 @@
 use metrique::Slot;
+use metrique::SlotGuard;
 use metrique_macro::metrics;
 
 #[metrics]
@@ -24,3 +25,28 @@ pub struct DefaultRequestMetrics {
 pub struct DefaultResponseMetrics {
     pub(crate) http_status_code: Option<u16>,
 }
+
+#[derive(Default, Clone)]
+pub(crate) struct DefaultRequestMetricsConfig {
+    pub(crate) disable_all: bool,
+    pub(crate) disable_request_id: bool,
+    pub(crate) disable_operation_name: bool,
+    pub(crate) disable_service_name: bool,
+    pub(crate) disable_service_version: bool,
+}
+
+#[derive(Default, Clone)]
+pub(crate) struct DefaultResponseMetricsConfig {
+    pub(crate) disable_all: bool,
+    pub(crate) disable_http_status_code: bool,
+}
+
+pub(crate) struct DefaultRequestMetricsExtension {
+    pub(crate) metrics: SlotGuard<DefaultRequestMetrics>,
+    pub(crate) config: DefaultRequestMetricsConfig,
+}
+
+pub(crate) struct DefaultResponseMetricsExtension {
+    pub(crate) metrics: SlotGuard<DefaultResponseMetrics>,
+    pub(crate) config: DefaultResponseMetricsConfig,
+}

rust-runtime/aws-smithy-http-server-metrics/src/layer.rs

@@ -7,17 +7,18 @@ use http::Response;
 use metrique::AppendAndCloseOnDrop;
 use metrique::DefaultSink;
 use metrique::RootEntry;
-use metrique::ServiceMetrics;
 use metrique::writer::EntrySink;
 use metrique_core::CloseEntry;
-use metrique_writer::GlobalEntrySink;
 use tower::Layer;
 
+use crate::DefaultInit;
+use crate::DefaultRq;
+use crate::DefaultRs;
 use crate::ReqBody;
 use crate::ResBody;
 use crate::default::DefaultMetrics;
-use crate::layer::builder::DefaultRequestMetricsConfig;
-use crate::layer::builder::DefaultResponseMetricsConfig;
+use crate::default::DefaultRequestMetricsConfig;
+use crate::default::DefaultResponseMetricsConfig;
 use crate::layer::builder::MetricsLayerBuilder;
 use crate::layer::builder::NeedsInitialization;
 use crate::service::MetricsLayerService;
@@ -27,9 +28,9 @@ pub mod builder;
 pub struct MetricsLayer<
     E = DefaultMetrics,
     S = DefaultSink,
-    I = fn() -> AppendAndCloseOnDrop<E, S>,
-    Rq = fn(&mut Request<ReqBody>, &mut AppendAndCloseOnDrop<E, S>),
-    Rs = fn(&mut Response<ResBody>, &mut AppendAndCloseOnDrop<E, S>),
+    I = DefaultInit<E, S>,
+    Rq = DefaultRq<E, S>,
+    Rs = DefaultRs<E, S>,
 > where
     E: CloseEntry + Send + Sync + 'static,
     S: EntrySink<RootEntry<E::Closed>> + Send + Sync + 'static,
@@ -38,36 +39,36 @@ pub struct MetricsLayer<
     Rs: Fn(&mut Response<ResBody>, &mut AppendAndCloseOnDrop<E, S>) + Clone + Send + Sync + 'static,
 {
     pub(crate) init_metrics: I,
-    pub(crate) default_req_metrics_extension_fn:
-        fn(&mut Request<ReqBody>, &mut AppendAndCloseOnDrop<E, S>),
-    pub(crate) default_res_metrics_extension_fn:
-        fn(&mut Response<ResBody>, &mut AppendAndCloseOnDrop<E, S>),
     pub(crate) set_request_metrics: Option<Rq>,
     pub(crate) set_response_metrics: Option<Rs>,
+    pub(crate) default_req_metrics_extension_fn:
+        fn(&mut Request<ReqBody>, &mut AppendAndCloseOnDrop<E, S>, DefaultRequestMetricsConfig),
+    pub(crate) default_res_metrics_extension_fn:
+        fn(&mut Response<ResBody>, &mut AppendAndCloseOnDrop<E, S>, DefaultResponseMetricsConfig),
+    pub(crate) default_req_metrics_config: DefaultRequestMetricsConfig,
+    pub(crate) default_res_metrics_config: DefaultResponseMetricsConfig,
 }
 impl MetricsLayer {
-    pub fn new() -> Self {
-        Self::builder()
-            .init_metrics(|| DefaultMetrics::default().append_on_drop(ServiceMetrics::sink()))
-            .build()
+    pub fn new() -> MetricsLayer {
+        Self::builder().init_with_defaults().build()
     }
 }
 
 impl<E, S, I, Rq, Rs> MetricsLayer<E, S, I, Rq, Rs>
 where
+    E: CloseEntry + Send + Sync + 'static,
+    S: EntrySink<RootEntry<E::Closed>> + Send + Sync + 'static,
     I: Fn() -> AppendAndCloseOnDrop<E, S> + Clone + Send + Sync + 'static,
     Rq: Fn(&mut Request<ReqBody>, &mut AppendAndCloseOnDrop<E, S>) + Clone + Send + Sync + 'static,
     Rs: Fn(&mut Response<ResBody>, &mut AppendAndCloseOnDrop<E, S>) + Clone + Send + Sync + 'static,
-    E: CloseEntry + Send + Sync + 'static,
-    S: EntrySink<RootEntry<E::Closed>> + Send + Sync + 'static,
 {
     pub fn builder() -> MetricsLayerBuilder<NeedsInitialization, E, S, I, Rq, Rs> {
         MetricsLayerBuilder {
             init_metrics: None,
             set_request_metrics: None,
             set_response_metrics: None,
-            default_request_metrics_config: DefaultRequestMetricsConfig::default(),
-            default_response_metrics_config: DefaultResponseMetricsConfig::default(),
+            default_req_metrics_config: DefaultRequestMetricsConfig::default(),
+            default_res_metrics_config: DefaultResponseMetricsConfig::default(),
             _state: PhantomData,
         }
     }
@@ -76,22 +77,24 @@ where
 impl<Ser, E, S, I, Rq, Rs> Layer<Ser> for MetricsLayer<E, S, I, Rq, Rs>
 where
     Ser: Clone,
+    E: CloseEntry + Send + Sync + 'static,
+    S: EntrySink<RootEntry<E::Closed>> + Send + Sync + 'static,
     I: Fn() -> AppendAndCloseOnDrop<E, S> + Clone + Send + Sync + 'static,
     Rq: Fn(&mut Request<ReqBody>, &mut AppendAndCloseOnDrop<E, S>) + Clone + Send + Sync + 'static,
     Rs: Fn(&mut Response<ResBody>, &mut AppendAndCloseOnDrop<E, S>) + Clone + Send + Sync + 'static,
-    E: CloseEntry + Send + Sync + 'static,
-    S: EntrySink<RootEntry<E::Closed>> + Send + Sync + 'static,
 {
-    type Service = MetricsLayerService<Ser, I, Rq, Rs, E, S>;
+    type Service = MetricsLayerService<Ser, E, S, I, Rq, Rs>;
 
     fn layer(&self, inner: Ser) -> Self::Service {
         MetricsLayerService {
             inner,
             init_metrics: self.init_metrics.clone(),
-            default_req_metrics_extension_fn: self.default_req_metrics_extension_fn,
-            default_res_metrics_extension_fn: self.default_res_metrics_extension_fn,
             set_request_metrics: self.set_request_metrics.clone(),
             set_response_metrics: self.set_response_metrics.clone(),
+            default_req_metrics_extension_fn: self.default_req_metrics_extension_fn.clone(),
+            default_res_metrics_extension_fn: self.default_res_metrics_extension_fn.clone(),
+            default_req_metrics_config: self.default_req_metrics_config.clone(),
+            default_res_metrics_config: self.default_res_metrics_config.clone(),
         }
     }
 }