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 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
use super::instrument::{Instrument, Stream};
use glob::Pattern;
use opentelemetry::{
global,
metrics::{MetricsError, Result},
};
fn empty_view(_inst: &Instrument) -> Option<Stream> {
None
}
/// Used to customize the metrics that are output by the SDK.
///
/// Here are some examples when a [View] might be needed:
///
/// * Customize which Instruments are to be processed/ignored. For example, an
/// instrumented library can provide both temperature and humidity, but the
/// application developer might only want temperature.
/// * Customize the aggregation - if the default aggregation associated with the
/// [Instrument] does not meet the needs of the user. For example, an HTTP client
/// library might expose HTTP client request duration as Histogram by default,
/// but the application developer might only want the total count of outgoing
/// requests.
/// * Customize which attribute(s) are to be reported on metrics. For example,
/// an HTTP server library might expose HTTP verb (e.g. GET, POST) and HTTP
/// status code (e.g. 200, 301, 404). The application developer might only care
/// about HTTP status code (e.g. reporting the total count of HTTP requests for
/// each HTTP status code). There could also be extreme scenarios in which the
/// application developer does not need any attributes (e.g. just get the total
/// count of all incoming requests).
///
/// # Example Custom View
///
/// View is implemented for all `Fn(&Instrument) -> Option<Stream>`.
///
/// ```
/// use opentelemetry_sdk::metrics::{Instrument, SdkMeterProvider, Stream};
///
/// // return streams for the given instrument
/// let my_view = |i: &Instrument| {
/// // return Some(Stream) or
/// None
/// };
///
/// let provider = SdkMeterProvider::builder().with_view(my_view).build();
/// # drop(provider)
/// ```
pub trait View: Send + Sync + 'static {
/// Defines how data should be collected for certain instruments.
///
/// Return [Stream] to use for matching [Instrument]s,
/// otherwise if there is no match, return `None`.
fn match_inst(&self, inst: &Instrument) -> Option<Stream>;
}
impl<T> View for T
where
T: Fn(&Instrument) -> Option<Stream> + Send + Sync + 'static,
{
fn match_inst(&self, inst: &Instrument) -> Option<Stream> {
self(inst)
}
}
impl View for Box<dyn View> {
fn match_inst(&self, inst: &Instrument) -> Option<Stream> {
(**self).match_inst(inst)
}
}
/// Creates a [View] that applies the [Stream] mask for all instruments that
/// match criteria.
///
/// The returned [View] will only apply the mask if all non-empty fields of
/// criteria match the corresponding [Instrument] passed to the view. If all
/// fields of the criteria are their default values, a view that matches no
/// instruments is returned. If you need to match an empty-value field, create a
/// [View] directly.
///
/// The [Instrument::name] field of criteria supports wildcard pattern matching.
/// The wildcard `*` is recognized as matching zero or more characters, and `?`
/// is recognized as matching exactly one character. For example, a pattern of
/// `*` will match all instrument names.
///
/// The [Stream] mask only applies updates for non-empty fields. By default, the
/// [Instrument] the [View] matches against will be use for the name,
/// description, and unit of the returned [Stream] and no `aggregation` or
/// `allowed_attribute_keys` are set. All non-empty fields of mask are used
/// instead of the default. If you need to set a an empty value in the returned
/// stream, create a custom [View] directly.
///
/// # Example
///
/// ```
/// use opentelemetry_sdk::metrics::{new_view, Aggregation, Instrument, Stream};
///
/// let criteria = Instrument::new().name("counter_*");
/// let mask = Stream::new().aggregation(Aggregation::Sum);
///
/// let view = new_view(criteria, mask);
/// # drop(view);
/// ```
pub fn new_view(criteria: Instrument, mask: Stream) -> Result<Box<dyn View>> {
if criteria.is_empty() {
global::handle_error(MetricsError::Config(format!(
"no criteria provided, dropping view. mask: {mask:?}"
)));
return Ok(Box::new(empty_view));
}
let contains_wildcard = criteria.name.contains(|c| c == '*' || c == '?');
let err_msg_criteria = criteria.clone();
let match_fn: Box<dyn Fn(&Instrument) -> bool + Send + Sync> = if contains_wildcard {
if mask.name != "" {
global::handle_error(MetricsError::Config(format!(
"name replacement for multiple instruments, dropping view, criteria: {criteria:?}, mask: {mask:?}"
)));
return Ok(Box::new(empty_view));
}
let pattern = criteria.name.clone();
let glob_pattern =
Pattern::new(&pattern).map_err(|e| MetricsError::Config(e.to_string()))?;
Box::new(move |i| {
glob_pattern.matches(&i.name)
&& criteria.matches_description(i)
&& criteria.matches_kind(i)
&& criteria.matches_unit(i)
&& criteria.matches_scope(i)
})
} else {
Box::new(move |i| criteria.matches(i))
};
let mut agg = None;
if let Some(ma) = &mask.aggregation {
match ma.validate() {
Ok(_) => agg = Some(ma.clone()),
Err(err) => {
global::handle_error(MetricsError::Other(format!(
"{}, proceeding as if view did not exist. criteria: {:?}, mask: {:?}",
err, err_msg_criteria, mask
)));
return Ok(Box::new(empty_view));
}
}
}
Ok(Box::new(move |i: &Instrument| -> Option<Stream> {
if match_fn(i) {
Some(Stream {
name: if !mask.name.is_empty() {
mask.name.clone()
} else {
i.name.clone()
},
description: if !mask.description.is_empty() {
mask.description.clone()
} else {
i.description.clone()
},
unit: if !mask.unit.is_empty() {
mask.unit.clone()
} else {
i.unit.clone()
},
aggregation: agg.clone(),
allowed_attribute_keys: mask.allowed_attribute_keys.clone(),
})
} else {
None
}
}))
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_new_view_matching_all() {
let criteria = Instrument::new().name("*");
let mask = Stream::new();
let view = new_view(criteria, mask).expect("Expected to create a new view");
let test_instrument = Instrument::new().name("test_instrument");
assert!(
view.match_inst(&test_instrument).is_some(),
"Expected to match all instruments with * pattern"
);
}
#[test]
fn test_new_view_exact_match() {
let criteria = Instrument::new().name("counter_exact_match");
let mask = Stream::new();
let view = new_view(criteria, mask).expect("Expected to create a new view");
let matching_instrument = Instrument::new().name("counter_exact_match");
assert!(
view.match_inst(&matching_instrument).is_some(),
"Expected to match instrument with exact name"
);
let non_matching_instrument = Instrument::new().name("counter_non_exact_match");
assert!(
view.match_inst(&non_matching_instrument).is_none(),
"Expected not to match instrument with different name"
);
}
#[test]
fn test_new_view_with_wildcard_pattern() {
let criteria = Instrument::new().name("prefix_*");
let mask = Stream::new();
let view = new_view(criteria, mask).expect("Expected to create a new view");
let matching_instrument = Instrument::new().name("prefix_counter");
assert!(
view.match_inst(&matching_instrument).is_some(),
"Expected to match instrument with matching prefix"
);
let non_matching_instrument = Instrument::new().name("nonprefix_counter");
assert!(
view.match_inst(&non_matching_instrument).is_none(),
"Expected not to match instrument with different prefix"
);
}
#[test]
fn test_new_view_wildcard_question_mark() {
let criteria = Instrument::new().name("test_?");
let mask = Stream::new();
let view = new_view(criteria, mask).expect("Expected to create a new view");
// Instrument name that should match the pattern "test_?".
let matching_instrument = Instrument::new().name("test_1");
assert!(
view.match_inst(&matching_instrument).is_some(),
"Expected to match instrument with test_? pattern"
);
// Instrument name that should not match the pattern "test_?".
let non_matching_instrument = Instrument::new().name("test_12");
assert!(
view.match_inst(&non_matching_instrument).is_none(),
"Expected not to match instrument with test_? pattern"
);
}
}