From 0d381e74eb6ebcb9a694cb7e9ed9d7070427430d Mon Sep 17 00:00:00 2001 From: koushiro Date: Thu, 1 Aug 2024 12:05:32 +0800 Subject: [PATCH 1/2] fix(layers/prometheus-client): doc link --- core/src/layers/prometheus_client.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/core/src/layers/prometheus_client.rs b/core/src/layers/prometheus_client.rs index 99ac2b35e24a..c350f0b9b38d 100644 --- a/core/src/layers/prometheus_client.rs +++ b/core/src/layers/prometheus_client.rs @@ -37,7 +37,7 @@ use crate::raw::Access; use crate::raw::*; use crate::*; -/// Add [prometheus](https://docs.rs/prometheus) for every operations. +/// Add [prometheus-client](https://docs.rs/prometheus-client) for every operations. /// /// # Examples /// From a0898ec2fce6860bea9d63895615d995ea9e615e Mon Sep 17 00:00:00 2001 From: koushiro Date: Thu, 1 Aug 2024 12:06:34 +0800 Subject: [PATCH 2/2] fix(layers): some typo --- core/src/layers/fastrace.rs | 2 +- core/src/layers/logging.rs | 2 +- core/src/layers/metrics.rs | 2 +- core/src/layers/oteltrace.rs | 2 +- core/src/layers/prometheus.rs | 2 +- core/src/layers/prometheus_client.rs | 4 ++-- core/src/layers/timeout.rs | 2 +- core/src/layers/tracing.rs | 2 +- 8 files changed, 9 insertions(+), 9 deletions(-) diff --git a/core/src/layers/fastrace.rs b/core/src/layers/fastrace.rs index 5e7119a0e5a8..3af23c4be5a0 100644 --- a/core/src/layers/fastrace.rs +++ b/core/src/layers/fastrace.rs @@ -28,7 +28,7 @@ use crate::raw::oio::WriteOperation; use crate::raw::*; use crate::*; -/// Add [fastrace](https://docs.rs/fastrace/) for every operations. +/// Add [fastrace](https://docs.rs/fastrace/) for every operation. /// /// # Examples /// diff --git a/core/src/layers/logging.rs b/core/src/layers/logging.rs index ca45a80f13b5..b56f71645569 100644 --- a/core/src/layers/logging.rs +++ b/core/src/layers/logging.rs @@ -33,7 +33,7 @@ use crate::raw::oio::WriteOperation; use crate::raw::*; use crate::*; -/// Add [log](https://docs.rs/log/) for every operations. +/// Add [log](https://docs.rs/log/) for every operation. /// /// # Logging /// diff --git a/core/src/layers/metrics.rs b/core/src/layers/metrics.rs index 5dc220a123b9..f051df08e797 100644 --- a/core/src/layers/metrics.rs +++ b/core/src/layers/metrics.rs @@ -56,7 +56,7 @@ static LABEL_OPERATION: &str = "operation"; /// The error kind of this failed request. static LABEL_ERROR: &str = "error"; -/// Add [metrics](https://docs.rs/metrics/) for every operations. +/// Add [metrics](https://docs.rs/metrics/) for every operation. /// /// # Metrics /// diff --git a/core/src/layers/oteltrace.rs b/core/src/layers/oteltrace.rs index c03233d12f05..659134377c9d 100644 --- a/core/src/layers/oteltrace.rs +++ b/core/src/layers/oteltrace.rs @@ -31,7 +31,7 @@ use opentelemetry::KeyValue; use crate::raw::*; use crate::*; -/// Add [opentelemetry::trace](https://docs.rs/opentelemetry/latest/opentelemetry/trace/index.html) for every operations. +/// Add [opentelemetry::trace](https://docs.rs/opentelemetry/latest/opentelemetry/trace/index.html) for every operation. /// /// Examples /// diff --git a/core/src/layers/prometheus.rs b/core/src/layers/prometheus.rs index a4359ead7261..44bb2a5eb488 100644 --- a/core/src/layers/prometheus.rs +++ b/core/src/layers/prometheus.rs @@ -37,7 +37,7 @@ use crate::raw::Access; use crate::raw::*; use crate::*; -/// Add [prometheus](https://docs.rs/prometheus) for every operations. +/// Add [prometheus](https://docs.rs/prometheus) for every operation. /// /// # Prometheus Metrics /// diff --git a/core/src/layers/prometheus_client.rs b/core/src/layers/prometheus_client.rs index c350f0b9b38d..b4f01244f2a5 100644 --- a/core/src/layers/prometheus_client.rs +++ b/core/src/layers/prometheus_client.rs @@ -37,7 +37,7 @@ use crate::raw::Access; use crate::raw::*; use crate::*; -/// Add [prometheus-client](https://docs.rs/prometheus-client) for every operations. +/// Add [prometheus-client](https://docs.rs/prometheus-client) for every operation. /// /// # Examples /// @@ -88,7 +88,7 @@ pub struct PrometheusClientLayer { impl PrometheusClientLayer { /// Create PrometheusClientLayer while registering itself to this registry. Please keep in caution - /// that do NOT call this method multiple times with a same registry. If you want initialize multiple + /// that do NOT call this method multiple times with a same registry. If you want to initialize multiple /// [`PrometheusClientLayer`] with a single registry, you should use [`Arc::clone`] instead. pub fn new(registry: &mut Registry) -> Self { let metrics = PrometheusClientMetricDefinitions::register(registry); diff --git a/core/src/layers/timeout.rs b/core/src/layers/timeout.rs index 095d1044fd5a..b57ca8541338 100644 --- a/core/src/layers/timeout.rs +++ b/core/src/layers/timeout.rs @@ -25,7 +25,7 @@ use crate::raw::oio::WriteOperation; use crate::raw::*; use crate::*; -/// Add timeout for every operations to avoid slow or unexpected hang operations. +/// Add timeout for every operation to avoid slow or unexpected hang operations. /// /// For example, a dead connection could hang a databases sql query. TimeoutLayer /// will break this connection and returns an error so users can handle it by diff --git a/core/src/layers/tracing.rs b/core/src/layers/tracing.rs index ff5c4c79eb5e..f95ac60b6bb8 100644 --- a/core/src/layers/tracing.rs +++ b/core/src/layers/tracing.rs @@ -25,7 +25,7 @@ use tracing::Span; use crate::raw::*; use crate::*; -/// Add [tracing](https://docs.rs/tracing/) for every operations. +/// Add [tracing](https://docs.rs/tracing/) for every operation. /// /// # Examples ///