Skip to content

Commit d581ae1

Browse files
authored
test: fix and enable doctests (#2730)
1 parent 91ae096 commit d581ae1

File tree

15 files changed

+50
-52
lines changed

15 files changed

+50
-52
lines changed

opentelemetry-appender-log/src/lib.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@
1212
//!
1313
//! ```
1414
//! # #[tokio::main] async fn main() {
15-
//! # use opentelemetry_sdk::logs::{BatchLogProcessor, LoggerProvider};
15+
//! # use opentelemetry_sdk::logs::{BatchLogProcessor, SdkLoggerProvider};
1616
//! # use opentelemetry_sdk::runtime;
1717
//! let exporter = opentelemetry_stdout::LogExporter::default();
1818
//!
19-
//! let logger_provider = LoggerProvider::builder()
20-
//! .with_log_processor(BatchLogProcessor::builder(exporter, runtime::Tokio).build())
19+
//! let logger_provider = SdkLoggerProvider::builder()
20+
//! .with_log_processor(BatchLogProcessor::builder(exporter).build())
2121
//! .build();
2222
//! # }
2323
//! ```
@@ -26,12 +26,12 @@
2626
//!
2727
//! ```
2828
//! # #[tokio::main] async fn main() {
29-
//! # use opentelemetry_sdk::logs::{BatchLogProcessor, LoggerProvider};
29+
//! # use opentelemetry_sdk::logs::{BatchLogProcessor, SdkLoggerProvider};
3030
//! # use opentelemetry_sdk::runtime;
3131
//! # use opentelemetry_appender_log::OpenTelemetryLogBridge;
3232
//! # let exporter = opentelemetry_stdout::LogExporter::default();
33-
//! # let logger_provider = LoggerProvider::builder()
34-
//! # .with_log_processor(BatchLogProcessor::builder(exporter, runtime::Tokio).build())
33+
//! # let logger_provider = SdkLoggerProvider::builder()
34+
//! # .with_log_processor(BatchLogProcessor::builder(exporter).build())
3535
//! # .build();
3636
//! let otel_log_appender = OpenTelemetryLogBridge::new(&logger_provider);
3737
//!

opentelemetry-otlp/src/exporter/http/mod.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,12 +57,12 @@ pub struct HttpConfig {
5757
///
5858
/// ## Examples
5959
///
60-
/// ```
60+
/// ```no_run
6161
/// # #[cfg(feature="metrics")]
6262
/// use opentelemetry_sdk::metrics::Temporality;
6363
///
6464
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
65-
/// // Create a span exporter you can use to when configuring tracer providers
65+
/// // Create a span exporter you can use when configuring tracer providers
6666
/// # #[cfg(feature="trace")]
6767
/// let span_exporter = opentelemetry_otlp::SpanExporter::builder().with_http().build()?;
6868
///

opentelemetry-sdk/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
//! let exporter = new_exporter();
2121
//!
2222
//! // Create a new trace pipeline that prints to stdout
23-
//! let provider = TracerProvider::builder()
23+
//! let provider = SdkTracerProvider::builder()
2424
//! .with_simple_exporter(exporter)
2525
//! .build();
2626
//! let tracer = provider.tracer("readme_example");

opentelemetry-sdk/src/logs/batch_log_processor.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ type LogsData = Box<(SdkLogRecord, InstrumentationScope)>;
107107
/// ### Using a BatchLogProcessor:
108108
///
109109
/// ```rust
110-
/// use opentelemetry_sdk::logs::{BatchLogProcessor, BatchConfigBuilder, LoggerProvider};
110+
/// use opentelemetry_sdk::logs::{BatchLogProcessor, BatchConfigBuilder, SdkLoggerProvider};
111111
/// use opentelemetry::global;
112112
/// use std::time::Duration;
113113
/// use opentelemetry_sdk::logs::InMemoryLogExporter;
@@ -123,7 +123,7 @@ type LogsData = Box<(SdkLogRecord, InstrumentationScope)>;
123123
/// )
124124
/// .build();
125125
///
126-
/// let provider = LoggerProvider::builder()
126+
/// let provider = SdkLoggerProvider::builder()
127127
/// .with_log_processor(processor)
128128
/// .build();
129129
///

opentelemetry-sdk/src/logs/in_memory_exporter.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ type LogResult<T> = Result<T, OTelSdkError>;
1717
///
1818
/// # Example
1919
/// ```no_run
20-
///# use opentelemetry_sdk::logs::{BatchLogProcessor, LoggerProvider};
20+
///# use opentelemetry_sdk::logs::{BatchLogProcessor, SdkLoggerProvider};
2121
///# use opentelemetry_sdk::runtime;
2222
///# use opentelemetry_sdk::logs::InMemoryLogExporter;
2323
///
@@ -26,7 +26,7 @@ type LogResult<T> = Result<T, OTelSdkError>;
2626
/// // Create an InMemoryLogExporter
2727
/// let exporter: InMemoryLogExporter = InMemoryLogExporter::default();
2828
/// //Create a LoggerProvider and register the exporter
29-
/// let logger_provider = LoggerProvider::builder()
29+
/// let logger_provider = SdkLoggerProvider::builder()
3030
/// .with_log_processor(BatchLogProcessor::builder(exporter.clone()).build())
3131
/// .build();
3232
/// // Setup Log Appenders and emit logs. (Not shown here)
@@ -78,15 +78,15 @@ pub struct LogDataWithResource {
7878
///
7979
/// ```no_run
8080
///# use opentelemetry_sdk::logs::{InMemoryLogExporter, InMemoryLogExporterBuilder};
81-
///# use opentelemetry_sdk::logs::{BatchLogProcessor, LoggerProvider};
81+
///# use opentelemetry_sdk::logs::{BatchLogProcessor, SdkLoggerProvider};
8282
///# use opentelemetry_sdk::runtime;
8383
///
8484
///# #[tokio::main]
8585
///# async fn main() {
8686
/// //Create an InMemoryLogExporter
8787
/// let exporter: InMemoryLogExporter = InMemoryLogExporterBuilder::default().build();
8888
/// //Create a LoggerProvider and register the exporter
89-
/// let logger_provider = LoggerProvider::builder()
89+
/// let logger_provider = SdkLoggerProvider::builder()
9090
/// .with_log_processor(BatchLogProcessor::builder(exporter.clone()).build())
9191
/// .build();
9292
/// // Setup Log Appenders and emit logs. (Not shown here)

opentelemetry-sdk/src/logs/simple_log_processor.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,12 @@ use std::sync::Mutex;
4747
/// ### Using a SimpleLogProcessor
4848
///
4949
/// ```rust
50-
/// use opentelemetry_sdk::logs::{SimpleLogProcessor, LoggerProvider, LogExporter};
50+
/// use opentelemetry_sdk::logs::{SimpleLogProcessor, SdkLoggerProvider, LogExporter};
5151
/// use opentelemetry::global;
5252
/// use opentelemetry_sdk::logs::InMemoryLogExporter;
5353
///
5454
/// let exporter = InMemoryLogExporter::default(); // Replace with an actual exporter
55-
/// let provider = LoggerProvider::builder()
55+
/// let provider = SdkLoggerProvider::builder()
5656
/// .with_simple_exporter(exporter)
5757
/// .build();
5858
///

opentelemetry-sdk/src/trace/in_memory_exporter.rs

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@ use std::sync::{Arc, Mutex};
1616
///# use opentelemetry_sdk::propagation::TraceContextPropagator;
1717
///# use opentelemetry_sdk::runtime;
1818
///# use opentelemetry_sdk::trace::InMemorySpanExporterBuilder;
19-
///# use opentelemetry_sdk::trace::{BatchSpanProcessor, TracerProvider};
19+
///# use opentelemetry_sdk::trace::{BatchSpanProcessor, SdkTracerProvider};
2020
///
2121
///# #[tokio::main]
2222
///# async fn main() {
2323
/// let exporter = InMemorySpanExporterBuilder::new().build();
24-
/// let provider = TracerProvider::builder()
24+
/// let provider = SdkTracerProvider::builder()
2525
/// .with_span_processor(BatchSpanProcessor::builder(exporter.clone()).build())
2626
/// .build();
2727
///
@@ -37,11 +37,8 @@ use std::sync::{Arc, Mutex};
3737
/// cx.span().add_event("handling this...", Vec::new());
3838
/// cx.span().end();
3939
///
40-
/// let results = provider.force_flush();
41-
/// for result in results {
42-
/// if let Err(e) = result {
43-
/// println!("{:?}", e)
44-
/// }
40+
/// if let Err(e) = provider.force_flush() {
41+
/// println!("{:?}", e)
4542
/// }
4643
/// let spans = exporter.get_finished_spans().unwrap();
4744
/// for span in spans {

opentelemetry-sdk/src/trace/provider.rs

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@ use crate::error::{OTelSdkError, OTelSdkResult};
3939
/// use opentelemetry_sdk::trace::SdkTracerProvider;
4040
/// use opentelemetry::trace::Tracer;
4141
///
42-
/// fn init_tracing() -> TracerProvider {
43-
/// let provider = TracerProvider::default();
42+
/// fn init_tracing() -> SdkTracerProvider {
43+
/// let provider = SdkTracerProvider::default();
4444
///
4545
/// // Set the provider to be used globally
4646
/// let _ = global::set_tracer_provider(provider.clone());
@@ -198,8 +198,8 @@ impl SdkTracerProvider {
198198
/// use opentelemetry::global;
199199
/// use opentelemetry_sdk::trace::SdkTracerProvider;
200200
///
201-
/// fn init_tracing() -> TracerProvider {
202-
/// let provider = TracerProvider::default();
201+
/// fn init_tracing() -> SdkTracerProvider {
202+
/// let provider = SdkTracerProvider::default();
203203
///
204204
/// // Set provider to be used as global tracer provider
205205
/// let _ = global::set_tracer_provider(provider.clone());
@@ -213,10 +213,8 @@ impl SdkTracerProvider {
213213
/// // create spans..
214214
///
215215
/// // force all spans to flush
216-
/// for result in provider.force_flush() {
217-
/// if let Err(err) = result {
218-
/// // .. handle flush error
219-
/// }
216+
/// if let Err(err) = provider.force_flush() {
217+
/// // .. handle flush error
220218
/// }
221219
///
222220
/// // create more spans..

opentelemetry-sdk/src/trace/span_processor.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ impl<T: SpanExporter> SpanProcessor for SimpleSpanProcessor<T> {
193193
/// ```rust
194194
/// use opentelemetry::global;
195195
/// use opentelemetry_sdk::{
196-
/// trace::{BatchSpanProcessor, BatchConfigBuilder, TracerProvider},
196+
/// trace::{BatchSpanProcessor, BatchConfigBuilder, SdkTracerProvider},
197197
/// runtime,
198198
/// testing::trace::NoopSpanExporter,
199199
/// };
@@ -217,7 +217,7 @@ impl<T: SpanExporter> SpanProcessor for SimpleSpanProcessor<T> {
217217
/// .build();
218218
///
219219
/// // Step 3: Set up a TracerProvider with the configured processor.
220-
/// let provider = TracerProvider::builder()
220+
/// let provider = SdkTracerProvider::builder()
221221
/// .with_span_processor(batch_processor)
222222
/// .build();
223223
/// global::set_tracer_provider(provider.clone());

opentelemetry-sdk/src/trace/span_processor_with_async_runtime.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ use std::sync::Arc;
6868
/// .build();
6969
///
7070
/// // Then use the `with_batch_exporter` method to have the provider export spans in batches.
71-
/// let provider = trace::TracerProvider::builder()
71+
/// let provider = trace::SdkTracerProvider::builder()
7272
/// .with_span_processor(batch)
7373
/// .build();
7474
///

0 commit comments

Comments
 (0)