Snapshot profiling span processor automatically added when callgraphs enabled (#2602)

Author: robsunday

profiler/src/main/java/com/splunk/opentelemetry/profiler/snapshot/SnapshotProfilingConfigurationCustomizerProvider.java

@@ -28,6 +28,7 @@
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.PropagatorModel;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.SpanProcessorModel;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.TracerProviderModel;
+import java.util.List;
 
 @AutoService(DeclarativeConfigurationCustomizerProvider.class)
 public class SnapshotProfilingConfigurationCustomizerProvider
@@ -52,7 +53,7 @@ OpenTelemetryConfigurationModel customizeModel(OpenTelemetryConfigurationModel m
       initActiveSpansTracking();
       initStackTraceSampler(snapshotProfiling);
       addSnapshotVolumePropagator(model);
-      addShutdownHookSpanProcessor(model);
+      addSpanProcessors(model);
     }
 
     return model;
@@ -74,6 +75,7 @@ private void addSnapshotVolumePropagator(OpenTelemetryConfigurationModel model)
     } else {
       propagators = String.join(",", propagators, volumePropagatorName);
     }
+
     propagatorModel.withCompositeList(propagators);
   }
 
@@ -82,16 +84,20 @@ private void initStackTraceSampler(
     StackTraceSamplerInitializer.setupStackTraceSampler(snapshotProfilingConfig);
   }
 
-  private void addShutdownHookSpanProcessor(OpenTelemetryConfigurationModel model) {
-    if (model.getTracerProvider() == null) {
-      model.withTracerProvider(new TracerProviderModel());
+  private void addSpanProcessors(OpenTelemetryConfigurationModel model) {
+    TracerProviderModel tracerProviderModel = model.getTracerProvider();
+    if (tracerProviderModel == null) {
+      tracerProviderModel = new TracerProviderModel();
+      model.withTracerProvider(tracerProviderModel);
     }
-    model
-        .getTracerProvider()
-        .getProcessors()
-        .add(
-            new SpanProcessorModel()
-                .withAdditionalProperty(SdkShutdownHookComponentProvider.NAME, null));
+
+    List<SpanProcessorModel> processors = tracerProviderModel.getProcessors();
+    processors.add(
+        new SpanProcessorModel()
+            .withAdditionalProperty(SnapshotProfilingSpanProcessorComponentProvider.NAME, null));
+    processors.add(
+        new SpanProcessorModel()
+            .withAdditionalProperty(SdkShutdownHookComponentProvider.NAME, null));
   }
 
   private void initActiveSpansTracking() {

profiler/src/main/java/com/splunk/opentelemetry/profiler/snapshot/SnapshotProfilingSpanProcessorComponentProvider.java

@@ -23,6 +23,7 @@
 
 @AutoService(ComponentProvider.class)
 public class SnapshotProfilingSpanProcessorComponentProvider implements ComponentProvider {
+  static final String NAME = "splunk_snapshot_profiling";
   private final TraceRegistry traceRegistry;
 
   public SnapshotProfilingSpanProcessorComponentProvider() {
@@ -40,7 +41,7 @@ public Class<SpanProcessor> getType() {
 
   @Override
   public String getName() {
-    return "splunk_snapshot_profiling";
+    return NAME;
   }
 
   @Override

profiler/src/test/java/com/splunk/opentelemetry/profiler/snapshot/SnapshotProfilingConfigurationCustomizerProviderTest.java

@@ -22,11 +22,14 @@
 
 import com.splunk.opentelemetry.testing.declarativeconfig.DeclarativeConfigTestUtil;
 import io.opentelemetry.instrumentation.testing.internal.AutoCleanupExtension;
+import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.BatchSpanProcessorModel;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.OpenTelemetryConfigurationModel;
+import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.SimpleSpanProcessorModel;
+import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.SpanProcessorModel;
 import java.io.IOException;
 import java.nio.file.Path;
+import java.util.List;
 import java.util.Set;
-import org.assertj.core.util.Sets;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.RegisterExtension;
@@ -57,10 +60,11 @@ void shouldDoNothingIfProfilerIsNotEnabled(@TempDir Path tempDir) throws IOExcep
     // then
     assertThat(model).isNotNull();
     assertThat(model.getPropagator()).isNull();
+    assertThat(model.getTracerProvider()).isNull();
   }
 
   @Test
-  void shouldAddRequiredComponents() {
+  void shouldAddRequiredPropagator() {
     // given
     String yaml =
         """
@@ -75,14 +79,6 @@ void shouldAddRequiredComponents() {
     OpenTelemetryConfigurationModel model = getCustomizedModel(yaml);
 
     // then
-    assertThat(model).isNotNull();
-    assertThat(model.getTracerProvider()).isNotNull();
-
-    assertThat(model.getTracerProvider().getProcessors()).hasSize(1);
-    assertThat(model.getTracerProvider().getProcessors())
-        .extracting(processor -> processor.getAdditionalProperties().keySet())
-        .containsOnlyOnce(Sets.set("sdk_shutdown_hook"));
-
     assertThat(model.getPropagator().getCompositeList()).isEqualTo("splunk_snapshot_volume");
   }
 
@@ -110,7 +106,42 @@ void shouldKeepPropagatorsDefinedInCompositeList() {
   }
 
   @Test
-  void shouldInitialize() {
+  void shouldAddSpanProcessors() {
+    // given
+    String yaml =
+        """
+          file_format: "1.0-rc.3"
+          tracer_provider:
+            processors:
+              - batch:
+              - simple:
+          distribution:
+            splunk:
+              profiling:
+                callgraphs:
+          """;
+
+    // when
+    OpenTelemetryConfigurationModel model = getCustomizedModel(yaml);
+
+    // then
+    List<SpanProcessorModel> expectedProcessors =
+        List.of(
+            new SpanProcessorModel().withBatch(new BatchSpanProcessorModel()),
+            new SpanProcessorModel().withSimple(new SimpleSpanProcessorModel()),
+            new SpanProcessorModel()
+                .withAdditionalProperty(SnapshotProfilingSpanProcessorComponentProvider.NAME, null),
+            new SpanProcessorModel()
+                .withAdditionalProperty(SdkShutdownHookComponentProvider.NAME, null));
+
+    assertThat(model).isNotNull();
+    assertThat(model.getTracerProvider()).isNotNull();
+    assertThat(model.getTracerProvider().getProcessors()).hasSize(4);
+    assertThat(model.getTracerProvider().getProcessors()).containsAll(expectedProcessors);
+  }
+
+  @Test
+  void shouldInitializeActiveSpansTracking() {
     // given
     OpenTelemetryConfigurationModel model =
         DeclarativeConfigTestUtil.parse(