lambda_otel_lite/telemetry.rs
1//! Core functionality for OpenTelemetry initialization and configuration in Lambda functions.
2//!
3//! This module provides the initialization and configuration components for OpenTelemetry in Lambda:
4//! - `init_telemetry`: Main entry point for telemetry setup
5//! - `TelemetryConfig`: Configuration builder with environment-based defaults
6//! - `TelemetryCompletionHandler`: Controls span export timing based on processing mode
7//!
8//! # Architecture
9//!
10//! The initialization flow:
11//! 1. Configuration is built from environment and/or builder options
12//! 2. Span processor is created based on processing mode
13//! 3. Resource attributes are detected from Lambda environment
14//! 4. Tracer provider is initialized with the configuration
15//! 5. Completion handler is returned for managing span export
16//!
17//! # Environment Configuration
18//!
19//! Core environment variables:
20//! - `LAMBDA_EXTENSION_SPAN_PROCESSOR_MODE`: "sync" (default), "async", or "finalize"
21//! - `LAMBDA_SPAN_PROCESSOR_QUEUE_SIZE`: Maximum spans in buffer (default: 2048)
22//! - `OTEL_SERVICE_NAME`: Override auto-detected service name
23//!
24//! # Basic Usage
25//!
26//! ```no_run
27//! use lambda_otel_lite::telemetry::{init_telemetry, TelemetryConfig};
28//! use lambda_runtime::Error;
29//!
30//! #[tokio::main]
31//! async fn main() -> Result<(), Error> {
32//! let (_, completion_handler) = init_telemetry(TelemetryConfig::default()).await?;
33//! Ok(())
34//! }
35//! ```
36//!
37//! Custom configuration with custom resource attributes:
38//! ```no_run
39//! use lambda_otel_lite::telemetry::{init_telemetry, TelemetryConfig};
40//! use opentelemetry::KeyValue;
41//! use opentelemetry_sdk::Resource;
42//! use lambda_runtime::Error;
43//!
44//! #[tokio::main]
45//! async fn main() -> Result<(), Error> {
46//! let resource = Resource::builder()
47//! .with_attributes(vec![
48//! KeyValue::new("service.version", "1.0.0"),
49//! KeyValue::new("deployment.environment", "production"),
50//! ])
51//! .build();
52//!
53//! let config = TelemetryConfig::builder()
54//! .resource(resource)
55//! .build();
56//!
57//! let (_, completion_handler) = init_telemetry(config).await?;
58//! Ok(())
59//! }
60//! ```
61//!
62//! Custom configuration with custom span processor:
63//! ```no_run
64//! use lambda_otel_lite::{init_telemetry, TelemetryConfig};
65//! use opentelemetry_sdk::trace::SimpleSpanProcessor;
66//! use otlp_stdout_span_exporter::OtlpStdoutSpanExporter;
67//! use lambda_runtime::Error;
68//!
69//! #[tokio::main]
70//! async fn main() -> Result<(), Error> {
71//! let config = TelemetryConfig::builder()
72//! .with_span_processor(SimpleSpanProcessor::new(
73//! OtlpStdoutSpanExporter::default()
74//! ))
75//! .enable_fmt_layer(true)
76//! .build();
77//!
78//! let (_, completion_handler) = init_telemetry(config).await?;
79//! Ok(())
80//! }
81//! ```
82//!
83//! # Environment Variables
84//!
85//! The following environment variables affect the configuration:
86//! - `OTEL_SERVICE_NAME`: Service name for spans
87//! - `OTEL_RESOURCE_ATTRIBUTES`: Additional resource attributes
88//! - `LAMBDA_SPAN_PROCESSOR_QUEUE_SIZE`: Span buffer size (default: 2048)
89//! - `OTLP_STDOUT_SPAN_EXPORTER_COMPRESSION_LEVEL`: Export compression (default: 6)
90//! - `LAMBDA_TRACING_ENABLE_FMT_LAYER`: Enable formatting layer (default: false)
91//! - `LAMBDA_EXTENSION_SPAN_PROCESSOR_MODE`: Processing mode (sync/async/finalize)
92//! - `RUST_LOG` or `AWS_LAMBDA_LOG_LEVEL`: Log level configuration
93
94use crate::{
95 constants, extension::register_extension, logger::Logger, mode::ProcessorMode,
96 processor::LambdaSpanProcessor, propagation::LambdaXrayPropagator,
97 resource::get_lambda_resource,
98};
99use bon::Builder;
100use lambda_runtime::Error;
101use opentelemetry::propagation::{TextMapCompositePropagator, TextMapPropagator};
102use opentelemetry::{global, global::set_tracer_provider, trace::TracerProvider as _, KeyValue};
103use opentelemetry_aws::trace::XrayPropagator;
104use opentelemetry_sdk::{
105 propagation::TraceContextPropagator,
106 trace::{IdGenerator, SdkTracerProvider, SpanProcessor, TracerProviderBuilder},
107 Resource,
108};
109use otlp_stdout_span_exporter::OtlpStdoutSpanExporter;
110use std::{borrow::Cow, env, sync::Arc};
111use tokio::sync::mpsc::UnboundedSender;
112use tracing_subscriber::layer::SubscriberExt;
113
114// Add module-specific logger
115static LOGGER: Logger = Logger::const_new("telemetry");
116
117/// Manages the lifecycle of span export based on the processing mode.
118///
119/// This handler must be used to signal when spans should be exported. Its behavior
120/// varies by processing mode:
121/// - Sync: Forces immediate export
122/// - Async: Signals the extension to export
123/// - Finalize: Defers to span processor
124///
125/// # Thread Safety
126///
127/// This type is `Clone` and can be safely shared between threads.
128#[derive(Clone)]
129pub struct TelemetryCompletionHandler {
130 provider: Arc<SdkTracerProvider>,
131 sender: Option<UnboundedSender<()>>,
132 mode: ProcessorMode,
133 tracer: opentelemetry_sdk::trace::Tracer,
134}
135
136impl TelemetryCompletionHandler {
137 pub fn new(
138 provider: Arc<SdkTracerProvider>,
139 sender: Option<UnboundedSender<()>>,
140 mode: ProcessorMode,
141 ) -> Self {
142 // Create instrumentation scope with attributes
143 let scope = opentelemetry::InstrumentationScope::builder(env!("CARGO_PKG_NAME"))
144 .with_version(Cow::Borrowed(env!("CARGO_PKG_VERSION")))
145 .with_schema_url(Cow::Borrowed("https://opentelemetry.io/schemas/1.30.0"))
146 .with_attributes(vec![
147 KeyValue::new("library.language", "rust"),
148 KeyValue::new("library.type", "instrumentation"),
149 KeyValue::new("library.runtime", "aws_lambda"),
150 ])
151 .build();
152
153 // Create tracer with instrumentation scope
154 let tracer = provider.tracer_with_scope(scope);
155
156 Self {
157 provider,
158 sender,
159 mode,
160 tracer,
161 }
162 }
163
164 /// Get the tracer instance for creating spans.
165 ///
166 /// Returns the cached tracer instance configured with this package's instrumentation scope.
167 /// The tracer is configured with the provider's settings and will automatically use
168 /// the correct span processor based on the processing mode.
169 pub fn get_tracer(&self) -> &opentelemetry_sdk::trace::Tracer {
170 &self.tracer
171 }
172
173 /// Complete telemetry processing for the current invocation
174 ///
175 /// In Sync mode, this will force flush the provider and log any errors that occur.
176 /// In Async mode, this will send a completion signal to the extension.
177 /// In Finalize mode, this will do nothing (handled by drop).
178 pub fn complete(&self) {
179 match self.mode {
180 ProcessorMode::Sync => {
181 if let Err(e) = self.provider.force_flush() {
182 LOGGER.warn(format!("Error flushing telemetry: {e:?}"));
183 }
184 }
185 ProcessorMode::Async => {
186 if let Some(sender) = &self.sender {
187 if let Err(e) = sender.send(()) {
188 LOGGER.warn(format!(
189 "Failed to send completion signal to extension: {e:?}"
190 ));
191 }
192 }
193 }
194 ProcessorMode::Finalize => {
195 // Do nothing, handled by drop
196 }
197 }
198 }
199}
200
201/// Configuration for OpenTelemetry initialization.
202///
203/// Provides configuration options for telemetry setup. Use `TelemetryConfig::default()`
204/// for standard Lambda configuration, or the builder pattern for customization.
205///
206/// # Fields
207///
208/// * `enable_fmt_layer` - Enable console output for debugging (default: false)
209/// * `set_global_provider` - Set as global tracer provider (default: true)
210/// * `resource` - Custom resource attributes (default: auto-detected from Lambda)
211/// * `env_var_name` - Environment variable name for log level configuration
212/// * `id_generator` - Custom ID generator for trace and span IDs
213/// * `processor_mode` - Span processing mode (sync/async/finalize)
214///
215/// # Examples
216///
217/// Basic usage with default configuration:
218///
219/// ```no_run
220/// use lambda_otel_lite::telemetry::TelemetryConfig;
221///
222/// let config = TelemetryConfig::default();
223/// ```
224///
225/// Custom configuration with resource attributes:
226///
227/// ```no_run
228/// use lambda_otel_lite::telemetry::TelemetryConfig;
229/// use opentelemetry::KeyValue;
230/// use opentelemetry_sdk::Resource;
231///
232/// let config = TelemetryConfig::builder()
233/// .resource(Resource::builder()
234/// .with_attributes(vec![KeyValue::new("version", "1.0.0")])
235/// .build())
236/// .build();
237/// ```
238///
239/// Custom configuration with logging options:
240///
241/// ```no_run
242/// use lambda_otel_lite::telemetry::TelemetryConfig;
243///
244/// let config = TelemetryConfig::builder()
245/// .enable_fmt_layer(true) // Enable console output for debugging
246/// .env_var_name("MY_CUSTOM_LOG_LEVEL".to_string()) // Custom env var for log level
247/// .build();
248/// ```
249#[derive(Builder, Debug)]
250pub struct TelemetryConfig {
251 // Custom fields for internal state
252 #[builder(field)]
253 provider_builder: TracerProviderBuilder,
254
255 #[builder(field)]
256 has_processor: bool,
257
258 #[builder(field)]
259 propagators: Vec<Box<dyn TextMapPropagator + Send + Sync>>,
260
261 /// Enable console output for debugging.
262 ///
263 /// When enabled, spans and events will be printed to the console in addition
264 /// to being exported through the configured span processors. This is useful
265 /// for debugging but adds overhead and should be disabled in production.
266 ///
267 /// This can also be controlled via the `LAMBDA_TRACING_ENABLE_FMT_LAYER` environment variable,
268 /// which takes precedence over this setting when present:
269 /// - Setting the env var to "true" will enable console output even if this field is false
270 /// - Setting the env var to "false" will disable console output even if this field is true
271 /// - Invalid values will log a warning and fall back to this code setting
272 ///
273 /// This environment variable override allows toggling logging for debugging without code changes.
274 ///
275 /// Default: `false`
276 #[builder(default = false)]
277 pub enable_fmt_layer: bool,
278
279 /// Set this provider as the global OpenTelemetry provider.
280 ///
281 /// When enabled, the provider will be registered as the global provider
282 /// for the OpenTelemetry API. This allows using the global tracer API
283 /// without explicitly passing around the provider.
284 ///
285 /// Default: `true`
286 #[builder(default = true)]
287 pub set_global_provider: bool,
288
289 /// Custom resource attributes for all spans.
290 ///
291 /// If not provided, resource attributes will be automatically detected
292 /// from the Lambda environment. Custom resources will override any
293 /// automatically detected attributes with the same keys.
294 ///
295 /// Default: `None` (auto-detected from Lambda environment)
296 pub resource: Option<Resource>,
297
298 /// Environment variable name to use for log level configuration.
299 ///
300 /// This field specifies which environment variable should be used to configure
301 /// the tracing subscriber's log level filter. If not specified, the system will
302 /// first check for `RUST_LOG` and then fall back to `AWS_LAMBDA_LOG_LEVEL`.
303 ///
304 /// Default: `None` (uses `RUST_LOG` or `AWS_LAMBDA_LOG_LEVEL`)
305 pub env_var_name: Option<String>,
306
307 /// Span processing mode (sync/async/finalize)
308 ///
309 /// Controls how spans are exported from the processor. This can be overridden by the
310 /// LAMBDA_EXTENSION_SPAN_PROCESSOR_MODE environment variable, which takes precedence.
311 ///
312 /// Default: `None` (uses environment variable or defaults to `ProcessorMode::Sync`)
313 pub processor_mode: Option<ProcessorMode>,
314}
315
316impl Default for TelemetryConfig {
317 fn default() -> Self {
318 Self::builder().build()
319 }
320}
321
322/// Builder methods for adding span processors and other configuration
323impl<S: telemetry_config_builder::State> TelemetryConfigBuilder<S> {
324 /// Add a span processor to the tracer provider.
325 ///
326 /// This method allows adding custom span processors for trace data processing.
327 /// Multiple processors can be added by calling this method multiple times.
328 ///
329 /// # Arguments
330 ///
331 /// * `processor` - A span processor implementing the [`SpanProcessor`] trait
332 ///
333 /// # Examples
334 ///
335 /// ```no_run
336 /// use lambda_otel_lite::TelemetryConfig;
337 /// use opentelemetry_sdk::trace::SimpleSpanProcessor;
338 /// use otlp_stdout_span_exporter::OtlpStdoutSpanExporter;
339 ///
340 /// // Only use builder when adding custom processors
341 /// let config = TelemetryConfig::builder()
342 /// .with_span_processor(SimpleSpanProcessor::new(
343 /// OtlpStdoutSpanExporter::default()
344 /// ))
345 /// .build();
346 /// ```
347 pub fn with_span_processor<T>(mut self, processor: T) -> Self
348 where
349 T: SpanProcessor + 'static,
350 {
351 self.provider_builder = self.provider_builder.with_span_processor(processor);
352 self.has_processor = true;
353 self
354 }
355
356 /// Add a propagator to the list of propagators.
357 ///
358 /// Multiple propagators can be added and will be combined into a composite propagator.
359 /// The default propagator is TraceContextPropagator.
360 ///
361 /// # Arguments
362 ///
363 /// * `propagator` - A propagator implementing the [`TextMapPropagator`] trait
364 ///
365 /// # Examples
366 ///
367 /// ```no_run
368 /// use lambda_otel_lite::TelemetryConfig;
369 /// use opentelemetry_sdk::propagation::BaggagePropagator;
370 ///
371 /// let config = TelemetryConfig::builder()
372 /// .with_propagator(BaggagePropagator::new())
373 /// .build();
374 /// ```
375 pub fn with_propagator<T>(mut self, propagator: T) -> Self
376 where
377 T: TextMapPropagator + Send + Sync + 'static,
378 {
379 self.propagators.push(Box::new(propagator));
380 self
381 }
382
383 pub fn with_named_propagator(self, name: &str) -> Self {
384 match name {
385 "tracecontext" => self.with_propagator(TraceContextPropagator::new()),
386 "xray" => self.with_propagator(XrayPropagator::new()),
387 "xray-lambda" => self.with_propagator(LambdaXrayPropagator::new()),
388 "none" => self.with_propagator(NoopPropagator::new()),
389 _ => {
390 LOGGER.warn(format!(
391 "Unknown propagator: {name}, using default propagators"
392 ));
393 self
394 }
395 }
396 }
397
398 /// Add a custom ID generator to the tracer provider.
399 ///
400 /// This method allows setting a custom ID generator for trace and span IDs.
401 /// This is particularly useful when integrating with AWS X-Ray, which requires
402 /// a specific ID format.
403 ///
404 /// # Arguments
405 ///
406 /// * `id_generator` - An ID generator implementing the [`IdGenerator`] trait
407 ///
408 /// # Examples
409 ///
410 /// ```no_run
411 /// use lambda_otel_lite::TelemetryConfig;
412 /// use opentelemetry_aws::trace::XrayIdGenerator;
413 ///
414 /// // Configure with X-Ray compatible ID generator
415 /// let config = TelemetryConfig::builder()
416 /// .with_id_generator(XrayIdGenerator::default())
417 /// .build();
418 /// ```
419 pub fn with_id_generator<T>(mut self, id_generator: T) -> Self
420 where
421 T: IdGenerator + 'static,
422 {
423 self.provider_builder = self.provider_builder.with_id_generator(id_generator);
424 self
425 }
426}
427
428/// Initialize OpenTelemetry for AWS Lambda with the provided configuration.
429///
430/// # Arguments
431///
432/// * `config` - Configuration for telemetry initialization
433///
434/// # Returns
435///
436/// Returns a tuple containing:
437/// - A tracer instance for manual instrumentation
438/// - A completion handler for managing span export timing
439///
440/// # Errors
441///
442/// Returns error if:
443/// - Extension registration fails (async/finalize modes)
444/// - Tracer provider initialization fails
445/// - Environment variable parsing fails
446///
447/// # Examples
448///
449/// Basic usage with default configuration:
450///
451/// ```no_run
452/// use lambda_otel_lite::telemetry::{init_telemetry, TelemetryConfig};
453///
454/// # async fn example() -> Result<(), lambda_runtime::Error> {
455/// // Initialize with default configuration
456/// let (_, telemetry) = init_telemetry(TelemetryConfig::default()).await?;
457/// # Ok(())
458/// # }
459/// ```
460///
461/// Custom configuration:
462///
463/// ```no_run
464/// use lambda_otel_lite::telemetry::{init_telemetry, TelemetryConfig};
465/// use opentelemetry::KeyValue;
466/// use opentelemetry_sdk::Resource;
467///
468/// # async fn example() -> Result<(), lambda_runtime::Error> {
469/// // Create custom resource
470/// let resource = Resource::builder()
471/// .with_attributes(vec![
472/// KeyValue::new("service.name", "payment-api"),
473/// KeyValue::new("service.version", "1.2.3"),
474/// ])
475/// .build();
476///
477/// // Initialize with custom configuration
478/// let (_, telemetry) = init_telemetry(
479/// TelemetryConfig::builder()
480/// .resource(resource)
481/// .build()
482/// ).await?;
483/// # Ok(())
484/// # }
485/// ```
486///
487/// Advanced usage with BatchSpanProcessor (required for async exporters):
488///
489/// ```no_run
490/// use lambda_otel_lite::{init_telemetry, TelemetryConfig};
491/// use opentelemetry_otlp::{WithExportConfig, WithHttpConfig, Protocol};
492/// use opentelemetry_sdk::trace::BatchSpanProcessor;
493/// use lambda_runtime::Error;
494///
495/// # async fn example() -> Result<(), Error> {
496/// let batch_exporter = opentelemetry_otlp::SpanExporter::builder()
497/// .with_http()
498/// .with_http_client(reqwest::Client::new())
499/// .with_protocol(Protocol::HttpBinary)
500/// .build()?;
501///
502/// let (provider, completion) = init_telemetry(
503/// TelemetryConfig::builder()
504/// .with_span_processor(BatchSpanProcessor::builder(batch_exporter).build())
505/// .build()
506/// ).await?;
507/// # Ok(())
508/// # }
509/// ```
510///
511/// Using LambdaSpanProcessor with blocking http client:
512///
513/// ```no_run
514/// use lambda_otel_lite::{init_telemetry, TelemetryConfig, LambdaSpanProcessor};
515/// use opentelemetry_otlp::{WithExportConfig, WithHttpConfig, Protocol};
516/// use lambda_runtime::Error;
517///
518/// # async fn example() -> Result<(), Error> {
519/// let lambda_exporter = opentelemetry_otlp::SpanExporter::builder()
520/// .with_http()
521/// .with_http_client(reqwest::blocking::Client::new())
522/// .with_protocol(Protocol::HttpBinary)
523/// .build()?;
524///
525/// let (provider, completion) = init_telemetry(
526/// TelemetryConfig::builder()
527/// .with_span_processor(
528/// LambdaSpanProcessor::builder()
529/// .exporter(lambda_exporter)
530/// .max_queue_size(2048)
531/// .build()
532/// )
533/// .build()
534/// ).await?;
535/// # Ok(())
536/// # }
537/// ```
538///
539pub async fn init_telemetry(
540 mut config: TelemetryConfig,
541) -> Result<(opentelemetry_sdk::trace::Tracer, TelemetryCompletionHandler), Error> {
542 // Get mode from config or environment with environment taking precedence
543 let mode = ProcessorMode::resolve(config.processor_mode);
544
545 if let Ok(env_propagators) = env::var(constants::env_vars::PROPAGATORS) {
546 let propagators: Vec<&str> = env_propagators.split(',').map(|s| s.trim()).collect();
547
548 for propagator in propagators {
549 match propagator {
550 "tracecontext" => config
551 .propagators
552 .push(Box::new(TraceContextPropagator::new())),
553 "xray" => config.propagators.push(Box::new(XrayPropagator::new())),
554 "xray-lambda" => config
555 .propagators
556 .push(Box::new(LambdaXrayPropagator::new())),
557 "none" => config.propagators.push(Box::new(NoopPropagator::new())),
558 _ => LOGGER.warn(format!(
559 "Unknown propagator: {propagator}, using default propagators"
560 )),
561 }
562 }
563 } else {
564 // if no propagators are set, use the default propagators
565 if config.propagators.is_empty() {
566 // IMPORTANT:
567 // LambdaXrayPropagator is added *before* TraceContextPropagator
568 // because in OpenTelemetry Rust, the *last* propagator that extracts
569 // a valid context wins during extraction.
570 // This ensures that if both an AWS X-Ray header (or _X_AMZN_TRACE_ID)
571 // and a W3C traceparent header are present, the W3C traceparent takes precedence.
572 config
573 .propagators
574 .push(Box::new(LambdaXrayPropagator::new()));
575 config
576 .propagators
577 .push(Box::new(TraceContextPropagator::new()));
578 }
579 }
580
581 let composite_propagator = TextMapCompositePropagator::new(config.propagators);
582 global::set_text_map_propagator(composite_propagator);
583
584 // Add default span processor if none was added
585 if !config.has_processor {
586 let processor = LambdaSpanProcessor::builder()
587 .exporter(OtlpStdoutSpanExporter::default())
588 .build();
589 config.provider_builder = config.provider_builder.with_span_processor(processor);
590 }
591
592 // Apply defaults and build the provider
593 let resource = config.resource.unwrap_or_else(get_lambda_resource);
594
595 let provider = Arc::new(config.provider_builder.with_resource(resource).build());
596
597 // Register the extension if in async or finalize mode
598 let sender = match mode {
599 ProcessorMode::Async | ProcessorMode::Finalize => {
600 Some(register_extension(provider.clone(), mode.clone()).await?)
601 }
602 _ => None,
603 };
604
605 if config.set_global_provider {
606 // Set the provider as global
607 set_tracer_provider(provider.as_ref().clone());
608 }
609
610 // Initialize tracing subscriber with smart env var selection
611 let env_var_name = config.env_var_name.as_deref().unwrap_or_else(|| {
612 if env::var("RUST_LOG").is_ok() {
613 "RUST_LOG"
614 } else {
615 "AWS_LAMBDA_LOG_LEVEL"
616 }
617 });
618
619 let env_filter = tracing_subscriber::EnvFilter::builder()
620 .with_env_var(env_var_name)
621 .from_env_lossy();
622
623 let completion_handler = TelemetryCompletionHandler::new(provider.clone(), sender, mode);
624 let tracer = completion_handler.get_tracer().clone();
625
626 let subscriber = tracing_subscriber::registry::Registry::default()
627 .with(tracing_opentelemetry::OpenTelemetryLayer::new(
628 tracer.clone(),
629 ))
630 .with(env_filter);
631
632 // Determine if fmt layer should be enabled - environment variable takes precedence when set
633 let enable_fmt = if let Ok(env_value) = env::var(constants::env_vars::ENABLE_FMT_LAYER) {
634 match env_value.to_lowercase().as_str() {
635 "true" => true,
636 "false" => false,
637 other => {
638 LOGGER.warn(format!(
639 "Invalid value '{}' for {}, expected 'true' or 'false'. Using code configuration.",
640 other,
641 constants::env_vars::ENABLE_FMT_LAYER
642 ));
643 config.enable_fmt_layer
644 }
645 }
646 } else {
647 // If env var not set, use the configured value
648 config.enable_fmt_layer
649 };
650
651 // Enable fmt layer based on the determined value
652 if enable_fmt {
653 // Determine if the lambda logging configuration is set to output json logs
654 let is_json = env::var("AWS_LAMBDA_LOG_FORMAT")
655 .unwrap_or_default()
656 .to_uppercase()
657 == "JSON";
658
659 if is_json {
660 tracing::subscriber::set_global_default(
661 subscriber.with(
662 tracing_subscriber::fmt::layer()
663 .with_target(false)
664 .without_time()
665 .json(),
666 ),
667 )?;
668 } else {
669 tracing::subscriber::set_global_default(
670 subscriber.with(
671 tracing_subscriber::fmt::layer()
672 .with_target(false)
673 .without_time()
674 .with_ansi(false),
675 ),
676 )?;
677 }
678 } else {
679 tracing::subscriber::set_global_default(subscriber)?;
680 }
681
682 Ok((tracer, completion_handler))
683}
684
685#[cfg(test)]
686mod tests {
687 use super::*;
688 use opentelemetry::trace::{Span, Tracer};
689 use opentelemetry_aws::trace::XrayIdGenerator;
690 use opentelemetry_sdk::trace::SimpleSpanProcessor;
691 use sealed_test::prelude::*;
692 use std::sync::Arc;
693 use tokio::sync::mpsc;
694
695 // Helper to clean up environment variables between tests
696 fn cleanup_env() {
697 env::remove_var(constants::env_vars::ENABLE_FMT_LAYER);
698 env::remove_var(constants::env_vars::PROPAGATORS);
699 env::remove_var("_X_AMZN_TRACE_ID");
700 }
701
702 #[test]
703 #[sealed_test]
704 fn test_telemetry_config_defaults() {
705 cleanup_env();
706
707 let config = TelemetryConfig::builder().build();
708 assert!(config.set_global_provider); // Should be true by default
709 assert!(!config.has_processor);
710 assert!(!config.enable_fmt_layer);
711 assert!(config.propagators.is_empty()); // No propagators by default in builder
712 }
713
714 #[test]
715 #[sealed_test]
716 fn test_telemetry_config_with_propagators() {
717 cleanup_env();
718
719 // Test with explicit tracecontext propagator
720 let config = TelemetryConfig::builder()
721 .with_span_processor(SimpleSpanProcessor::new(OtlpStdoutSpanExporter::default()))
722 .with_named_propagator("tracecontext")
723 .build();
724 assert_eq!(config.propagators.len(), 1);
725
726 // Test with explicit xray propagator
727 let config = TelemetryConfig::builder()
728 .with_named_propagator("xray")
729 .build();
730 assert_eq!(config.propagators.len(), 1);
731
732 // Test with both propagators
733 let config = TelemetryConfig::builder()
734 .with_named_propagator("tracecontext")
735 .with_named_propagator("xray")
736 .build();
737 assert_eq!(config.propagators.len(), 2);
738
739 // Test with default propagators (empty - will be set in init_telemetry)
740 let config = TelemetryConfig::builder().build();
741 assert_eq!(config.propagators.len(), 0);
742
743 // Test with none
744 let config = TelemetryConfig::builder()
745 .with_named_propagator("none")
746 .build();
747 assert_eq!(config.propagators.len(), 1);
748 }
749
750 #[tokio::test]
751 #[sealed_test]
752 async fn test_telemetry_config_env_propagators_tracecontext() {
753 cleanup_env();
754
755 // Test with OTEL_PROPAGATORS=tracecontext
756 env::set_var(constants::env_vars::PROPAGATORS, "tracecontext");
757 let (_, handler) = init_telemetry(TelemetryConfig::default()).await.unwrap();
758 // In real usage we'd check the behavior rather than implementation details
759 // So we'll just check that we can create and use a handler
760 assert!(handler.sender.is_none());
761
762 cleanup_env();
763 }
764
765 #[tokio::test]
766 #[sealed_test]
767 async fn test_telemetry_config_env_propagators_xray() {
768 cleanup_env();
769
770 // Test with OTEL_PROPAGATORS=xray
771 env::set_var(constants::env_vars::PROPAGATORS, "xray");
772 let (_, handler) = init_telemetry(TelemetryConfig::default()).await.unwrap();
773 assert!(handler.sender.is_none());
774
775 cleanup_env();
776 }
777
778 #[tokio::test]
779 #[sealed_test]
780 async fn test_telemetry_config_env_propagators_combined() {
781 cleanup_env();
782
783 // Test with OTEL_PROPAGATORS=tracecontext,xray-lambda
784 env::set_var(constants::env_vars::PROPAGATORS, "tracecontext,xray-lambda");
785 let (_, handler) = init_telemetry(TelemetryConfig::default()).await.unwrap();
786 assert!(handler.sender.is_none());
787
788 cleanup_env();
789 }
790
791 #[tokio::test]
792 #[sealed_test]
793 async fn test_telemetry_config_env_propagators_none() {
794 cleanup_env();
795
796 // Test with OTEL_PROPAGATORS=none
797 env::set_var(constants::env_vars::PROPAGATORS, "none");
798 let (_, handler) = init_telemetry(TelemetryConfig::default()).await.unwrap();
799 assert!(handler.sender.is_none());
800
801 cleanup_env();
802 }
803
804 #[tokio::test]
805 #[sealed_test]
806 async fn test_init_telemetry_defaults() {
807 let (_, completion_handler) = init_telemetry(TelemetryConfig::default()).await.unwrap();
808 assert!(completion_handler.sender.is_none()); // Default mode is Sync
809 }
810
811 #[tokio::test]
812 #[sealed_test]
813 async fn test_init_telemetry_custom() {
814 let resource = Resource::builder().build();
815 let config = TelemetryConfig::builder()
816 .resource(resource)
817 .with_named_propagator("tracecontext")
818 .enable_fmt_layer(true)
819 .set_global_provider(false)
820 .build();
821
822 let (_, completion_handler) = init_telemetry(config).await.unwrap();
823 assert!(completion_handler.sender.is_none());
824 }
825
826 #[tokio::test]
827 #[sealed_test]
828 async fn test_telemetry_config_env_fmt_layer_true_override() {
829 cleanup_env();
830
831 // Test: Env var "true" overrides code setting "false"
832 env::set_var(constants::env_vars::ENABLE_FMT_LAYER, "true");
833 let config = TelemetryConfig::default(); // code setting is false by default
834 assert!(!config.enable_fmt_layer); // Config should not be affected by env var
835
836 // Initialize telemetry - env var should override config
837 let result = init_telemetry(config).await;
838 assert!(result.is_ok());
839
840 // Clean up
841 cleanup_env();
842 }
843
844 #[tokio::test]
845 #[sealed_test]
846 async fn test_telemetry_config_env_fmt_layer_false_override() {
847 cleanup_env();
848
849 // Test: Env var "false" overrides code setting "true"
850 env::set_var(constants::env_vars::ENABLE_FMT_LAYER, "false");
851 let config = TelemetryConfig::builder()
852 .enable_fmt_layer(true) // code setting is true
853 .build();
854 assert!(config.enable_fmt_layer);
855
856 // Initialize telemetry - env var should override config
857 let result = init_telemetry(config).await;
858 assert!(result.is_ok());
859
860 // Clean up
861 cleanup_env();
862 }
863
864 #[tokio::test]
865 #[sealed_test]
866 async fn test_telemetry_config_env_fmt_layer_invalid() {
867 cleanup_env();
868
869 // Test: Invalid env var falls back to code setting
870 env::set_var(constants::env_vars::ENABLE_FMT_LAYER, "invalid");
871 let config = TelemetryConfig::builder().enable_fmt_layer(true).build();
872
873 // Initialize telemetry - should log a warning but use code setting
874 let result = init_telemetry(config).await;
875 assert!(result.is_ok());
876
877 // Clean up
878 cleanup_env();
879 }
880
881 #[tokio::test]
882 #[sealed_test]
883 async fn test_telemetry_config_env_fmt_layer_not_set() {
884 cleanup_env();
885
886 // Test: No env var uses code setting
887 let config = TelemetryConfig::default();
888 assert!(!config.enable_fmt_layer);
889
890 let result = init_telemetry(config).await;
891 assert!(result.is_ok());
892
893 // Clean up
894 cleanup_env();
895 }
896
897 #[test]
898 fn test_completion_handler_sync_mode() {
899 let provider = Arc::new(
900 SdkTracerProvider::builder()
901 .with_span_processor(SimpleSpanProcessor::new(OtlpStdoutSpanExporter::default()))
902 .build(),
903 );
904
905 let handler = TelemetryCompletionHandler::new(provider, None, ProcessorMode::Sync);
906
907 // In sync mode, complete() should call force_flush
908 handler.complete();
909 // Note: We can't easily verify the flush was called since TracerProvider
910 // doesn't expose this information, but we can verify it doesn't panic
911 }
912
913 #[tokio::test]
914 async fn test_completion_handler_async_mode() {
915 let provider = Arc::new(
916 SdkTracerProvider::builder()
917 .with_span_processor(SimpleSpanProcessor::new(OtlpStdoutSpanExporter::default()))
918 .build(),
919 );
920
921 let (tx, mut rx) = mpsc::unbounded_channel();
922
923 let completion_handler =
924 TelemetryCompletionHandler::new(provider, Some(tx), ProcessorMode::Async);
925
926 // In async mode, complete() should send a message through the channel
927 completion_handler.complete();
928
929 // Verify that we received the completion signal
930 assert!(rx.try_recv().is_ok());
931 // Verify channel is now empty
932 assert!(rx.try_recv().is_err());
933 }
934
935 #[test]
936 fn test_completion_handler_finalize_mode() {
937 let provider = Arc::new(
938 SdkTracerProvider::builder()
939 .with_span_processor(SimpleSpanProcessor::new(OtlpStdoutSpanExporter::default()))
940 .build(),
941 );
942
943 let (tx, _rx) = mpsc::unbounded_channel();
944
945 let completion_handler =
946 TelemetryCompletionHandler::new(provider, Some(tx), ProcessorMode::Finalize);
947
948 // In finalize mode, complete() should do nothing
949 completion_handler.complete();
950 // Verify it doesn't panic or cause issues
951 }
952
953 #[test]
954 fn test_completion_handler_clone() {
955 let provider = Arc::new(
956 SdkTracerProvider::builder()
957 .with_span_processor(SimpleSpanProcessor::new(OtlpStdoutSpanExporter::default()))
958 .build(),
959 );
960
961 let (tx, _rx) = mpsc::unbounded_channel();
962
963 let completion_handler =
964 TelemetryCompletionHandler::new(provider, Some(tx), ProcessorMode::Async);
965
966 // Test that Clone is implemented correctly
967 let cloned = completion_handler.clone();
968
969 // Verify both handlers have the same mode
970 assert!(matches!(cloned.mode, ProcessorMode::Async));
971 assert!(cloned.sender.is_some());
972 }
973
974 #[test]
975 fn test_completion_handler_sync_mode_error_handling() {
976 let provider = Arc::new(
977 SdkTracerProvider::builder()
978 .with_span_processor(SimpleSpanProcessor::new(OtlpStdoutSpanExporter::default()))
979 .build(),
980 );
981
982 let completion_handler =
983 TelemetryCompletionHandler::new(provider, None, ProcessorMode::Sync);
984
985 // Test that complete() doesn't panic
986 completion_handler.complete();
987 }
988
989 #[tokio::test]
990 async fn test_completion_handler_async_mode_error_handling() {
991 let provider = Arc::new(
992 SdkTracerProvider::builder()
993 .with_span_processor(SimpleSpanProcessor::new(OtlpStdoutSpanExporter::default()))
994 .build(),
995 );
996
997 // Use UnboundedSender instead of Sender
998 let (tx, _rx) = mpsc::unbounded_channel();
999 // Fill the channel by dropping the receiver
1000 drop(_rx);
1001
1002 let completion_handler =
1003 TelemetryCompletionHandler::new(provider, Some(tx), ProcessorMode::Async);
1004
1005 // Test that complete() doesn't panic when receiver is dropped
1006 completion_handler.complete();
1007 }
1008
1009 #[test]
1010 #[sealed_test]
1011 fn test_telemetry_config_with_id_generator() {
1012 cleanup_env();
1013
1014 // Create a config with X-Ray ID generator
1015 let config = TelemetryConfig::builder()
1016 .with_id_generator(XrayIdGenerator::default())
1017 .build();
1018
1019 // We can't directly check the ID generator type since it's boxed inside the provider,
1020 // but we can verify it's applied by checking the generated trace IDs format
1021 let provider = Arc::new(config.provider_builder.build());
1022
1023 // Create a scope with attributes
1024 let scope = opentelemetry::InstrumentationScope::builder("test")
1025 .with_version(Cow::Borrowed(env!("CARGO_PKG_VERSION")))
1026 .build();
1027
1028 // Get a tracer using the correct API
1029 let tracer = provider.tracer_with_scope(scope);
1030
1031 // Start a span using the tracer
1032 let span = tracer.start_with_context("test span", &opentelemetry::Context::current());
1033 let trace_id = span.span_context().trace_id();
1034
1035 // Verify X-Ray trace ID format:
1036 // 1. Convert to hex string for easier checking
1037 let trace_id_hex = format!("{:032x}", trace_id);
1038
1039 // 2. The first 8 characters of X-Ray trace IDs represent a timestamp in seconds
1040 // This is the key characteristic of X-Ray trace IDs that we can verify
1041 let timestamp_part = &trace_id_hex[0..8];
1042
1043 // 3. Parse the hex timestamp to ensure it's a valid timestamp (recent past)
1044 let timestamp = u32::from_str_radix(timestamp_part, 16).unwrap();
1045
1046 // 4. Check that timestamp is reasonable (within the last day)
1047 let now = std::time::SystemTime::now()
1048 .duration_since(std::time::UNIX_EPOCH)
1049 .unwrap()
1050 .as_secs() as u32;
1051
1052 // The timestamp should be within the last day
1053 assert!(timestamp <= now);
1054 assert!(timestamp > now - 86400); // Within the last day
1055
1056 // Verify remaining 24 characters are not all zeros (random part)
1057 let random_part = &trace_id_hex[8..];
1058 assert_ne!(random_part, "000000000000000000000000");
1059 }
1060}
1061
1062// A simple no-op propagator
1063#[derive(Debug)]
1064struct NoopPropagator;
1065
1066impl NoopPropagator {
1067 fn new() -> Self {
1068 NoopPropagator
1069 }
1070}
1071
1072impl TextMapPropagator for NoopPropagator {
1073 fn inject_context(
1074 &self,
1075 _cx: &opentelemetry::Context,
1076 _injector: &mut dyn opentelemetry::propagation::Injector,
1077 ) {
1078 }
1079
1080 fn extract_with_context(
1081 &self,
1082 cx: &opentelemetry::Context,
1083 _extractor: &dyn opentelemetry::propagation::Extractor,
1084 ) -> opentelemetry::Context {
1085 cx.clone()
1086 }
1087
1088 fn fields(&self) -> opentelemetry::propagation::text_map_propagator::FieldIter<'_> {
1089 opentelemetry::propagation::text_map_propagator::FieldIter::new(&[])
1090 }
1091}