Allow full disabling of the span-stacktrace feature (#317)

* Allow full disabling of the span-stacktrace feature * Fix testing span capture procedure
elastic · Jul 8, 2024 · afe5aea · afe5aea
1 parent b4643c6
commit afe5aea
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 3 deletions.
diff --git a/custom/src/main/java/co/elastic/otel/SpanStackTraceProcessorAutoConfig.java b/custom/src/main/java/co/elastic/otel/SpanStackTraceProcessorAutoConfig.java
@@ -36,6 +36,9 @@ public void registerSpanProcessors(
       ConfigProperties properties, ChainingSpanProcessorRegisterer registerer) {
 
     Duration minDuration = properties.getDuration(MIN_DURATION_CONFIG_OPTION, Duration.ofMillis(5));
+    if (minDuration.isNegative()) {
+      return;
+    }
     registerer.register(
         next ->
             new StackTraceSpanProcessor(

diff --git a/custom/src/test/java/co/elastic/otel/SpanStackTraceProcessorAutoConfigTest.java b/custom/src/test/java/co/elastic/otel/SpanStackTraceProcessorAutoConfigTest.java
@@ -27,6 +27,7 @@
 import io.opentelemetry.api.GlobalOpenTelemetry;
 import io.opentelemetry.api.OpenTelemetry;
 import io.opentelemetry.api.trace.Tracer;
+import io.opentelemetry.contrib.stacktrace.StackTraceSpanProcessor;
 import io.opentelemetry.sdk.trace.data.SpanData;
 import io.opentelemetry.semconv.incubating.CodeIncubatingAttributes;
 import java.util.List;
@@ -65,6 +66,18 @@ void checkStackTracePresent() {
     }
   }
 
+  @Test
+  void featureCanBeDisabled() {
+    try (AutoConfigTestProperties testProps =
+        new AutoConfigTestProperties()
+            .put(SpanStackTraceProcessorAutoConfig.MIN_DURATION_CONFIG_OPTION, "-1")) {
+      OpenTelemetry otel = GlobalOpenTelemetry.get();
+
+      assertThat(OtelReflectionUtils.getSpanProcessors(otel))
+          .noneSatisfy(proc -> assertThat(proc).isInstanceOf(StackTraceSpanProcessor.class));
+    }
+  }
+
   @Test
   void checkMinDurationRespected() {
     try (AutoConfigTestProperties testProps =
@@ -80,7 +93,9 @@ void checkMinDurationRespected() {
       tracer.spanBuilder("my-span").startSpan().end();
 
       List<SpanData> spans = AutoConfiguredDataCapture.getSpans();
-      assertThat(spans).hasSize(0);
+      assertThat(spans).hasSize(1);
+      assertThat(spans.get(0).getAttributes().get(CodeIncubatingAttributes.CODE_STACKTRACE))
+          .isNull();
     }
   }
 }
diff --git a/testing-common/src/main/java/co/elastic/otel/testing/AutoConfiguredDataCapture.java b/testing-common/src/main/java/co/elastic/otel/testing/AutoConfiguredDataCapture.java
@@ -30,7 +30,7 @@
 @AutoService(AutoConfigurationCustomizerProvider.class)
 public class AutoConfiguredDataCapture implements AutoConfigurationCustomizerProvider {
 
-  private static final InMemorySpanExporter inMemorySpanExporter = InMemorySpanExporter.create();
+  private static volatile InMemorySpanExporter inMemorySpanExporter = InMemorySpanExporter.create();
 
   /*
    Returns the spans which have been exported by the autoconfigured global OpenTelemetry SDK.
@@ -46,7 +46,7 @@ public void customize(AutoConfigurationCustomizer autoConfiguration) {
           // we piggy-back onto the autoconfigured logging exporter for now,
           // because that one uses a SimpleSpanProcessor which does not impose a batching delay
           if (spanExporter instanceof LoggingSpanExporter) {
-            inMemorySpanExporter.reset();
+            inMemorySpanExporter = InMemorySpanExporter.create();
             return SpanExporter.composite(inMemorySpanExporter, spanExporter);
           }
           return spanExporter;