Skip to content

Commit 13d6ffd

Browse files
authored
Merge branch 'main' into anujnegi/disable-name-check
2 parents f8eeb7f + 18834f5 commit 13d6ffd

File tree

17 files changed

+136
-31
lines changed

17 files changed

+136
-31
lines changed

.cspell.json

+1
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
// workspace dictionary.
2727
"words": [
2828
"actix",
29+
"anyvalue",
2930
"appender",
3031
"appenders",
3132
"Bhasin",

Cargo.toml

+9
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ members = [
88
"stress",
99
]
1010
resolver = "2"
11+
# Avoid applying patch to force use of workspace members for this
12+
# not actively maintained crate
13+
exclude = ["opentelemetry-prometheus"]
1114

1215
[profile.bench]
1316
# https://doc.rust-lang.org/cargo/reference/profiles.html#bench
@@ -50,3 +53,9 @@ tracing = { version = ">=0.1.40", default-features = false }
5053
tracing-core = { version = ">=0.1.33", default-features = false }
5154
tracing-subscriber = { version = "0.3", default-features = false }
5255
url = { version = "2.5", default-features = false }
56+
57+
# Aviod use of crates.io version of these crates through the tracing-opentelemetry dependencies
58+
[patch.crates-io]
59+
opentelemetry = { path = "opentelemetry" }
60+
opentelemetry_sdk = { path = "opentelemetry-sdk" }
61+
opentelemetry-stdout = { path = "opentelemetry-stdout" }

opentelemetry-appender-tracing/CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
## vNext
44

55
- Bump msrv to 1.75.0.
6+
- New experimental feature to use trace\_id & span\_id from spans created through the [tracing](https://crates.io/crates/tracing) crate (experimental_use_tracing_span_context) [#2438](https://github.com/open-telemetry/opentelemetry-rust/pull/2438)
67

78

89
## 0.27.0

opentelemetry-appender-tracing/Cargo.toml

+2
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ tracing = { workspace = true, features = ["std"]}
1717
tracing-core = { workspace = true }
1818
tracing-log = { version = "0.2", optional = true }
1919
tracing-subscriber = { workspace = true, features = ["registry", "std"] }
20+
tracing-opentelemetry = { version = "0.28", optional = true }
2021

2122
[dev-dependencies]
2223
log = { workspace = true }
@@ -33,6 +34,7 @@ pprof = { version = "0.14", features = ["flamegraph", "criterion"] }
3334
[features]
3435
experimental_metadata_attributes = ["dep:tracing-log"]
3536
spec_unstable_logs_enabled = ["opentelemetry/spec_unstable_logs_enabled"]
37+
experimental_use_tracing_span_context = ["tracing-opentelemetry"]
3638

3739

3840
[[bench]]

opentelemetry-appender-tracing/src/layer.rs

+83-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ use tracing_core::Level;
88
use tracing_core::Metadata;
99
#[cfg(feature = "experimental_metadata_attributes")]
1010
use tracing_log::NormalizeEvent;
11-
use tracing_subscriber::Layer;
11+
use tracing_subscriber::{registry::LookupSpan, Layer};
1212

1313
const INSTRUMENTATION_LIBRARY_NAME: &str = "opentelemetry-appender-tracing";
1414

@@ -149,7 +149,7 @@ where
149149

150150
impl<S, P, L> Layer<S> for OpenTelemetryTracingBridge<P, L>
151151
where
152-
S: tracing::Subscriber,
152+
S: tracing::Subscriber + for<'a> LookupSpan<'a>,
153153
P: LoggerProvider<Logger = L> + Send + Sync + 'static,
154154
L: Logger + Send + Sync + 'static,
155155
{
@@ -180,6 +180,26 @@ where
180180
// Visit fields.
181181
event.record(&mut visitor);
182182

183+
#[cfg(feature = "experimental_use_tracing_span_context")]
184+
if let Some(span) = _ctx.event_span(event) {
185+
use tracing_opentelemetry::OtelData;
186+
let opt_span_id = span
187+
.extensions()
188+
.get::<OtelData>()
189+
.and_then(|otd| otd.builder.span_id);
190+
191+
let opt_trace_id = span.scope().last().and_then(|root_span| {
192+
root_span
193+
.extensions()
194+
.get::<OtelData>()
195+
.and_then(|otd| otd.builder.trace_id)
196+
});
197+
198+
if let Some((trace_id, span_id)) = opt_trace_id.zip(opt_span_id) {
199+
log_record.set_trace_context(trace_id, span_id, None);
200+
}
201+
}
202+
183203
//emit record
184204
self.logger.emit(log_record);
185205
}
@@ -495,6 +515,67 @@ mod tests {
495515
}
496516
}
497517

518+
#[cfg(feature = "experimental_use_tracing_span_context")]
519+
#[test]
520+
fn tracing_appender_inside_tracing_crate_context() {
521+
use opentelemetry_sdk::trace::InMemorySpanExporterBuilder;
522+
523+
// Arrange
524+
let exporter: InMemoryLogExporter = InMemoryLogExporter::default();
525+
let logger_provider = LoggerProvider::builder()
526+
.with_simple_exporter(exporter.clone())
527+
.build();
528+
529+
// setup tracing layer to compare trace/span IDs against
530+
let span_exporter = InMemorySpanExporterBuilder::new().build();
531+
let tracer_provider = TracerProvider::builder()
532+
.with_simple_exporter(span_exporter.clone())
533+
.build();
534+
let tracer = tracer_provider.tracer("test-tracer");
535+
536+
let level_filter = tracing_subscriber::filter::LevelFilter::INFO;
537+
let log_layer =
538+
layer::OpenTelemetryTracingBridge::new(&logger_provider).with_filter(level_filter);
539+
540+
let subscriber = tracing_subscriber::registry()
541+
.with(log_layer)
542+
.with(tracing_opentelemetry::layer().with_tracer(tracer));
543+
544+
// Avoiding global subscriber.init() as that does not play well with unit tests.
545+
let _guard = tracing::subscriber::set_default(subscriber);
546+
547+
// Act
548+
tracing::info_span!("outer-span").in_scope(|| {
549+
error!("first-event");
550+
551+
tracing::info_span!("inner-span").in_scope(|| {
552+
error!("second-event");
553+
});
554+
});
555+
556+
logger_provider.force_flush();
557+
558+
let logs = exporter.get_emitted_logs().expect("No emitted logs");
559+
assert_eq!(logs.len(), 2);
560+
561+
let spans = span_exporter.get_finished_spans().unwrap();
562+
assert_eq!(spans.len(), 2);
563+
564+
let trace_id = spans[0].span_context.trace_id();
565+
assert_eq!(trace_id, spans[1].span_context.trace_id());
566+
let inner_span_id = spans[0].span_context.span_id();
567+
let outer_span_id = spans[1].span_context.span_id();
568+
assert_eq!(outer_span_id, spans[0].parent_span_id);
569+
570+
let trace_ctx0 = logs[0].record.trace_context().unwrap();
571+
let trace_ctx1 = logs[1].record.trace_context().unwrap();
572+
573+
assert_eq!(trace_ctx0.trace_id, trace_id);
574+
assert_eq!(trace_ctx1.trace_id, trace_id);
575+
assert_eq!(trace_ctx0.span_id, outer_span_id);
576+
assert_eq!(trace_ctx1.span_id, inner_span_id);
577+
}
578+
498579
#[test]
499580
fn tracing_appender_standalone_with_tracing_log() {
500581
// Arrange

opentelemetry-prometheus/Cargo.toml

+6-6
Original file line numberDiff line numberDiff line change
@@ -20,19 +20,19 @@ all-features = true
2020
rustdoc-args = ["--cfg", "docsrs"]
2121

2222
[dependencies]
23-
once_cell = { workspace = true }
23+
once_cell = { version = "1.13" }
2424
opentelemetry = { version = "0.27", default-features = false, features = ["metrics"] }
2525
opentelemetry_sdk = { version = "0.27", default-features = false, features = ["metrics"] }
2626
prometheus = "0.13"
2727
protobuf = "2.14"
28-
tracing = {workspace = true, optional = true} # optional for opentelemetry internal logging
28+
tracing = {version = ">=0.1.40", default-features = false, optional = true} # optional for opentelemetry internal logging
2929

3030
[dev-dependencies]
3131
opentelemetry-semantic-conventions = { version = "0.27" }
32-
http-body-util = { workspace = true }
33-
hyper = { workspace = true, features = ["full"] }
34-
hyper-util = { workspace = true, features = ["full"] }
35-
tokio = { workspace = true, features = ["full"] }
32+
http-body-util = { version = "0.1" }
33+
hyper = { version = "1.3", features = ["full"] }
34+
hyper-util = { version = "0.1", features = ["full"] }
35+
tokio = { version = "1", features = ["full"] }
3636

3737
[features]
3838
default = ["internal-logs"]

opentelemetry-sdk/CHANGELOG.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -288,9 +288,12 @@ limit.
288288
`opentelemetry_sdk::logs::{ExportResult, LogBatch, LogExporter};`
289289

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

294+
- Rename `opentelemetry_sdk::logs::Builder` to `opentelemetry_sdk::logs::LoggerProviderBuilder`.
295+
- Rename `opentelemetry_sdk::trace::Builder` to `opentelemetry_sdk::trace::TracerProviderBuilder`.
296+
294297
- *Breaking*: Rename namespaces for InMemoryExporters. (The module is still under "testing" feature flag)
295298
before:
296299
`opentelemetry_sdk::testing::logs::{InMemoryLogExporter, InMemoryLogExporterBuilder};`

opentelemetry-sdk/src/logs/log_emitter.rs opentelemetry-sdk/src/logs/logger_provider.rs

+7-7
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,8 @@ impl opentelemetry::logs::LoggerProvider for LoggerProvider {
7878

7979
impl LoggerProvider {
8080
/// Create a new `LoggerProvider` builder.
81-
pub fn builder() -> Builder {
82-
Builder::default()
81+
pub fn builder() -> LoggerProviderBuilder {
82+
LoggerProviderBuilder::default()
8383
}
8484

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

180180
#[derive(Debug, Default)]
181181
/// Builder for provider attributes.
182-
pub struct Builder {
182+
pub struct LoggerProviderBuilder {
183183
processors: Vec<Box<dyn LogProcessor>>,
184184
resource: Option<Resource>,
185185
}
186186

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

203-
Builder { processors, ..self }
203+
LoggerProviderBuilder { processors, ..self }
204204
}
205205

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

237-
Builder { processors, ..self }
237+
LoggerProviderBuilder { processors, ..self }
238238
}
239239

240240
/// The `Resource` to be associated with this Provider.
241241
pub fn with_resource(self, resource: Resource) -> Self {
242-
Builder {
242+
LoggerProviderBuilder {
243243
resource: Some(resource),
244244
..self
245245
}

opentelemetry-sdk/src/logs/mod.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
//! # OpenTelemetry Log SDK
22
mod error;
33
mod export;
4-
mod log_emitter;
54
mod log_processor;
5+
mod logger_provider;
66
pub(crate) mod record;
77

88
/// In-Memory log exporter for testing purpose.
@@ -15,11 +15,11 @@ pub use in_memory_exporter::{InMemoryLogExporter, InMemoryLogExporterBuilder};
1515

1616
pub use error::{LogError, LogResult};
1717
pub use export::{ExportResult, LogBatch, LogExporter};
18-
pub use log_emitter::{Builder, Logger, LoggerProvider};
1918
pub use log_processor::{
2019
BatchConfig, BatchConfigBuilder, BatchLogProcessor, BatchLogProcessorBuilder, LogProcessor,
2120
SimpleLogProcessor,
2221
};
22+
pub use logger_provider::{Logger, LoggerProvider, LoggerProviderBuilder};
2323
pub use record::{LogRecord, TraceContext};
2424

2525
#[cfg(feature = "experimental_logs_batch_log_processor_with_async_runtime")]

opentelemetry-sdk/src/trace/mod.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ pub use in_memory_exporter::{InMemorySpanExporter, InMemorySpanExporterBuilder};
3535

3636
pub use id_generator::{IdGenerator, RandomIdGenerator};
3737
pub use links::SpanLinks;
38-
pub use provider::{Builder, TracerProvider};
38+
pub use provider::{TracerProvider, TracerProviderBuilder};
3939
pub use sampler::{Sampler, ShouldSample};
4040
pub use span::Span;
4141
pub use span_limit::SpanLimits;

opentelemetry-sdk/src/trace/provider.rs

+8-8
Original file line numberDiff line numberDiff line change
@@ -167,8 +167,8 @@ impl TracerProvider {
167167
}
168168

169169
/// Create a new [`TracerProvider`] builder.
170-
pub fn builder() -> Builder {
171-
Builder::default()
170+
pub fn builder() -> TracerProviderBuilder {
171+
TracerProviderBuilder::default()
172172
}
173173

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

275275
/// Builder for provider attributes.
276276
#[derive(Debug, Default)]
277-
pub struct Builder {
277+
pub struct TracerProviderBuilder {
278278
processors: Vec<Box<dyn SpanProcessor>>,
279279
config: crate::trace::Config,
280280
}
281281

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

298-
Builder { processors, ..self }
298+
TracerProviderBuilder { processors, ..self }
299299
}
300300

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

332-
Builder { processors, ..self }
332+
TracerProviderBuilder { processors, ..self }
333333
}
334334

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

344344
/// Specify the sampler to be used.
@@ -398,7 +398,7 @@ impl Builder {
398398
///
399399
/// [Tracer]: opentelemetry::trace::Tracer
400400
pub fn with_resource(self, resource: Resource) -> Self {
401-
Builder {
401+
TracerProviderBuilder {
402402
config: self.config.with_resource(resource),
403403
..self
404404
}

opentelemetry-stdout/src/logs/exporter.rs

+4-1
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,10 @@ impl opentelemetry_sdk::logs::LogExporter for LogExporter {
7575
fn print_logs(batch: LogBatch<'_>) {
7676
for (i, log) in batch.iter().enumerate() {
7777
println!("Log #{}", i);
78-
let (record, _library) = log;
78+
let (record, library) = log;
79+
80+
println!("\t Instrumentation Scope: {:?}", library);
81+
7982
if let Some(event_name) = record.event_name() {
8083
println!("\t EventName: {:?}", event_name);
8184
}

opentelemetry/Cargo.toml

+1-2
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,9 @@ js-sys = "0.3.63"
3434
default = ["trace", "metrics", "logs", "internal-logs"]
3535
trace = ["pin-project-lite", "futures-sink", "futures-core", "thiserror"]
3636
metrics = []
37-
testing = ["trace", "metrics"]
37+
testing = ["trace"]
3838
logs = []
3939
spec_unstable_logs_enabled = ["logs"]
40-
otel_unstable = []
4140
internal-logs = ["tracing"]
4241

4342
[dev-dependencies]

opentelemetry/src/global/internal_logging.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#![allow(unused_macros)]
22
///
33
/// **Note**: These macros (`otel_info!`, `otel_warn!`, `otel_debug!`, and `otel_error!`) are intended to be used
4-
/// **internally within OpenTelemetry code** or for **custom exporters and processors**. They are not designed
4+
/// **internally within OpenTelemetry code** or for **custom exporters, processors and other plugins**. They are not designed
55
/// for general application logging and should not be used for that purpose.
66
///
77
/// Macro for logging informational messages in OpenTelemetry.

opentelemetry/src/global/metrics.rs

+1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ fn global_meter_provider() -> &'static RwLock<GlobalMeterProvider> {
1515

1616
/// Sets the given [`MeterProvider`] instance as the current global meter
1717
/// provider.
18+
/// Libraries should NOT call this function. It is intended for applications/executables.
1819
///
1920
/// **NOTE:** This function should be called before getting [`Meter`] instances via [`meter()`] or [`meter_with_scope()`]. Otherwise, you could get no-op [`Meter`] instances.
2021
pub fn set_meter_provider<P>(new_provider: P)

opentelemetry/src/global/trace.rs

+1
Original file line numberDiff line numberDiff line change
@@ -422,6 +422,7 @@ pub fn tracer_with_scope(scope: InstrumentationScope) -> BoxedTracer {
422422
/// It returns the [`TracerProvider`] instance that was previously mounted as global provider
423423
/// (e.g. [`NoopTracerProvider`] if a provider had not been set before).
424424
///
425+
/// Libraries should NOT call this function. It is intended for applications/executables.
425426
/// [`TracerProvider`]: crate::trace::TracerProvider
426427
pub fn set_tracer_provider<P, T, S>(new_provider: P) -> GlobalTracerProvider
427428
where

0 commit comments

Comments
 (0)