Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

replace usages of TestSpanExporter with InMemorySpanExporter #1626

Merged
merged 5 commits into from
Mar 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 1 addition & 46 deletions opentelemetry-sdk/src/testing/trace/span_exporters.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,12 @@ use crate::{
trace::{Config, SpanEvents, SpanLinks},
InstrumentationLibrary,
};
use async_trait::async_trait;
use futures_util::future::BoxFuture;
pub use opentelemetry::testing::trace::TestSpan;
use opentelemetry::trace::{
SpanContext, SpanId, SpanKind, Status, TraceFlags, TraceId, TraceState,
};
use std::{
fmt::{Display, Formatter},
sync::{Arc, Mutex},
};
use std::fmt::{Display, Formatter};

pub fn new_test_export_span_data() -> SpanData {
let config = Config::default();
Expand All @@ -42,47 +38,6 @@ pub fn new_test_export_span_data() -> SpanData {
}
}

#[derive(Clone, Debug)]
pub struct TestSpanExporter {
pub export_called: Arc<Mutex<bool>>,
pub shutdown_called: Arc<Mutex<bool>>,
}

impl Default for TestSpanExporter {
fn default() -> Self {
Self::new()
}
}

impl TestSpanExporter {
pub fn new() -> Self {
TestSpanExporter {
export_called: Arc::new(Mutex::new(false)),
shutdown_called: Arc::new(Mutex::new(false)),
}
}

pub fn is_export_called(&self) -> bool {
*self.export_called.lock().unwrap()
}

pub fn is_shutdown_called(&self) -> bool {
*self.shutdown_called.lock().unwrap()
}
}

#[async_trait]
impl SpanExporter for TestSpanExporter {
fn export(&mut self, _batch: Vec<SpanData>) -> BoxFuture<'static, ExportResult> {
*self.export_called.lock().unwrap() = true;
Box::pin(std::future::ready(Ok(())))
}

fn shutdown(&mut self) {
*self.shutdown_called.lock().unwrap() = true;
}
}

#[derive(Debug)]
pub struct TokioSpanExporter {
tx_export: tokio::sync::mpsc::UnboundedSender<SpanData>,
Expand Down
32 changes: 21 additions & 11 deletions opentelemetry-sdk/src/trace/span_processor.rs
Original file line number Diff line number Diff line change
Expand Up @@ -671,7 +671,7 @@ mod tests {
use crate::export::trace::{ExportResult, SpanData, SpanExporter};
use crate::runtime;
use crate::testing::trace::{
new_test_export_span_data, new_tokio_test_exporter, TestSpanExporter,
new_test_export_span_data, new_tokio_test_exporter, InMemorySpanExporterBuilder,
};
use crate::trace::span_processor::{
OTEL_BSP_EXPORT_TIMEOUT_DEFAULT, OTEL_BSP_MAX_EXPORT_BATCH_SIZE_DEFAULT,
Expand All @@ -685,16 +685,17 @@ mod tests {

#[test]
fn simple_span_processor_on_end_calls_export() {
let exporter = TestSpanExporter::new();
let exporter = InMemorySpanExporterBuilder::new().build();
let mut processor = SimpleSpanProcessor::new(Box::new(exporter.clone()));
processor.on_end(new_test_export_span_data());
assert!(exporter.is_export_called());
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 = TestSpanExporter::new();
let exporter = InMemorySpanExporterBuilder::new().build();
let processor = SimpleSpanProcessor::new(Box::new(exporter.clone()));
let unsampled = SpanData {
span_context: SpanContext::empty_context(),
Expand All @@ -712,16 +713,19 @@ mod tests {
instrumentation_lib: Default::default(),
};
processor.on_end(unsampled);
assert!(!exporter.is_export_called());
assert!(exporter.get_finished_spans().unwrap().is_empty());
}

#[test]
fn simple_span_processor_shutdown_calls_shutdown() {
let exporter = TestSpanExporter::new();
let exporter = InMemorySpanExporterBuilder::new().build();
let mut processor = SimpleSpanProcessor::new(Box::new(exporter.clone()));
assert!(!exporter.is_shutdown_called());
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();
assert!(exporter.is_shutdown_called());
// Assume shutdown is called by ensuring spans are empty in the exporter
assert!(exporter.get_finished_spans().unwrap().is_empty());
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Add a comment saying, we indirectly test shutdown is called, by asserting that spans are empty in inmemoryexporter.

}

#[test]
Expand Down Expand Up @@ -820,7 +824,10 @@ mod tests {
(OTEL_BSP_EXPORT_TIMEOUT, Some("2046")),
];
temp_env::with_vars(env_vars.clone(), || {
let builder = BatchSpanProcessor::builder(TestSpanExporter::new(), runtime::Tokio);
let builder = BatchSpanProcessor::builder(
InMemorySpanExporterBuilder::new().build(),
runtime::Tokio,
);
// export batch size cannot exceed max queue size
assert_eq!(builder.config.max_export_batch_size, 500);
assert_eq!(
Expand All @@ -840,7 +847,10 @@ mod tests {
env_vars.push((OTEL_BSP_MAX_QUEUE_SIZE, Some("120")));

temp_env::with_vars(env_vars, || {
let builder = BatchSpanProcessor::builder(TestSpanExporter::new(), runtime::Tokio);
let builder = BatchSpanProcessor::builder(
InMemorySpanExporterBuilder::new().build(),
runtime::Tokio,
);
assert_eq!(builder.config.max_export_batch_size, 120);
assert_eq!(builder.config.max_queue_size, 120);
});
Expand Down
Loading