Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Deprecate ValueRecorder in favor of Histogram
The Metric API Spec is now stable and ValueRecorder was replaced with Histogram. * Deprecations - left structs unmarked as clippy threw a fit. * Update all code examples to use Histograms. Signed-off-by: Harold Dost <github@hdost.com>
- Loading branch information
Showing
14 changed files
with
203 additions
and
48 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| use crate::metrics::{ | ||
| sync_instrument::{SyncBoundInstrument, SyncInstrument}, | ||
| Descriptor, InstrumentKind, Measurement, Meter, Number, NumberKind, Result, Unit, | ||
| }; | ||
| use crate::KeyValue; | ||
| use std::marker; | ||
|
|
||
| /// Histogram is a metric that records per-request non-additive values. | ||
| #[derive(Clone, Debug)] | ||
| pub struct Histogram<T>(SyncInstrument<T>); | ||
|
|
||
| impl<T> Histogram<T> | ||
| where | ||
| T: Into<Number>, | ||
| { | ||
| /// Creates a bound instrument for this Histogram. The attributes are | ||
| /// associated with values recorded via subsequent calls to record. | ||
| pub fn bind(&self, attributes: &[KeyValue]) -> BoundHistogram<T> { | ||
| let bound_instrument = self.0.bind(attributes); | ||
| BoundHistogram { bound_instrument } | ||
| } | ||
|
|
||
| /// Record a new metric value | ||
| pub fn record(&self, value: T, attributes: &[KeyValue]) { | ||
| self.0.direct_record(value.into(), attributes) | ||
| } | ||
|
|
||
| /// Creates a `Measurement` object to use with batch recording. | ||
| pub fn measurement(&self, value: T) -> Measurement { | ||
| Measurement::new(value.into(), self.0.instrument().clone()) | ||
| } | ||
| } | ||
|
|
||
| /// BoundHistogram is a bound instrument for recording per-request | ||
| /// non-additive values. | ||
| /// | ||
| /// It inherits the Unbind function from syncBoundInstrument. | ||
| #[derive(Clone, Debug)] | ||
| pub struct BoundHistogram<T> { | ||
| bound_instrument: SyncBoundInstrument<T>, | ||
| } | ||
|
|
||
| impl<T> BoundHistogram<T> | ||
| where | ||
| T: Into<Number>, | ||
| { | ||
| /// Adds a new value to the list of Histogram's records. The attributes | ||
| /// should contain the keys and values to be associated with this value. | ||
| pub fn record(&self, value: T) { | ||
| self.bound_instrument.direct_record(value.into()) | ||
| } | ||
| } | ||
|
|
||
| /// Initialization configuration for a given `Histogram`. | ||
| #[derive(Debug)] | ||
| pub struct HistogramBuilder<'a, T> { | ||
| meter: &'a Meter, | ||
| descriptor: Descriptor, | ||
| _marker: marker::PhantomData<T>, | ||
| } | ||
|
|
||
| impl<'a, T> HistogramBuilder<'a, T> { | ||
| pub(crate) fn new(meter: &'a Meter, name: String, number_kind: NumberKind) -> Self { | ||
| HistogramBuilder { | ||
| meter, | ||
| descriptor: Descriptor::new( | ||
| name, | ||
| meter.instrumentation_library().name, | ||
| meter.instrumentation_library().version, | ||
| InstrumentKind::Histogram, | ||
| number_kind, | ||
| ), | ||
| _marker: marker::PhantomData, | ||
| } | ||
| } | ||
|
|
||
| /// Set the description for this `Histogram` | ||
| pub fn with_description<S: Into<String>>(mut self, description: S) -> Self { | ||
| self.descriptor.set_description(description.into()); | ||
| self | ||
| } | ||
|
|
||
| /// Set the unit for this `Histogram`. | ||
| pub fn with_unit(mut self, unit: Unit) -> Self { | ||
| self.descriptor.config.unit = Some(unit); | ||
| self | ||
| } | ||
|
|
||
| /// Creates a new value recorder. | ||
| pub fn try_init(self) -> Result<Histogram<T>> { | ||
| let instrument = self.meter.new_sync_instrument(self.descriptor)?; | ||
| Ok(Histogram(SyncInstrument::new(instrument))) | ||
| } | ||
|
|
||
| /// Creates a new value recorder. | ||
| /// | ||
| /// # Panics | ||
| /// | ||
| /// This function panics if the instrument cannot be created. Use try_init if you want to | ||
| /// handle errors. | ||
| pub fn init(self) -> Histogram<T> { | ||
| Histogram(SyncInstrument::new( | ||
| self.meter.new_sync_instrument(self.descriptor).unwrap(), | ||
| )) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.