Skip to content

docs: Don't unnecessarily show simpleexporter in OTLP docs #3105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 4, 2025
Merged

docs: Don't unnecessarily show simpleexporter in OTLP docs #3105

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
578bd99
docs : Don't unnecessarily show simpleexporter in OTLP docs
cijothomas Aug 2, 2025
152e8ce
Merge branch 'main' into cijothomas/otlp-batch-doc
cijothomas Aug 4, 2025
e2e7a5a
Merge branch 'main' into cijothomas/otlp-batch-doc
cijothomas Aug 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 3 additions & 37 deletions opentelemetry-otlp/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
//!
//! // Create a tracer provider with the exporter
//! let tracer_provider = opentelemetry_sdk::trace::SdkTracerProvider::builder()
//! .with_simple_exporter(otlp_exporter)
//! .with_batch_exporter(otlp_exporter)
//! .build();
//!
//! // Set it as the global provider
Expand Down Expand Up @@ -83,7 +83,7 @@
//!
//! // Create a tracer provider with the exporter
//! let tracer_provider = opentelemetry_sdk::trace::SdkTracerProvider::builder()
//! .with_simple_exporter(otlp_exporter)
//! .with_batch_exporter(otlp_exporter)
//! .build();
//!
//! // Set it as the global provider
Expand Down Expand Up @@ -116,7 +116,7 @@
//! .build()
//! .expect("Failed to create span exporter");
//! opentelemetry_sdk::trace::SdkTracerProvider::builder()
//! .with_simple_exporter(exporter)
//! .with_batch_exporter(exporter)
//! .build()
//! });
//!
Expand Down Expand Up @@ -203,40 +203,6 @@
//! `http://localhost:9090`
//! ## Show Logs, Metrics too (TODO)
//!
//! ## Performance
//!
//! For optimal performance, a batch exporting processor is recommended as the simple
//! processor will export each span synchronously on dropping, and is only good
//! for test/debug purposes.
//!
//! ```toml
//! [dependencies]
//! opentelemetry-otlp = { version = "*", features = ["grpc-tonic"] }
//! ```
//!
//! ```no_run
//! # #[cfg(all(feature = "trace", feature = "grpc-tonic"))]
//! # {
//! use opentelemetry::global;
//! use opentelemetry::trace::Tracer;
//!
//! fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
//! // First, create a OTLP exporter builder. Configure it as you need.
//! let otlp_exporter = opentelemetry_otlp::SpanExporter::builder().with_tonic().build()?;
//! // Then pass it into provider builder
//! let _ = opentelemetry_sdk::trace::SdkTracerProvider::builder()
//! .with_batch_exporter(otlp_exporter)
//! .build();
//! let tracer = global::tracer("my_tracer");
//! tracer.in_span("doing_work", |cx| {
//! // Traced app logic here...
//! });
//!
//! Ok(())
//! # }
//! }
//! ```
//!
//! [`tokio`]: https://tokio.rs
//!
//! # Feature Flags
Expand Down
Loading