OpenTelemetry InMemorySpanExporter测试类执行后未重置导致后续测试失败
问题根源
- OpenTelemetry 的 trace provider 是全局单例,你当前的测试方案没有在测试执行后完全清理全局状态,导致多个测试类运行时状态互相干扰。
- 用
setUpClass类级别初始化时,第一个测试类运行结束后没有关闭它创建的TracerProvider,全局状态残留会导致第二个测试类生成的span无法正确导出到自己的InMemorySpanExporter中。 - 之前将
setUpClass改为普通setUp后单类多测试失败,是因为没有在tearDown中完全重置全局trace provider,后续测试创建的新provider没有生效。
解决方案
调整基础测试类的实现,每个测试方法运行前重新初始化全链路追踪组件,测试结束后彻底清理全局状态,修改后的代码如下:
from opentelemetry import trace from opentelemetry.sdk.trace import TracerProvider from opentelemetry.sdk.trace.export import SimpleSpanProcessor from opentelemetry.sdk.trace.export.in_memory_span_exporter import InMemorySpanExporter from contextlib import contextmanager import unittest tracer = trace.get_tracer(__name__) @contextmanager def method(name): with tracer.start_as_current_span(name) as span: try: yield span except Exception as error: span.record_exception(error) raise class OpenTelemetryBase(unittest.TestCase): def setUp(self): # 每个测试前初始化全新的追踪组件 self.tracer_provider = TracerProvider() self.memory_exporter = InMemorySpanExporter() self.span_processor = SimpleSpanProcessor(self.memory_exporter) self.tracer_provider.add_span_processor(self.span_processor) # 替换全局trace provider trace.set_tracer_provider(self.tracer_provider) def tearDown(self): # 强制刷新所有未导出的span self.tracer_provider.force_flush() # 清空当前测试的导出数据 self.memory_exporter.clear() # 关闭当前追踪提供者,释放资源 self.tracer_provider.shutdown() # 重置全局trace provider状态,避免残留影响后续测试 if hasattr(trace, "_TRACER_PROVIDER"): trace._TRACER_PROVIDER = None class TestTracing(OpenTelemetryBase): def test_method_1(self): with self.assertRaises(Exception): with method("TestTracing1") as span: raise Exception("Failed trace 1") span_list = self.memory_exporter.get_finished_spans() self.assertEqual(len(span_list), 1) self.assertEqual(span_list[0].status.description, "Exception: Failed trace 1") self.assertEqual(span_list[0].name, "TestTracing1") class TestTracingB(OpenTelemetryBase): def test_method_2(self): with self.assertRaises(Exception): with method("TestTracingB1") as span: raise Exception("Failed traceB 1") span_list = self.memory_exporter.get_finished_spans() self.assertEqual(len(span_list), 1) self.assertEqual(span_list[0].status.description, "Exception: Failed traceB 1") self.assertEqual(span_list[0].name, "TestTracingB1")
验证方式
- 单独运行单测试类:
py.test tracing.py::TestTracing、py.test tracing.py::TestTracingB运行正常 - 全量运行测试:
py.test tracing.py两个测试类都会执行成功
如果你使用的是较新版本的OpenTelemetry Python SDK,也可以直接用官方测试工具提供的reset_trace()方法替换手动重置_TRACER_PROVIDER的逻辑,更加稳妥。
内容的提问来源于stack exchange,提问作者Vikash Singh
相关产品推荐
相关产品推荐

