Skip to content

Commit

Permalink
Rename provider builders (#2562)
Browse files Browse the repository at this point in the history
  • Loading branch information
cijothomas authored Jan 25, 2025
1 parent bd0ee84 commit 879f4d7
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 18 deletions.
5 changes: 4 additions & 1 deletion opentelemetry-sdk/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -288,9 +288,12 @@ limit.
`opentelemetry_sdk::logs::{ExportResult, LogBatch, LogExporter};`

- *Breaking* `opentelemetry_sdk::LogRecord::default()` method is removed.
The only way to create log record outside opentelemetry_sdk crate is using
The only way to create log record outside opentelemetry_sdk crate is using
`Logger::create_log_record()` method.

- Rename `opentelemetry_sdk::logs::Builder` to `opentelemetry_sdk::logs::LoggerProviderBuilder`.
- Rename `opentelemetry_sdk::trace::Builder` to `opentelemetry_sdk::trace::TracerProviderBuilder`.

- *Breaking*: Rename namespaces for InMemoryExporters. (The module is still under "testing" feature flag)
before:
`opentelemetry_sdk::testing::logs::{InMemoryLogExporter, InMemoryLogExporterBuilder};`
Expand Down
14 changes: 7 additions & 7 deletions opentelemetry-sdk/src/logs/logger_provider.rs
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,8 @@ impl opentelemetry::logs::LoggerProvider for LoggerProvider {

impl LoggerProvider {
/// Create a new `LoggerProvider` builder.
pub fn builder() -> Builder {
Builder::default()
pub fn builder() -> LoggerProviderBuilder {
LoggerProviderBuilder::default()
}

pub(crate) fn log_processors(&self) -> &[Box<dyn LogProcessor>] {
Expand Down Expand Up @@ -179,12 +179,12 @@ impl Drop for LoggerProviderInner {

#[derive(Debug, Default)]
/// Builder for provider attributes.
pub struct Builder {
pub struct LoggerProviderBuilder {
processors: Vec<Box<dyn LogProcessor>>,
resource: Option<Resource>,
}

impl Builder {
impl LoggerProviderBuilder {
/// Adds a [SimpleLogProcessor] with the configured exporter to the pipeline.
///
/// # Arguments
Expand All @@ -200,7 +200,7 @@ impl Builder {
let mut processors = self.processors;
processors.push(Box::new(SimpleLogProcessor::new(exporter)));

Builder { processors, ..self }
LoggerProviderBuilder { processors, ..self }
}

/// Adds a [BatchLogProcessor] with the configured exporter to the pipeline.
Expand Down Expand Up @@ -234,12 +234,12 @@ impl Builder {
let mut processors = self.processors;
processors.push(Box::new(processor));

Builder { processors, ..self }
LoggerProviderBuilder { processors, ..self }
}

/// The `Resource` to be associated with this Provider.
pub fn with_resource(self, resource: Resource) -> Self {
Builder {
LoggerProviderBuilder {
resource: Some(resource),
..self
}
Expand Down
2 changes: 1 addition & 1 deletion opentelemetry-sdk/src/logs/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ pub use log_processor::{
BatchConfig, BatchConfigBuilder, BatchLogProcessor, BatchLogProcessorBuilder, LogProcessor,
SimpleLogProcessor,
};
pub use logger_provider::{Builder, Logger, LoggerProvider};
pub use logger_provider::{Logger, LoggerProvider, LoggerProviderBuilder};
pub use record::{LogRecord, TraceContext};

#[cfg(feature = "experimental_logs_batch_log_processor_with_async_runtime")]
Expand Down
2 changes: 1 addition & 1 deletion opentelemetry-sdk/src/trace/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ pub use in_memory_exporter::{InMemorySpanExporter, InMemorySpanExporterBuilder};

pub use id_generator::{IdGenerator, RandomIdGenerator};
pub use links::SpanLinks;
pub use provider::{Builder, TracerProvider};
pub use provider::{TracerProvider, TracerProviderBuilder};
pub use sampler::{Sampler, ShouldSample};
pub use span::Span;
pub use span_limit::SpanLimits;
Expand Down
16 changes: 8 additions & 8 deletions opentelemetry-sdk/src/trace/provider.rs
Original file line number Diff line number Diff line change
Expand Up @@ -167,8 +167,8 @@ impl TracerProvider {
}

/// Create a new [`TracerProvider`] builder.
pub fn builder() -> Builder {
Builder::default()
pub fn builder() -> TracerProviderBuilder {
TracerProviderBuilder::default()
}

/// Span processors associated with this provider
Expand Down Expand Up @@ -274,12 +274,12 @@ impl opentelemetry::trace::TracerProvider for TracerProvider {

/// Builder for provider attributes.
#[derive(Debug, Default)]
pub struct Builder {
pub struct TracerProviderBuilder {
processors: Vec<Box<dyn SpanProcessor>>,
config: crate::trace::Config,
}

impl Builder {
impl TracerProviderBuilder {
/// Adds a [SimpleSpanProcessor] with the configured exporter to the pipeline.
///
/// # Arguments
Expand All @@ -295,7 +295,7 @@ impl Builder {
let mut processors = self.processors;
processors.push(Box::new(SimpleSpanProcessor::new(Box::new(exporter))));

Builder { processors, ..self }
TracerProviderBuilder { processors, ..self }
}

/// Adds a [BatchSpanProcessor] with the configured exporter to the pipeline.
Expand Down Expand Up @@ -329,7 +329,7 @@ impl Builder {
let mut processors = self.processors;
processors.push(Box::new(processor));

Builder { processors, ..self }
TracerProviderBuilder { processors, ..self }
}

/// The sdk [`crate::trace::Config`] that this provider will use.
Expand All @@ -338,7 +338,7 @@ impl Builder {
note = "Config is becoming a private type. Use Builder::with_{config_name}(resource) instead. ex: Builder::with_resource(resource)"
)]
pub fn with_config(self, config: crate::trace::Config) -> Self {
Builder { config, ..self }
TracerProviderBuilder { config, ..self }
}

/// Specify the sampler to be used.
Expand Down Expand Up @@ -398,7 +398,7 @@ impl Builder {
///
/// [Tracer]: opentelemetry::trace::Tracer
pub fn with_resource(self, resource: Resource) -> Self {
Builder {
TracerProviderBuilder {
config: self.config.with_resource(resource),
..self
}
Expand Down

0 comments on commit 879f4d7

Please sign in to comment.