opentelemetry_sdk/trace/span_processor.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336
//! # OpenTelemetry Span Processor Interface
//!
//! Span processor is an interface which allows hooks for span start and end method
//! invocations. The span processors are invoked only when
//! [`is_recording`] is true.
//!
//! Built-in span processors are responsible for batching and conversion of spans to
//! exportable representation and passing batches to exporters.
//!
//! Span processors can be registered directly on SDK [`TracerProvider`] and they are
//! invoked in the same order as they were registered.
//!
//! All `Tracer` instances created by a `TracerProvider` share the same span processors.
//! Changes to this collection reflect in all `Tracer` instances.
//!
//! The following diagram shows `SpanProcessor`'s relationship to other components
//! in the SDK:
//!
//! ```ascii
//! +-----+--------------+ +-----------------------+ +-------------------+
//! | | | | | | |
//! | | | | (Batch)SpanProcessor | | SpanExporter |
//! | | +---> (Simple)SpanProcessor +---> (OTLPExporter) |
//! | | | | | | |
//! | SDK | Tracer.span()| +-----------------------+ +-------------------+
//! | | Span.end() |
//! | | |
//! | | |
//! | | |
//! | | |
//! +-----+--------------+
//! ```
//!
//! [`is_recording`]: opentelemetry::trace::Span::is_recording()
//! [`TracerProvider`]: opentelemetry::trace::TracerProvider
use crate::error::{OTelSdkError, OTelSdkResult};
use crate::resource::Resource;
use crate::trace::Span;
use crate::trace::{SpanData, SpanExporter};
use opentelemetry::Context;
use opentelemetry::{otel_debug, otel_warn};
use opentelemetry::{otel_error, otel_info};
use std::cmp::min;
use std::sync::atomic::{AtomicUsize, Ordering};
use std::sync::{Arc, Mutex};
use std::{env, str::FromStr, time::Duration};
use std::sync::atomic::AtomicBool;
use std::thread;
use std::time::Instant;
/// Delay interval between two consecutive exports.
pub(crate) const OTEL_BSP_SCHEDULE_DELAY: &str = "OTEL_BSP_SCHEDULE_DELAY";
/// Default delay interval between two consecutive exports.
pub(crate) const OTEL_BSP_SCHEDULE_DELAY_DEFAULT: u64 = 5_000;
/// Maximum queue size
pub(crate) const OTEL_BSP_MAX_QUEUE_SIZE: &str = "OTEL_BSP_MAX_QUEUE_SIZE";
/// Default maximum queue size
pub(crate) const OTEL_BSP_MAX_QUEUE_SIZE_DEFAULT: usize = 2_048;
/// Maximum batch size, must be less than or equal to OTEL_BSP_MAX_QUEUE_SIZE
pub(crate) const OTEL_BSP_MAX_EXPORT_BATCH_SIZE: &str = "OTEL_BSP_MAX_EXPORT_BATCH_SIZE";
/// Default maximum batch size
pub(crate) const OTEL_BSP_MAX_EXPORT_BATCH_SIZE_DEFAULT: usize = 512;
/// Maximum allowed time to export data.
pub(crate) const OTEL_BSP_EXPORT_TIMEOUT: &str = "OTEL_BSP_EXPORT_TIMEOUT";
/// Default maximum allowed time to export data.
pub(crate) const OTEL_BSP_EXPORT_TIMEOUT_DEFAULT: u64 = 30_000;
/// Environment variable to configure max concurrent exports for batch span
/// processor.
pub(crate) const OTEL_BSP_MAX_CONCURRENT_EXPORTS: &str = "OTEL_BSP_MAX_CONCURRENT_EXPORTS";
/// Default max concurrent exports for BSP
pub(crate) const OTEL_BSP_MAX_CONCURRENT_EXPORTS_DEFAULT: usize = 1;
/// `SpanProcessor` is an interface which allows hooks for span start and end
/// method invocations. The span processors are invoked only when is_recording
/// is true.
pub trait SpanProcessor: Send + Sync + std::fmt::Debug {
/// `on_start` is called when a `Span` is started. This method is called
/// synchronously on the thread that started the span, therefore it should
/// not block or throw exceptions.
fn on_start(&self, span: &mut Span, cx: &Context);
/// `on_end` is called after a `Span` is ended (i.e., the end timestamp is
/// already set). This method is called synchronously within the `Span::end`
/// API, therefore it should not block or throw an exception.
/// TODO - This method should take reference to `SpanData`
fn on_end(&self, span: SpanData);
/// Force the spans lying in the cache to be exported.
fn force_flush(&self) -> OTelSdkResult;
/// Shuts down the processor. Called when SDK is shut down. This is an
/// opportunity for processors to do any cleanup required.
///
/// Implementation should make sure shutdown can be called multiple times.
fn shutdown(&self) -> OTelSdkResult;
/// Set the resource for the span processor.
fn set_resource(&mut self, _resource: &Resource) {}
}
/// A [SpanProcessor] that passes finished spans to the configured
/// `SpanExporter`, as soon as they are finished, without any batching. This is
/// typically useful for debugging and testing. For scenarios requiring higher
/// performance/throughput, consider using [BatchSpanProcessor].
/// Spans are exported synchronously
/// in the same thread that emits the log record.
/// When using this processor with the OTLP Exporter, the following exporter
/// features are supported:
/// - `grpc-tonic`: This requires TracerProvider to be created within a tokio
/// runtime. Spans can be emitted from any thread, including tokio runtime
/// threads.
/// - `reqwest-blocking-client`: TracerProvider may be created anywhere, but
/// spans must be emitted from a non-tokio runtime thread.
/// - `reqwest-client`: TracerProvider may be created anywhere, but spans must be
/// emitted from a tokio runtime thread.
#[derive(Debug)]
pub struct SimpleSpanProcessor {
exporter: Mutex<Box<dyn SpanExporter>>,
}
impl SimpleSpanProcessor {
/// Create a new [SimpleSpanProcessor] using the provided exporter.
pub fn new(exporter: Box<dyn SpanExporter>) -> Self {
Self {
exporter: Mutex::new(exporter),
}
}
}
impl SpanProcessor for SimpleSpanProcessor {
fn on_start(&self, _span: &mut Span, _cx: &Context) {
// Ignored
}
fn on_end(&self, span: SpanData) {
if !span.span_context.is_sampled() {
return;
}
let result = self
.exporter
.lock()
.map_err(|_| OTelSdkError::InternalFailure("SimpleSpanProcessor mutex poison".into()))
.and_then(|mut exporter| futures_executor::block_on(exporter.export(vec![span])));
if let Err(err) = result {
// TODO: check error type, and log `error` only if the error is user-actionable, else log `debug`
otel_debug!(
name: "SimpleProcessor.OnEnd.Error",
reason = format!("{:?}", err)
);
}
}
fn force_flush(&self) -> OTelSdkResult {
// Nothing to flush for simple span processor.
Ok(())
}
fn shutdown(&self) -> OTelSdkResult {
if let Ok(mut exporter) = self.exporter.lock() {
exporter.shutdown()
} else {
Err(OTelSdkError::InternalFailure(
"SimpleSpanProcessor mutex poison at shutdown".into(),
))
}
}
fn set_resource(&mut self, resource: &Resource) {
if let Ok(mut exporter) = self.exporter.lock() {
exporter.set_resource(resource);
}
}
}
/// The `BatchSpanProcessor` collects finished spans in a buffer and exports them
/// in batches to the configured `SpanExporter`. This processor is ideal for
/// high-throughput environments, as it minimizes the overhead of exporting spans
/// individually. It uses a **dedicated background thread** to manage and export spans
/// asynchronously, ensuring that the application's main execution flow is not blocked.
///
/// When using this processor with the OTLP Exporter, the following exporter
/// features are supported:
/// - `grpc-tonic`: This requires `TracerProvider` to be created within a tokio
/// runtime.
/// - `reqwest-blocking-client`: Works with a regular `main` or `tokio::main`.
///
/// In other words, other clients like `reqwest` and `hyper` are not supported.
/// /// # Example
///
/// This example demonstrates how to configure and use the `BatchSpanProcessor`
/// with a custom configuration. Note that a dedicated thread is used internally
/// to manage the export process.
///
/// ```rust
/// use opentelemetry::global;
/// use opentelemetry_sdk::{
/// trace::{BatchSpanProcessor, BatchConfigBuilder, TracerProvider},
/// runtime,
/// testing::trace::NoopSpanExporter,
/// };
/// use opentelemetry::trace::Tracer as _;
/// use opentelemetry::trace::Span;
/// use std::time::Duration;
///
/// fn main() {
/// // Step 1: Create an exporter (e.g., a No-Op Exporter for demonstration).
/// let exporter = NoopSpanExporter::new();
///
/// // Step 2: Configure the BatchSpanProcessor.
/// let batch_processor = BatchSpanProcessor::builder(exporter)
/// .with_batch_config(
/// BatchConfigBuilder::default()
/// .with_max_queue_size(1024) // Buffer up to 1024 spans.
/// .with_max_export_batch_size(256) // Export in batches of up to 256 spans.
/// .with_scheduled_delay(Duration::from_secs(5)) // Export every 5 seconds.
/// .build(),
/// )
/// .build();
///
/// // Step 3: Set up a TracerProvider with the configured processor.
/// let provider = TracerProvider::builder()
/// .with_span_processor(batch_processor)
/// .build();
/// global::set_tracer_provider(provider.clone());
///
/// // Step 4: Create spans and record operations.
/// let tracer = global::tracer("example-tracer");
/// let mut span = tracer.start("example-span");
/// span.end(); // Mark the span as completed.
///
/// // Step 5: Ensure all spans are flushed before exiting.
/// provider.shutdown();
/// }
/// ```
use std::sync::mpsc::sync_channel;
use std::sync::mpsc::Receiver;
use std::sync::mpsc::RecvTimeoutError;
use std::sync::mpsc::SyncSender;
/// Messages exchanged between the main thread and the background thread.
#[allow(clippy::large_enum_variant)]
#[derive(Debug)]
enum BatchMessage {
//ExportSpan(SpanData),
ExportSpan(Arc<AtomicBool>),
ForceFlush(SyncSender<OTelSdkResult>),
Shutdown(SyncSender<OTelSdkResult>),
SetResource(Arc<Resource>),
}
/// The `BatchSpanProcessor` collects finished spans in a buffer and exports them
/// in batches to the configured `SpanExporter`. This processor is ideal for
/// high-throughput environments, as it minimizes the overhead of exporting spans
/// individually. It uses a **dedicated background thread** to manage and export spans
/// asynchronously, ensuring that the application's main execution flow is not blocked.
///
/// This processor supports the following configurations:
/// - **Queue size**: Maximum number of spans that can be buffered.
/// - **Batch size**: Maximum number of spans to include in a single export.
/// - **Scheduled delay**: Frequency at which the batch is exported.
///
/// When using this processor with the OTLP Exporter, the following exporter
/// features are supported:
/// - `grpc-tonic`: Requires `TracerProvider` to be created within a tokio runtime.
/// - `reqwest-blocking-client`: Works with a regular `main` or `tokio::main`.
///
/// In other words, other clients like `reqwest` and `hyper` are not supported.
///
/// `BatchSpanProcessor` buffers spans in memory and exports them in batches. An
/// export is triggered when `max_export_batch_size` is reached or every
/// `scheduled_delay` milliseconds. Users can explicitly trigger an export using
/// the `force_flush` method. Shutdown also triggers an export of all buffered
/// spans and is recommended to be called before the application exits to ensure
/// all buffered spans are exported.
///
/// **Warning**: When using tokio's current-thread runtime, `shutdown()`, which
/// is a blocking call ,should not be called from your main thread. This can
/// cause deadlock. Instead, call `shutdown()` from a separate thread or use
/// tokio's `spawn_blocking`.
///
/// [`shutdown()`]: crate::trace::TracerProvider::shutdown
/// [`force_flush()`]: crate::trace::TracerProvider::force_flush
#[derive(Debug)]
pub struct BatchSpanProcessor {
span_sender: SyncSender<SpanData>, // Data channel to store spans
message_sender: SyncSender<BatchMessage>, // Control channel to store control messages.
handle: Mutex<Option<thread::JoinHandle<()>>>,
forceflush_timeout: Duration,
shutdown_timeout: Duration,
is_shutdown: AtomicBool,
dropped_span_count: Arc<AtomicUsize>,
export_span_message_sent: Arc<AtomicBool>,
current_batch_size: Arc<AtomicUsize>,
max_export_batch_size: usize,
max_queue_size: usize,
}
impl BatchSpanProcessor {
/// Creates a new instance of `BatchSpanProcessor`.
pub fn new<E>(
mut exporter: E,
config: BatchConfig,
//max_queue_size: usize,
//scheduled_delay: Duration,
//shutdown_timeout: Duration,
) -> Self
where
E: SpanExporter + Send + 'static,
{
let (span_sender, span_receiver) = sync_channel::<SpanData>(config.max_queue_size);
let (message_sender, message_receiver) = sync_channel::<BatchMessage>(64); // Is this a reasonable bound?
let max_queue_size = config.max_queue_size;
let max_export_batch_size = config.max_export_batch_size;
let current_batch_size = Arc::new(AtomicUsize::new(0));
let current_batch_size_for_thread = current_batch_size.clone();
let handle = thread::Builder::new()
.name("OpenTelemetry.Traces.BatchProcessor".to_string())
.spawn(move || {
otel_info!(
name: "BatchSpanProcessor.ThreadStarted",
interval_in_millisecs = config.scheduled_delay.as_millis(),
max_export_batch_size = config.max_export_batch_size,
max_queue_size = config.max_queue_size,
);
let mut spans = Vec::with_capacity(config.max_export_batch_size);
let mut last_export_time = Instant::now();
let current_batch_size = current_batch_size_for_thread;
loop {
let remaining_time_option = config
.scheduled_delay
.checked_sub(last_export_time.elapsed());
let remaining_time = match remaining_time_option {
Some(remaining_time) => remaining_time,
None => config.scheduled_delay,
};
match message_receiver.recv_timeout(remaining_time) {
Ok(message) => match message {
BatchMessage::ExportSpan(export_span_message_sent) => {
// Reset the export span message sent flag now it has has been processed.
export_span_message_sent.store(false, Ordering::Relaxed);
otel_debug!(
name: "BatchSpanProcessor.ExportingDueToBatchSize",
);
let _ = Self::get_spans_and_export(
&span_receiver,
&mut exporter,
&mut spans,
&mut last_export_time,
¤t_batch_size,
&config,
);
}
BatchMessage::ForceFlush(sender) => {
otel_debug!(name: "BatchSpanProcessor.ExportingDueToForceFlush");
let result = Self::get_spans_and_export(
&span_receiver,
&mut exporter,
&mut spans,
&mut last_export_time,
¤t_batch_size,
&config,
);
let _ = sender.send(result);
}
BatchMessage::Shutdown(sender) => {
otel_debug!(name: "BatchSpanProcessor.ExportingDueToShutdown");
let result = Self::get_spans_and_export(
&span_receiver,
&mut exporter,
&mut spans,
&mut last_export_time,
¤t_batch_size,
&config,
);
let _ = sender.send(result);
otel_debug!(
name: "BatchSpanProcessor.ThreadExiting",
reason = "ShutdownRequested"
);
//
// break out the loop and return from the current background thread.
//
break;
}
BatchMessage::SetResource(resource) => {
exporter.set_resource(&resource);
}
},
Err(RecvTimeoutError::Timeout) => {
otel_debug!(
name: "BatchSpanProcessor.ExportingDueToTimer",
);
let _ = Self::get_spans_and_export(
&span_receiver,
&mut exporter,
&mut spans,
&mut last_export_time,
¤t_batch_size,
&config,
);
}
Err(RecvTimeoutError::Disconnected) => {
// Channel disconnected, only thing to do is break
// out (i.e exit the thread)
otel_debug!(
name: "BatchSpanProcessor.ThreadExiting",
reason = "MessageSenderDisconnected"
);
break;
}
}
}
otel_info!(
name: "BatchSpanProcessor.ThreadStopped"
);
})
.expect("Failed to spawn thread"); //TODO: Handle thread spawn failure
Self {
span_sender,
message_sender,
handle: Mutex::new(Some(handle)),
forceflush_timeout: Duration::from_secs(5), // TODO: make this configurable
shutdown_timeout: Duration::from_secs(5), // TODO: make this configurable
is_shutdown: AtomicBool::new(false),
dropped_span_count: Arc::new(AtomicUsize::new(0)),
max_queue_size,
export_span_message_sent: Arc::new(AtomicBool::new(false)),
current_batch_size,
max_export_batch_size,
}
}
/// builder
pub fn builder<E>(exporter: E) -> BatchSpanProcessorBuilder<E>
where
E: SpanExporter + Send + 'static,
{
BatchSpanProcessorBuilder {
exporter,
config: BatchConfig::default(),
}
}
// This method gets upto `max_export_batch_size` amount of spans from the channel and exports them.
// It returns the result of the export operation.
// It expects the span vec to be empty when it's called.
#[inline]
fn get_spans_and_export<E>(
spans_receiver: &Receiver<SpanData>,
exporter: &mut E,
spans: &mut Vec<SpanData>,
last_export_time: &mut Instant,
current_batch_size: &AtomicUsize,
config: &BatchConfig,
) -> OTelSdkResult
where
E: SpanExporter + Send + Sync + 'static,
{
// Get upto `max_export_batch_size` amount of spans from the channel and push them to the span vec
while let Ok(span) = spans_receiver.try_recv() {
spans.push(span);
if spans.len() == config.max_export_batch_size {
break;
}
}
let count_of_spans = spans.len(); // Count of spans that will be exported
let result = Self::export_batch_sync(exporter, spans, last_export_time); // This method clears the spans vec after exporting
current_batch_size.fetch_sub(count_of_spans, Ordering::Relaxed);
result
}
#[allow(clippy::vec_box)]
fn export_batch_sync<E>(
exporter: &mut E,
batch: &mut Vec<SpanData>,
last_export_time: &mut Instant,
) -> OTelSdkResult
where
E: SpanExporter + Send + Sync + 'static,
{
*last_export_time = Instant::now();
if batch.is_empty() {
return OTelSdkResult::Ok(());
}
let export = exporter.export(batch.split_off(0));
let export_result = futures_executor::block_on(export);
match export_result {
Ok(_) => OTelSdkResult::Ok(()),
Err(err) => {
otel_error!(
name: "BatchSpanProcessor.ExportError",
error = format!("{}", err)
);
Err(OTelSdkError::InternalFailure(err.to_string()))
}
}
}
}
impl SpanProcessor for BatchSpanProcessor {
/// Handles span start.
fn on_start(&self, _span: &mut Span, _cx: &Context) {
// Ignored
}
/// Handles span end.
fn on_end(&self, span: SpanData) {
if self.is_shutdown.load(Ordering::Relaxed) {
// this is a warning, as the user is trying to emit after the processor has been shutdown
otel_warn!(
name: "BatchSpanProcessor.Emit.ProcessorShutdown",
message = "BatchSpanProcessor has been shutdown. No further spans will be emitted."
);
return;
}
let result = self.span_sender.try_send(span);
if result.is_err() {
// Increment dropped span count. The first time we have to drop a span,
// emit a warning.
if self.dropped_span_count.fetch_add(1, Ordering::Relaxed) == 0 {
otel_warn!(name: "BatchSpanProcessor.SpanDroppingStarted",
message = "BatchSpanProcessor dropped a Span due to queue full/internal errors. No further internal log will be emitted for further drops until Shutdown. During Shutdown time, a log will be emitted with exact count of total Spans dropped.");
}
}
// At this point, sending the span to the data channel was successful.
// Increment the current batch size and check if it has reached the max export batch size.
if self.current_batch_size.fetch_add(1, Ordering::Relaxed) + 1 >= self.max_export_batch_size
{
// Check if the a control message for exporting spans is already sent to the worker thread.
// If not, send a control message to export spans.
// `export_span_message_sent` is set to false ONLY when the worker thread has processed the control message.
if !self.export_span_message_sent.load(Ordering::Relaxed) {
// This is a cost-efficient check as atomic load operations do not require exclusive access to cache line.
// Perform atomic swap to `export_span_message_sent` ONLY when the atomic load operation above returns false.
// Atomic swap/compare_exchange operations require exclusive access to cache line on most processor architectures.
// We could have used compare_exchange as well here, but it's more verbose than swap.
if !self.export_span_message_sent.swap(true, Ordering::Relaxed) {
match self.message_sender.try_send(BatchMessage::ExportSpan(
self.export_span_message_sent.clone(),
)) {
Ok(_) => {
// Control message sent successfully.
}
Err(_err) => {
// TODO: Log error
// If the control message could not be sent, reset the `export_span_message_sent` flag.
self.export_span_message_sent
.store(false, Ordering::Relaxed);
}
}
}
}
}
}
/// Flushes all pending spans.
fn force_flush(&self) -> OTelSdkResult {
if self.is_shutdown.load(Ordering::Relaxed) {
return Err(OTelSdkError::AlreadyShutdown);
}
let (sender, receiver) = sync_channel(1);
self.message_sender
.try_send(BatchMessage::ForceFlush(sender))
.map_err(|e| OTelSdkError::InternalFailure(e.to_string()))?;
receiver
.recv_timeout(self.forceflush_timeout)
.map_err(|_| OTelSdkError::Timeout(self.forceflush_timeout))?
}
/// Shuts down the processor.
fn shutdown(&self) -> OTelSdkResult {
if self.is_shutdown.swap(true, Ordering::Relaxed) {
return Err(OTelSdkError::AlreadyShutdown);
}
let dropped_spans = self.dropped_span_count.load(Ordering::Relaxed);
let max_queue_size = self.max_queue_size;
if dropped_spans > 0 {
otel_warn!(
name: "BatchSpanProcessor.SpansDropped",
dropped_span_count = dropped_spans,
max_queue_size = max_queue_size,
message = "Spans were dropped due to a queue being full or other error. The count represents the total count of spans dropped in the lifetime of this BatchSpanProcessor. Consider increasing the queue size and/or decrease delay between intervals."
);
}
let (sender, receiver) = sync_channel(1);
self.message_sender
.try_send(BatchMessage::Shutdown(sender))
.map_err(|e| OTelSdkError::InternalFailure(e.to_string()))?;
let result = receiver
.recv_timeout(self.shutdown_timeout)
.map_err(|_| OTelSdkError::Timeout(self.shutdown_timeout))?;
if let Some(handle) = self.handle.lock().unwrap().take() {
if let Err(err) = handle.join() {
return Err(OTelSdkError::InternalFailure(format!(
"Background thread failed to join during shutdown. This may indicate a panic or unexpected termination: {:?}",
err
)));
}
}
result
}
/// Set the resource for the processor.
fn set_resource(&mut self, resource: &Resource) {
let resource = Arc::new(resource.clone());
let _ = self
.message_sender
.try_send(BatchMessage::SetResource(resource));
}
}
/// Builder for `BatchSpanProcessorDedicatedThread`.
#[derive(Debug, Default)]
pub struct BatchSpanProcessorBuilder<E>
where
E: SpanExporter + Send + 'static,
{
exporter: E,
config: BatchConfig,
}
impl<E> BatchSpanProcessorBuilder<E>
where
E: SpanExporter + Send + 'static,
{
/// Set the BatchConfig for [BatchSpanProcessorBuilder]
pub fn with_batch_config(self, config: BatchConfig) -> Self {
BatchSpanProcessorBuilder { config, ..self }
}
/// Build a new instance of `BatchSpanProcessor`.
pub fn build(self) -> BatchSpanProcessor {
BatchSpanProcessor::new(self.exporter, self.config)
}
}
/// Batch span processor configuration.
/// Use [`BatchConfigBuilder`] to configure your own instance of [`BatchConfig`].
#[derive(Debug)]
pub struct BatchConfig {
/// The maximum queue size to buffer spans for delayed processing. If the
/// queue gets full it drops the spans. The default value of is 2048.
pub(crate) max_queue_size: usize,
/// The delay interval in milliseconds between two consecutive processing
/// of batches. The default value is 5 seconds.
pub(crate) scheduled_delay: Duration,
#[allow(dead_code)]
/// The maximum number of spans to process in a single batch. If there are
/// more than one batch worth of spans then it processes multiple batches
/// of spans one batch after the other without any delay. The default value
/// is 512.
pub(crate) max_export_batch_size: usize,
#[allow(dead_code)]
/// The maximum duration to export a batch of data.
pub(crate) max_export_timeout: Duration,
#[allow(dead_code)]
/// Maximum number of concurrent exports
///
/// Limits the number of spawned tasks for exports and thus memory consumed
/// by an exporter. A value of 1 will cause exports to be performed
/// synchronously on the BatchSpanProcessor task.
pub(crate) max_concurrent_exports: usize,
}
impl Default for BatchConfig {
fn default() -> Self {
BatchConfigBuilder::default().build()
}
}
/// A builder for creating [`BatchConfig`] instances.
#[derive(Debug)]
pub struct BatchConfigBuilder {
max_queue_size: usize,
scheduled_delay: Duration,
max_export_batch_size: usize,
max_export_timeout: Duration,
max_concurrent_exports: usize,
}
impl Default for BatchConfigBuilder {
/// Create a new [`BatchConfigBuilder`] initialized with default batch config values as per the specs.
/// The values are overriden by environment variables if set.
/// The supported environment variables are:
/// * `OTEL_BSP_MAX_QUEUE_SIZE`
/// * `OTEL_BSP_SCHEDULE_DELAY`
/// * `OTEL_BSP_MAX_EXPORT_BATCH_SIZE`
/// * `OTEL_BSP_EXPORT_TIMEOUT`
/// * `OTEL_BSP_MAX_CONCURRENT_EXPORTS`
fn default() -> Self {
BatchConfigBuilder {
max_queue_size: OTEL_BSP_MAX_QUEUE_SIZE_DEFAULT,
scheduled_delay: Duration::from_millis(OTEL_BSP_SCHEDULE_DELAY_DEFAULT),
max_export_batch_size: OTEL_BSP_MAX_EXPORT_BATCH_SIZE_DEFAULT,
max_export_timeout: Duration::from_millis(OTEL_BSP_EXPORT_TIMEOUT_DEFAULT),
max_concurrent_exports: OTEL_BSP_MAX_CONCURRENT_EXPORTS_DEFAULT,
}
.init_from_env_vars()
}
}
impl BatchConfigBuilder {
/// Set max_queue_size for [`BatchConfigBuilder`].
/// It's the maximum queue size to buffer spans for delayed processing.
/// If the queue gets full it will drops the spans.
/// The default value of is 2048.
pub fn with_max_queue_size(mut self, max_queue_size: usize) -> Self {
self.max_queue_size = max_queue_size;
self
}
/// Set max_export_batch_size for [`BatchConfigBuilder`].
/// It's the maximum number of spans to process in a single batch. If there are
/// more than one batch worth of spans then it processes multiple batches
/// of spans one batch after the other without any delay. The default value
/// is 512.
pub fn with_max_export_batch_size(mut self, max_export_batch_size: usize) -> Self {
self.max_export_batch_size = max_export_batch_size;
self
}
#[cfg(feature = "experimental_trace_batch_span_processor_with_async_runtime")]
/// Set max_concurrent_exports for [`BatchConfigBuilder`].
/// It's the maximum number of concurrent exports.
/// Limits the number of spawned tasks for exports and thus memory consumed by an exporter.
/// The default value is 1.
/// If the max_concurrent_exports value is default value, it will cause exports to be performed
/// synchronously on the BatchSpanProcessor task.
pub fn with_max_concurrent_exports(mut self, max_concurrent_exports: usize) -> Self {
self.max_concurrent_exports = max_concurrent_exports;
self
}
/// Set scheduled_delay_duration for [`BatchConfigBuilder`].
/// It's the delay interval in milliseconds between two consecutive processing of batches.
/// The default value is 5000 milliseconds.
pub fn with_scheduled_delay(mut self, scheduled_delay: Duration) -> Self {
self.scheduled_delay = scheduled_delay;
self
}
/// Set max_export_timeout for [`BatchConfigBuilder`].
/// It's the maximum duration to export a batch of data.
/// The The default value is 30000 milliseconds.
#[cfg(feature = "experimental_trace_batch_span_processor_with_async_runtime")]
pub fn with_max_export_timeout(mut self, max_export_timeout: Duration) -> Self {
self.max_export_timeout = max_export_timeout;
self
}
/// Builds a `BatchConfig` enforcing the following invariants:
/// * `max_export_batch_size` must be less than or equal to `max_queue_size`.
pub fn build(self) -> BatchConfig {
// max export batch size must be less or equal to max queue size.
// we set max export batch size to max queue size if it's larger than max queue size.
let max_export_batch_size = min(self.max_export_batch_size, self.max_queue_size);
BatchConfig {
max_queue_size: self.max_queue_size,
scheduled_delay: self.scheduled_delay,
max_export_timeout: self.max_export_timeout,
max_concurrent_exports: self.max_concurrent_exports,
max_export_batch_size,
}
}
fn init_from_env_vars(mut self) -> Self {
if let Some(max_concurrent_exports) = env::var(OTEL_BSP_MAX_CONCURRENT_EXPORTS)
.ok()
.and_then(|max_concurrent_exports| usize::from_str(&max_concurrent_exports).ok())
{
self.max_concurrent_exports = max_concurrent_exports;
}
if let Some(max_queue_size) = env::var(OTEL_BSP_MAX_QUEUE_SIZE)
.ok()
.and_then(|queue_size| usize::from_str(&queue_size).ok())
{
self.max_queue_size = max_queue_size;
}
if let Some(scheduled_delay) = env::var(OTEL_BSP_SCHEDULE_DELAY)
.ok()
.and_then(|delay| u64::from_str(&delay).ok())
{
self.scheduled_delay = Duration::from_millis(scheduled_delay);
}
if let Some(max_export_batch_size) = env::var(OTEL_BSP_MAX_EXPORT_BATCH_SIZE)
.ok()
.and_then(|batch_size| usize::from_str(&batch_size).ok())
{
self.max_export_batch_size = max_export_batch_size;
}
// max export batch size must be less or equal to max queue size.
// we set max export batch size to max queue size if it's larger than max queue size.
if self.max_export_batch_size > self.max_queue_size {
self.max_export_batch_size = self.max_queue_size;
}
if let Some(max_export_timeout) = env::var(OTEL_BSP_EXPORT_TIMEOUT)
.ok()
.and_then(|timeout| u64::from_str(&timeout).ok())
{
self.max_export_timeout = Duration::from_millis(max_export_timeout);
}
self
}
}
#[cfg(all(test, feature = "testing", feature = "trace"))]
mod tests {
// cargo test trace::span_processor::tests:: --features=testing
use super::{
BatchSpanProcessor, SimpleSpanProcessor, SpanProcessor, OTEL_BSP_EXPORT_TIMEOUT,
OTEL_BSP_MAX_EXPORT_BATCH_SIZE, OTEL_BSP_MAX_QUEUE_SIZE, OTEL_BSP_MAX_QUEUE_SIZE_DEFAULT,
OTEL_BSP_SCHEDULE_DELAY, OTEL_BSP_SCHEDULE_DELAY_DEFAULT,
};
use crate::error::OTelSdkResult;
use crate::testing::trace::new_test_export_span_data;
use crate::trace::span_processor::{
OTEL_BSP_EXPORT_TIMEOUT_DEFAULT, OTEL_BSP_MAX_CONCURRENT_EXPORTS,
OTEL_BSP_MAX_CONCURRENT_EXPORTS_DEFAULT, OTEL_BSP_MAX_EXPORT_BATCH_SIZE_DEFAULT,
};
use crate::trace::InMemorySpanExporterBuilder;
use crate::trace::{BatchConfig, BatchConfigBuilder, SpanEvents, SpanLinks};
use crate::trace::{SpanData, SpanExporter};
use opentelemetry::trace::{SpanContext, SpanId, SpanKind, Status};
use std::fmt::Debug;
use std::time::Duration;
#[test]
fn simple_span_processor_on_end_calls_export() {
let exporter = InMemorySpanExporterBuilder::new().build();
let processor = SimpleSpanProcessor::new(Box::new(exporter.clone()));
let span_data = new_test_export_span_data();
processor.on_end(span_data.clone());
assert_eq!(exporter.get_finished_spans().unwrap()[0], span_data);
let _result = processor.shutdown();
}
#[test]
fn simple_span_processor_on_end_skips_export_if_not_sampled() {
let exporter = InMemorySpanExporterBuilder::new().build();
let processor = SimpleSpanProcessor::new(Box::new(exporter.clone()));
let unsampled = SpanData {
span_context: SpanContext::empty_context(),
parent_span_id: SpanId::INVALID,
span_kind: SpanKind::Internal,
name: "opentelemetry".into(),
start_time: opentelemetry::time::now(),
end_time: opentelemetry::time::now(),
attributes: Vec::new(),
dropped_attributes_count: 0,
events: SpanEvents::default(),
links: SpanLinks::default(),
status: Status::Unset,
instrumentation_scope: Default::default(),
};
processor.on_end(unsampled);
assert!(exporter.get_finished_spans().unwrap().is_empty());
}
#[test]
fn simple_span_processor_shutdown_calls_shutdown() {
let exporter = InMemorySpanExporterBuilder::new().build();
let processor = SimpleSpanProcessor::new(Box::new(exporter.clone()));
let span_data = new_test_export_span_data();
processor.on_end(span_data.clone());
assert!(!exporter.get_finished_spans().unwrap().is_empty());
let _result = processor.shutdown();
// Assume shutdown is called by ensuring spans are empty in the exporter
assert!(exporter.get_finished_spans().unwrap().is_empty());
}
#[test]
fn test_default_const_values() {
assert_eq!(OTEL_BSP_MAX_QUEUE_SIZE, "OTEL_BSP_MAX_QUEUE_SIZE");
assert_eq!(OTEL_BSP_MAX_QUEUE_SIZE_DEFAULT, 2048);
assert_eq!(OTEL_BSP_SCHEDULE_DELAY, "OTEL_BSP_SCHEDULE_DELAY");
assert_eq!(OTEL_BSP_SCHEDULE_DELAY_DEFAULT, 5000);
assert_eq!(
OTEL_BSP_MAX_EXPORT_BATCH_SIZE,
"OTEL_BSP_MAX_EXPORT_BATCH_SIZE"
);
assert_eq!(OTEL_BSP_MAX_EXPORT_BATCH_SIZE_DEFAULT, 512);
assert_eq!(OTEL_BSP_EXPORT_TIMEOUT, "OTEL_BSP_EXPORT_TIMEOUT");
assert_eq!(OTEL_BSP_EXPORT_TIMEOUT_DEFAULT, 30000);
}
#[test]
fn test_default_batch_config_adheres_to_specification() {
let env_vars = vec![
OTEL_BSP_SCHEDULE_DELAY,
OTEL_BSP_EXPORT_TIMEOUT,
OTEL_BSP_MAX_QUEUE_SIZE,
OTEL_BSP_MAX_EXPORT_BATCH_SIZE,
OTEL_BSP_MAX_CONCURRENT_EXPORTS,
];
let config = temp_env::with_vars_unset(env_vars, BatchConfig::default);
assert_eq!(
config.max_concurrent_exports,
OTEL_BSP_MAX_CONCURRENT_EXPORTS_DEFAULT
);
assert_eq!(
config.scheduled_delay,
Duration::from_millis(OTEL_BSP_SCHEDULE_DELAY_DEFAULT)
);
assert_eq!(
config.max_export_timeout,
Duration::from_millis(OTEL_BSP_EXPORT_TIMEOUT_DEFAULT)
);
assert_eq!(config.max_queue_size, OTEL_BSP_MAX_QUEUE_SIZE_DEFAULT);
assert_eq!(
config.max_export_batch_size,
OTEL_BSP_MAX_EXPORT_BATCH_SIZE_DEFAULT
);
}
#[test]
fn test_batch_config_configurable_by_env_vars() {
let env_vars = vec![
(OTEL_BSP_SCHEDULE_DELAY, Some("2000")),
(OTEL_BSP_EXPORT_TIMEOUT, Some("60000")),
(OTEL_BSP_MAX_QUEUE_SIZE, Some("4096")),
(OTEL_BSP_MAX_EXPORT_BATCH_SIZE, Some("1024")),
];
let config = temp_env::with_vars(env_vars, BatchConfig::default);
assert_eq!(config.scheduled_delay, Duration::from_millis(2000));
assert_eq!(config.max_export_timeout, Duration::from_millis(60000));
assert_eq!(config.max_queue_size, 4096);
assert_eq!(config.max_export_batch_size, 1024);
}
#[test]
fn test_batch_config_max_export_batch_size_validation() {
let env_vars = vec![
(OTEL_BSP_MAX_QUEUE_SIZE, Some("256")),
(OTEL_BSP_MAX_EXPORT_BATCH_SIZE, Some("1024")),
];
let config = temp_env::with_vars(env_vars, BatchConfig::default);
assert_eq!(config.max_queue_size, 256);
assert_eq!(config.max_export_batch_size, 256);
assert_eq!(
config.scheduled_delay,
Duration::from_millis(OTEL_BSP_SCHEDULE_DELAY_DEFAULT)
);
assert_eq!(
config.max_export_timeout,
Duration::from_millis(OTEL_BSP_EXPORT_TIMEOUT_DEFAULT)
);
}
#[test]
fn test_batch_config_with_fields() {
let batch = BatchConfigBuilder::default()
.with_max_export_batch_size(10)
.with_scheduled_delay(Duration::from_millis(10))
.with_max_queue_size(10);
#[cfg(feature = "experimental_trace_batch_span_processor_with_async_runtime")]
let batch = batch.with_max_concurrent_exports(10);
#[cfg(feature = "experimental_trace_batch_span_processor_with_async_runtime")]
let batch = batch.with_max_export_timeout(Duration::from_millis(10));
let batch = batch.build();
assert_eq!(batch.max_export_batch_size, 10);
assert_eq!(batch.scheduled_delay, Duration::from_millis(10));
assert_eq!(batch.max_export_timeout, Duration::from_millis(10));
assert_eq!(batch.max_concurrent_exports, 10);
assert_eq!(batch.max_queue_size, 10);
}
// Helper function to create a default test span
fn create_test_span(name: &str) -> SpanData {
SpanData {
span_context: SpanContext::empty_context(),
parent_span_id: SpanId::INVALID,
span_kind: SpanKind::Internal,
name: name.to_string().into(),
start_time: opentelemetry::time::now(),
end_time: opentelemetry::time::now(),
attributes: Vec::new(),
dropped_attributes_count: 0,
events: SpanEvents::default(),
links: SpanLinks::default(),
status: Status::Unset,
instrumentation_scope: Default::default(),
}
}
use crate::Resource;
use futures_util::future::BoxFuture;
use futures_util::FutureExt;
use opentelemetry::{Key, KeyValue, Value};
use std::sync::{atomic::Ordering, Arc, Mutex};
// Mock exporter to test functionality
#[derive(Debug)]
struct MockSpanExporter {
exported_spans: Arc<Mutex<Vec<SpanData>>>,
exported_resource: Arc<Mutex<Option<Resource>>>,
}
impl MockSpanExporter {
fn new() -> Self {
Self {
exported_spans: Arc::new(Mutex::new(Vec::new())),
exported_resource: Arc::new(Mutex::new(None)),
}
}
}
impl SpanExporter for MockSpanExporter {
fn export(&mut self, batch: Vec<SpanData>) -> BoxFuture<'static, OTelSdkResult> {
let exported_spans = self.exported_spans.clone();
async move {
exported_spans.lock().unwrap().extend(batch);
Ok(())
}
.boxed()
}
fn shutdown(&mut self) -> OTelSdkResult {
Ok(())
}
fn set_resource(&mut self, resource: &Resource) {
let mut exported_resource = self.exported_resource.lock().unwrap();
*exported_resource = Some(resource.clone());
}
}
#[test]
fn batchspanprocessor_handles_on_end() {
let exporter = MockSpanExporter::new();
let exporter_shared = exporter.exported_spans.clone();
let config = BatchConfigBuilder::default()
.with_max_queue_size(10)
.with_max_export_batch_size(10)
.with_scheduled_delay(Duration::from_secs(5))
.build();
let processor = BatchSpanProcessor::new(exporter, config);
let test_span = create_test_span("test_span");
processor.on_end(test_span.clone());
// Wait for flush interval to ensure the span is processed
std::thread::sleep(Duration::from_secs(6));
let exported_spans = exporter_shared.lock().unwrap();
assert_eq!(exported_spans.len(), 1);
assert_eq!(exported_spans[0].name, "test_span");
}
#[test]
fn batchspanprocessor_force_flush() {
let exporter = MockSpanExporter::new();
let exporter_shared = exporter.exported_spans.clone(); // Shared access to verify exported spans
let config = BatchConfigBuilder::default()
.with_max_queue_size(10)
.with_max_export_batch_size(10)
.with_scheduled_delay(Duration::from_secs(5))
.build();
let processor = BatchSpanProcessor::new(exporter, config);
// Create a test span and send it to the processor
let test_span = create_test_span("force_flush_span");
processor.on_end(test_span.clone());
// Call force_flush to immediately export the spans
let flush_result = processor.force_flush();
assert!(flush_result.is_ok(), "Force flush failed unexpectedly");
// Verify the exported spans in the mock exporter
let exported_spans = exporter_shared.lock().unwrap();
assert_eq!(
exported_spans.len(),
1,
"Unexpected number of exported spans"
);
assert_eq!(exported_spans[0].name, "force_flush_span");
}
#[test]
fn batchspanprocessor_shutdown() {
let exporter = MockSpanExporter::new();
let exporter_shared = exporter.exported_spans.clone(); // Shared access to verify exported spans
let config = BatchConfigBuilder::default()
.with_max_queue_size(10)
.with_max_export_batch_size(10)
.with_scheduled_delay(Duration::from_secs(5))
.build();
let processor = BatchSpanProcessor::new(exporter, config);
// Create a test span and send it to the processor
let test_span = create_test_span("shutdown_span");
processor.on_end(test_span.clone());
// Call shutdown to flush and export all pending spans
let shutdown_result = processor.shutdown();
assert!(shutdown_result.is_ok(), "Shutdown failed unexpectedly");
// Verify the exported spans in the mock exporter
let exported_spans = exporter_shared.lock().unwrap();
assert_eq!(
exported_spans.len(),
1,
"Unexpected number of exported spans"
);
assert_eq!(exported_spans[0].name, "shutdown_span");
// Ensure further calls to shutdown are idempotent
let second_shutdown_result = processor.shutdown();
assert!(
second_shutdown_result.is_err(),
"Shutdown should fail when called a second time"
);
}
#[test]
fn batchspanprocessor_handles_dropped_spans() {
let exporter = MockSpanExporter::new();
let exporter_shared = exporter.exported_spans.clone(); // Shared access to verify exported spans
let config = BatchConfigBuilder::default()
.with_max_queue_size(2) // Small queue size to test span dropping
.with_scheduled_delay(Duration::from_secs(5))
.build();
let processor = BatchSpanProcessor::new(exporter, config);
// Create test spans and send them to the processor
let span1 = create_test_span("span1");
let span2 = create_test_span("span2");
let span3 = create_test_span("span3"); // This span should be dropped
processor.on_end(span1.clone());
processor.on_end(span2.clone());
processor.on_end(span3.clone()); // This span exceeds the queue size
// Wait for the scheduled delay to expire
std::thread::sleep(Duration::from_secs(3));
let exported_spans = exporter_shared.lock().unwrap();
// Verify that only the first two spans are exported
assert_eq!(
exported_spans.len(),
2,
"Unexpected number of exported spans"
);
assert!(exported_spans.iter().any(|s| s.name == "span1"));
assert!(exported_spans.iter().any(|s| s.name == "span2"));
// Ensure the third span is dropped
assert!(
!exported_spans.iter().any(|s| s.name == "span3"),
"Span3 should have been dropped"
);
// Verify dropped spans count (if accessible in your implementation)
let dropped_count = processor.dropped_span_count.load(Ordering::Relaxed);
assert_eq!(dropped_count, 1, "Unexpected number of dropped spans");
}
#[test]
fn validate_span_attributes_exported_correctly() {
let exporter = MockSpanExporter::new();
let exporter_shared = exporter.exported_spans.clone();
let config = BatchConfigBuilder::default().build();
let processor = BatchSpanProcessor::new(exporter, config);
// Create a span with attributes
let mut span_data = create_test_span("attribute_validation");
span_data.attributes = vec![
KeyValue::new("key1", "value1"),
KeyValue::new("key2", "value2"),
];
processor.on_end(span_data.clone());
// Force flush to export the span
let _ = processor.force_flush();
// Validate the exported attributes
let exported_spans = exporter_shared.lock().unwrap();
assert_eq!(exported_spans.len(), 1);
let exported_span = &exported_spans[0];
assert!(exported_span
.attributes
.contains(&KeyValue::new("key1", "value1")));
assert!(exported_span
.attributes
.contains(&KeyValue::new("key2", "value2")));
}
#[test]
fn batchspanprocessor_sets_and_exports_with_resource() {
let exporter = MockSpanExporter::new();
let exporter_shared = exporter.exported_spans.clone();
let resource_shared = exporter.exported_resource.clone();
let config = BatchConfigBuilder::default().build();
let mut processor = BatchSpanProcessor::new(exporter, config);
// Set a resource for the processor
let resource = Resource::new(vec![KeyValue::new("service.name", "test_service")]);
processor.set_resource(&resource);
// Create a span and send it to the processor
let test_span = create_test_span("resource_test");
processor.on_end(test_span.clone());
// Force flush to ensure the span is exported
let _ = processor.force_flush();
// Validate spans are exported
let exported_spans = exporter_shared.lock().unwrap();
assert_eq!(exported_spans.len(), 1);
// Validate the resource is correctly set in the exporter
let exported_resource = resource_shared.lock().unwrap();
assert!(exported_resource.is_some());
assert_eq!(
exported_resource
.as_ref()
.unwrap()
.get(&Key::new("service.name")),
Some(Value::from("test_service"))
);
}
#[tokio::test(flavor = "current_thread")]
async fn test_batch_processor_current_thread_runtime() {
let exporter = MockSpanExporter::new();
let exporter_shared = exporter.exported_spans.clone();
let config = BatchConfigBuilder::default()
.with_max_queue_size(5)
.with_max_export_batch_size(3)
.with_scheduled_delay(Duration::from_millis(50))
.build();
let processor = BatchSpanProcessor::new(exporter, config);
for _ in 0..4 {
let span = new_test_export_span_data();
processor.on_end(span);
}
tokio::time::sleep(Duration::from_millis(200)).await;
let exported_spans = exporter_shared.lock().unwrap();
assert_eq!(exported_spans.len(), 4);
}
#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
async fn test_batch_processor_multi_thread_count_1_runtime() {
let exporter = MockSpanExporter::new();
let exporter_shared = exporter.exported_spans.clone();
let config = BatchConfigBuilder::default()
.with_max_queue_size(5)
.with_max_export_batch_size(3)
.with_scheduled_delay(Duration::from_millis(50))
.build();
let processor = BatchSpanProcessor::new(exporter, config);
for _ in 0..4 {
let span = new_test_export_span_data();
processor.on_end(span);
}
tokio::time::sleep(Duration::from_millis(200)).await;
let exported_spans = exporter_shared.lock().unwrap();
assert_eq!(exported_spans.len(), 4);
}
#[tokio::test(flavor = "multi_thread", worker_threads = 4)]
async fn test_batch_processor_multi_thread() {
let exporter = MockSpanExporter::new();
let exporter_shared = exporter.exported_spans.clone();
let config = BatchConfigBuilder::default()
.with_max_queue_size(20)
.with_max_export_batch_size(5)
.with_scheduled_delay(Duration::from_millis(50))
.build();
// Create the processor with the thread-safe exporter
let processor = Arc::new(BatchSpanProcessor::new(exporter, config));
let mut handles = vec![];
for _ in 0..10 {
let processor_clone = Arc::clone(&processor);
let handle = tokio::spawn(async move {
let span = new_test_export_span_data();
processor_clone.on_end(span);
});
handles.push(handle);
}
for handle in handles {
handle.await.unwrap();
}
// Allow time for batching and export
tokio::time::sleep(Duration::from_millis(200)).await;
// Verify exported spans
let exported_spans = exporter_shared.lock().unwrap();
assert_eq!(exported_spans.len(), 10);
}
}