Skip to content

Commit

Permalink
fix: self-recursive debug implementations in metrics.
Browse files Browse the repository at this point in the history
fixes open-telemetry#550. We choose to break the loop at instrument level because debug info on `Accumulator` can be found via other structs and descriptors seem to be more important for instruments.
  • Loading branch information
TommyCpp committed May 18, 2021
1 parent 88e779d commit 733bab9
Showing 1 changed file with 30 additions and 1 deletion.
31 changes: 30 additions & 1 deletion opentelemetry/src/sdk/metrics/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -513,12 +513,20 @@ impl sdk_api::SyncBoundInstrumentCore for Record {
}
}

#[derive(Debug)]
struct Instrument {
descriptor: Descriptor,
meter: Accumulator,
}

impl std::fmt::Debug for Instrument {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_struct("Instrument")
.field("descriptor", &self.descriptor)
.field("meter", &"Accumulator")
.finish()
}
}

impl sdk_api::InstrumentCore for Instrument {
fn descriptor(&self) -> &Descriptor {
&self.descriptor
Expand Down Expand Up @@ -579,3 +587,24 @@ impl sdk_api::MeterCore for Accumulator {
self.0.register_runner(runner)
}
}

#[cfg(test)]
mod tests {
use crate::metrics::MeterProvider;
use crate::sdk::export::metrics::ExportKindSelector;
use crate::sdk::metrics::controllers::pull;
use crate::sdk::metrics::selectors::simple::Selector;

// Prevent the debug message to get into loop
#[test]
fn test_debug_message() {
let controller = pull(
Box::new(Selector::Exact),
Box::new(ExportKindSelector::Delta),
)
.build();
let meter = controller.provider().meter("test", None);
let counter = meter.f64_counter("test").init();
println!("{:?}, {:?}, {:?}", controller, meter, counter);
}
}

0 comments on commit 733bab9

Please sign in to comment.