Skip to content

Commit ba9847f

Browse files
committed
fix doc code
1 parent 18a754f commit ba9847f

File tree

3 files changed

+28
-23
lines changed

3 files changed

+28
-23
lines changed

opentelemetry-sdk/src/metrics/in_memory_exporter.rs

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ type InMemoryMetrics = Vec<ResourceMetrics>;
2828
/// # Example
2929
///
3030
/// ```
31+
///# use std::sync::{Arc, Mutex};
3132
///# use opentelemetry_sdk::metrics;
3233
///# use opentelemetry::{KeyValue};
3334
///# use opentelemetry::metrics::MeterProvider;
@@ -36,15 +37,15 @@ type InMemoryMetrics = Vec<ResourceMetrics>;
3637
///
3738
///# #[tokio::main]
3839
///# async fn main() {
39-
/// // Create an InMemoryMetricExporter
40-
/// let exporter = InMemoryMetricExporter::builder();
40+
/// // Create an InMemoryMetricExporter
4141
/// let metrics = Arc::new(Mutex::new(Vec::new()));
42-
/// let exporter = InMemoryMetricExporterBuilder::new()
43-
/// .with_metrics(metrics.clone()).build();
42+
/// let exporter = InMemoryMetricExporter::builder()
43+
/// .with_metrics(metrics.clone())
44+
/// .build();
4445
///
4546
/// // Create a MeterProvider and register the exporter
4647
/// let meter_provider = metrics::SdkMeterProvider::builder()
47-
/// .with_reader(PeriodicReader::builder(exporter.clone()).build())
48+
/// .with_reader(PeriodicReader::builder(exporter).build())
4849
/// .build();
4950
///
5051
/// // Create and record metrics using the MeterProvider
@@ -54,11 +55,8 @@ type InMemoryMetrics = Vec<ResourceMetrics>;
5455
///
5556
/// meter_provider.force_flush().unwrap();
5657
///
57-
/// // Retrieve the finished metrics from the exporter
58-
/// let finished_metrics = exporter.get_finished_metrics().unwrap();
59-
///
6058
/// // Print the finished metrics
61-
/// for resource_metrics in finished_metrics {
59+
/// for resource_metrics in metrics.lock().unwrap().iter() {
6260
/// println!("{:?}", resource_metrics);
6361
/// }
6462
///# }
@@ -87,12 +85,12 @@ impl fmt::Debug for InMemoryMetricExporter {
8785
/// # Example
8886
///
8987
/// ```
90-
/// use opentelemetry_sdk::metrics::{InMemoryMetricExporter, InMemoryMetricExporterBuilder};
91-
/// use std::sync::{Arc, Mutex};
88+
///# use opentelemetry_sdk::metrics::{InMemoryMetricExporter, InMemoryMetricExporterBuilder};
89+
///# use std::sync::{Arc, Mutex};
9290
///
9391
/// let metrics = Arc::new(Mutex::new(Vec::new()));
9492
/// let exporter = InMemoryMetricExporterBuilder::new()
95-
/// .with_metrics(metrics.clone()).build();
93+
/// .with_metrics(metrics.clone()).build();
9694
/// ```
9795
pub struct InMemoryMetricExporterBuilder {
9896
temporality: Option<Temporality>,
@@ -149,6 +147,7 @@ impl InMemoryMetricExporter {
149147
///
150148
/// ```
151149
/// use opentelemetry_sdk::metrics::InMemoryMetricExporter;
150+
/// use std::sync::{Arc, Mutex};
152151
///
153152
/// let metrics = Arc::new(Mutex::new(Vec::new()));
154153
/// let exporter = InMemoryMetricExporter::builder()

opentelemetry-sdk/src/metrics/mod.rs

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -271,11 +271,7 @@ mod tests {
271271
test_context.flush_metrics();
272272

273273
// As instrument name are valid because of the feature flag, metrics should be exported
274-
let resource_metrics = test_context
275-
.exporter
276-
.get_finished_metrics()
277-
.expect("metrics expected to be exported");
278-
274+
let resource_metrics = test_context.resource_metrics.lock().unwrap();
279275
assert!(!resource_metrics.is_empty(), "metrics should be exported");
280276
}
281277

@@ -896,7 +892,9 @@ mod tests {
896892

897893
// Arrange
898894
let metrics = Arc::new(Mutex::new(Vec::new()));
899-
let exporter = InMemoryMetricExporter::builder().with_metrics(metrics.clone()).build();
895+
let exporter = InMemoryMetricExporter::builder()
896+
.with_metrics(metrics.clone())
897+
.build();
900898

901899
let view = |i: &Instrument| {
902900
if i.name == "test_histogram" {
@@ -950,7 +948,9 @@ mod tests {
950948

951949
// Arrange
952950
let metrics = Arc::new(Mutex::new(Vec::new()));
953-
let exporter = InMemoryMetricExporter::builder().with_metrics(metrics.clone()).build();
951+
let exporter = InMemoryMetricExporter::builder()
952+
.with_metrics(metrics.clone())
953+
.build();
954954

955955
// View drops all attributes.
956956
let view = |i: &Instrument| {
@@ -1030,7 +1030,9 @@ mod tests {
10301030

10311031
// Arrange
10321032
let metrics = Arc::new(Mutex::new(Vec::new()));
1033-
let exporter = InMemoryMetricExporter::builder().with_metrics(metrics.clone()).build();
1033+
let exporter = InMemoryMetricExporter::builder()
1034+
.with_metrics(metrics.clone())
1035+
.build();
10341036

10351037
// View drops all attributes.
10361038
let view = |i: &Instrument| {

opentelemetry-sdk/src/metrics/periodic_reader_with_async_runtime.rs

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -449,7 +449,7 @@ mod tests {
449449
runtime, Resource,
450450
};
451451
use opentelemetry::metrics::MeterProvider;
452-
use std::sync::mpsc;
452+
use std::sync::{mpsc, Arc, Mutex};
453453

454454
#[test]
455455
fn collection_triggered_by_interval_tokio_current() {
@@ -493,7 +493,9 @@ mod tests {
493493
fn unregistered_collect() {
494494
// Arrange
495495
let metrics = Arc::new(Mutex::new(Vec::new()));
496-
let exporter = InMemoryMetricExporter::builder().with_metrics(metrics.clone()).build();
496+
let exporter = InMemoryMetricExporter::builder()
497+
.with_metrics(metrics.clone())
498+
.build();
497499

498500
let reader = PeriodicReader::builder(exporter, runtime::Tokio).build();
499501
let mut rm = ResourceMetrics {
@@ -517,7 +519,9 @@ mod tests {
517519
let interval = std::time::Duration::from_millis(1);
518520

519521
let metrics = Arc::new(Mutex::new(Vec::new()));
520-
let exporter = InMemoryMetricExporter::builder().with_metrics(metrics.clone()).build();
522+
let exporter = InMemoryMetricExporter::builder()
523+
.with_metrics(metrics.clone())
524+
.build();
521525

522526
let reader = PeriodicReader::builder(exporter, runtime)
523527
.with_interval(interval)

0 commit comments

Comments
 (0)