resolve comments

src/common/src/metrics.rs

@@ -49,24 +49,26 @@ impl Atomic for TrAdderAtomic {
 
 pub type TrAdderGauge = GenericGauge<TrAdderAtomic>;
 
-pub struct CustomLayer {
+/// [`MetricsLayer`] is a struct used for monitoring the frequency of certain specific logs and
+/// counting them using Prometheus metrics. Currently, it is used to monitor the frequency of retry
+/// occurrences of aws sdk.
+pub struct MetricsLayer {
     pub aws_sdk_retry_counts: GenericCounter<AtomicU64>,
 }
 
-impl<S> Layer<S> for CustomLayer
+impl<S> Layer<S> for MetricsLayer
 where
     S: Subscriber + for<'a> LookupSpan<'a>,
 {
     fn on_event(&self, _event: &tracing::Event<'_>, _ctx: Context<'_, S>) {
         // Currently one retry will only generate one debug log,
         // so we can monitor the number of retry only through the metadata target.
         // Refer to <https://docs.rs/aws-smithy-client/0.55.3/src/aws_smithy_client/retry.rs.html>
-
         self.aws_sdk_retry_counts.inc();
     }
 }
 
-impl CustomLayer {
+impl MetricsLayer {
     pub fn new(registry: Registry) -> Self {
         let aws_sdk_retry_counts = register_int_counter_with_registry!(
             "aws_sdk_retry_counts",

src/utils/runtime/src/lib.rs

@@ -21,7 +21,7 @@ use std::path::PathBuf;
 use std::time::Duration;
 
 use futures::Future;
-use risingwave_common::metrics::CustomLayer;
+use risingwave_common::metrics::MetricsLayer;
 use tracing::Level;
 use tracing_subscriber::filter::{Directive, Targets};
 use tracing_subscriber::layer::SubscriberExt;
@@ -282,7 +282,7 @@ pub fn init_risingwave_logger(settings: LoggerSettings, registry: prometheus::Re
 
     let filter = filter::Targets::new().with_target("aws_smithy_client::retry", Level::DEBUG);
 
-    layers.push(Box::new(CustomLayer::new(registry).with_filter(filter)));
+    layers.push(Box::new(MetricsLayer::new(registry).with_filter(filter)));
     tracing_subscriber::registry().with(layers).init();
 
     // TODO: add file-appender tracing subscriber in the future