1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.
use std::sync::Arc;
use std::time::Duration;
use metrics::counter;
use metrics::histogram;
use metrics::Label;
use crate::layers::observe;
use crate::raw::*;
use crate::*;
/// Add [metrics](https://docs.rs/metrics/) for every operation.
///
/// # Metrics
///
/// We provide several metrics, please see the documentation of [`observe`] module.
///
/// # Notes
///
/// Please make sure the exporter has been pulled in regular time.
/// Otherwise, the histogram data collected by `requests_duration_seconds`
/// could result in OOM.
///
/// # Examples
///
/// ```no_run
/// # use opendal::layers::MetricsLayer;
/// # use opendal::services;
/// # use opendal::Operator;
/// # use opendal::Result;
///
/// # fn main() -> Result<()> {
/// let _ = Operator::new(services::Memory::default())?
/// .layer(MetricsLayer::default())
/// .finish();
/// Ok(())
/// # }
/// ```
///
/// # Output
///
/// OpenDAL is using [`metrics`](https://docs.rs/metrics/latest/metrics/) for metrics internally.
///
/// To enable metrics output, please enable one of the exporters that `metrics` supports.
///
/// Take [`metrics_exporter_prometheus`](https://docs.rs/metrics-exporter-prometheus/latest/metrics_exporter_prometheus/) as an example:
///
/// ```ignore
/// let builder = PrometheusBuilder::new();
/// builder.install().expect("failed to install recorder/exporter");
/// let handle = builder.install_recorder().expect("failed to install recorder");
/// let (recorder, exporter) = builder.build().expect("failed to build recorder/exporter");
/// let recorder = builder.build_recorder().expect("failed to build recorder");
/// ```
#[derive(Clone, Debug, Default)]
pub struct MetricsLayer {
path_label_level: usize,
}
impl MetricsLayer {
/// Set the level of path label.
///
/// - level = 0: we will ignore the path label.
/// - level > 0: the path label will be the path split by "/" and get the last n level,
/// if n=1 and input path is "abc/def/ghi", and then we will get "abc/" as the path label.
pub fn path_label(mut self, level: usize) -> Self {
self.path_label_level = level;
self
}
}
impl<A: Access> Layer<A> for MetricsLayer {
type LayeredAccess = observe::MetricsAccessor<A, MetricsInterceptor>;
fn layer(&self, inner: A) -> Self::LayeredAccess {
let interceptor = MetricsInterceptor {
path_label_level: self.path_label_level,
};
observe::MetricsLayer::new(interceptor).layer(inner)
}
}
#[derive(Clone, Debug)]
pub struct MetricsInterceptor {
path_label_level: usize,
}
impl observe::MetricsIntercept for MetricsInterceptor {
fn observe_operation_duration_seconds(
&self,
scheme: Scheme,
namespace: Arc<String>,
root: Arc<String>,
path: &str,
op: Operation,
duration: Duration,
) {
let labels = OperationLabels {
scheme,
namespace,
root,
path,
operation: op,
error: None,
}
.into_labels(self.path_label_level);
histogram!(observe::METRIC_OPERATION_DURATION_SECONDS.name(), labels).record(duration)
}
fn observe_operation_bytes(
&self,
scheme: Scheme,
namespace: Arc<String>,
root: Arc<String>,
path: &str,
op: Operation,
bytes: usize,
) {
let labels = OperationLabels {
scheme,
namespace,
root,
path,
operation: op,
error: None,
}
.into_labels(self.path_label_level);
histogram!(observe::METRIC_OPERATION_BYTES.name(), labels).record(bytes as f64)
}
fn observe_operation_errors_total(
&self,
scheme: Scheme,
namespace: Arc<String>,
root: Arc<String>,
path: &str,
op: Operation,
error: ErrorKind,
) {
let labels = OperationLabels {
scheme,
namespace,
root,
path,
operation: op,
error: Some(error),
}
.into_labels(self.path_label_level);
counter!(observe::METRIC_OPERATION_ERRORS_TOTAL.name(), labels).increment(1)
}
}
struct OperationLabels<'a> {
scheme: Scheme,
namespace: Arc<String>,
root: Arc<String>,
path: &'a str,
operation: Operation,
error: Option<ErrorKind>,
}
impl OperationLabels<'_> {
/// labels:
///
/// 1. `["scheme", "namespace", "root", "operation"]`
/// 2. `["scheme", "namespace", "root", "operation", "path"]`
/// 3. `["scheme", "namespace", "root", "operation", "error"]`
/// 4. `["scheme", "namespace", "root", "operation", "path", "error"]`
fn into_labels(self, path_label_level: usize) -> Vec<Label> {
let mut labels = Vec::with_capacity(6);
labels.extend([
Label::new(observe::LABEL_SCHEME, self.scheme.into_static()),
Label::new(observe::LABEL_NAMESPACE, (*self.namespace).clone()),
Label::new(observe::LABEL_ROOT, (*self.root).clone()),
Label::new(observe::LABEL_OPERATION, self.operation.into_static()),
]);
if let Some(path) = observe::path_label_value(self.path, path_label_level) {
labels.push(Label::new(observe::LABEL_PATH, path.to_owned()));
}
if let Some(error) = self.error {
labels.push(Label::new(observe::LABEL_ERROR, error.into_static()));
}
labels
}
}