Suppress Helidon handling of OpenTelemetry annotations if OTel Java agent is present (helidon-io#8360)

* Suppress Helidon handling of OpenTelemetry annotations if OTel Java agent is present

Signed-off-by: Tim Quinn <tim.quinn@oracle.com>

---------

Signed-off-by: Tim Quinn <tim.quinn@oracle.com>

Author: tjquinno

microprofile/telemetry/pom.xml

@@ -140,6 +140,8 @@
                 <configuration>
                     <forkCount>1</forkCount>
                     <reuseForks>false</reuseForks>
+                    <!-- The default for the following is 5000 ms. Reducing it significantly speeds up tests. -->
+                    <argLine>-Dotel.bsp.schedule.delay=100</argLine>
                 </configuration>
             </plugin>
         </plugins>

microprofile/telemetry/src/main/java/io/helidon/microprofile/telemetry/HelidonTelemetryContainerFilter.java

@@ -83,6 +83,7 @@ public Iterable<String> keys(ContainerRequestContext containerRequestContext) {
 
     private final Tracer tracer;
     private final OpenTelemetry openTelemetry;
+    private final boolean isAgentPresent;
 
 
     @jakarta.ws.rs.core.Context
@@ -92,13 +93,18 @@ public Iterable<String> keys(ContainerRequestContext containerRequestContext) {
     HelidonTelemetryContainerFilter(Tracer tracer, OpenTelemetry openTelemetry, org.eclipse.microprofile.config.Config mpConfig) {
         this.tracer = tracer;
         this.openTelemetry = openTelemetry;
+        isAgentPresent = Boolean.getBoolean(TelemetryCdiExtension.OTEL_AGENT_PRESENT);
 
         mpConfig.getOptionalValue(SPAN_NAME_FULL_URL, Boolean.class).ifPresent(e -> spanNameFullUrl = e);
     }
 
     @Override
     public void filter(ContainerRequestContext requestContext) {
 
+        if (isAgentPresent) {
+            return;
+        }
+
         if (LOGGER.isLoggable(System.Logger.Level.TRACE)) {
             LOGGER.log(System.Logger.Level.TRACE, "Starting Span in a Container Request");
         }
@@ -132,6 +138,10 @@ public void filter(ContainerRequestContext requestContext) {
     @Override
     public void filter(final ContainerRequestContext request, final ContainerResponseContext response) {
 
+        if (isAgentPresent) {
+            return;
+        }
+
         if (LOGGER.isLoggable(System.Logger.Level.TRACE)) {
             LOGGER.log(System.Logger.Level.TRACE, "Closing Span in a Container Request");
         }

microprofile/telemetry/src/main/java/io/helidon/microprofile/telemetry/TelemetryAutoDiscoverable.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023 Oracle and/or its affiliates.
+ * Copyright (c) 2023, 2024 Oracle and/or its affiliates.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

microprofile/telemetry/src/main/java/io/helidon/microprofile/telemetry/TelemetryCdiExtension.java

@@ -28,8 +28,15 @@
  */
 public class TelemetryCdiExtension implements Extension {
 
+    /**
+     * Property name indicating the presence of the OpenTelemetry Java agent.
+     */
+    static final String OTEL_AGENT_PRESENT = "otel.agent.present";
+
     private static final System.Logger LOGGER = System.getLogger(TelemetryCdiExtension.class.getName());
 
+    private boolean isAgentPresent;
+
     /**
      * Add {@code HelidonWithSpan} annotation with interceptor.
      *
@@ -38,6 +45,8 @@ public class TelemetryCdiExtension implements Extension {
     void before(@Observes BeforeBeanDiscovery discovery) {
         LOGGER.log(System.Logger.Level.TRACE, () -> "Before Telemetry bean discovery " + discovery);
 
+        isAgentPresent = Boolean.getBoolean(OTEL_AGENT_PRESENT);
+
         // Register annotations, interceptors and producers.
         discovery.addAnnotatedType(HelidonWithSpan.class, HelidonWithSpan.class.getName());
         discovery.addAnnotatedType(WithSpanInterceptor.class, WithSpanInterceptor.class.getName());
@@ -61,6 +70,5 @@ void processAnnotations(@Observes @WithAnnotations(WithSpan.class) ProcessAnnota
                 method.add(HelidonWithSpan.Literal.INSTANCE);
             }
         }
-
     }
 }

microprofile/telemetry/src/main/java/io/helidon/microprofile/telemetry/WithSpanInterceptor.java

@@ -43,10 +43,12 @@ class WithSpanInterceptor {
     private static final System.Logger LOGGER = System.getLogger(WithSpanInterceptor.class.getName());
 
     private final Tracer tracer;
+    private final boolean isAgentPresent;
 
     @Inject
     WithSpanInterceptor(Tracer tracer) {
         this.tracer = tracer;
+        isAgentPresent = Boolean.getBoolean(TelemetryCdiExtension.OTEL_AGENT_PRESENT);
     }
 
     /**
@@ -59,6 +61,10 @@ class WithSpanInterceptor {
     @AroundInvoke
     public Object interceptSpan(InvocationContext context) throws Exception {
 
+        if (isAgentPresent) {
+            return context.proceed();
+        }
+
         if (LOGGER.isLoggable(System.Logger.Level.TRACE)) {
             LOGGER.log(System.Logger.Level.TRACE, "Starting new Span on WithSpan annotated method");
         }

microprofile/telemetry/src/test/java/io/helidon/microprofile/telemetry/AgentDetectorTest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023 Oracle and/or its affiliates.
+ * Copyright (c) 2023, 2024 Oracle and/or its affiliates.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -36,19 +36,18 @@
 @AddExtension(ServerCdiExtension.class)
 class AgentDetectorTest {
 
-    public static final String OTEL_AGENT_PRESENT = "otel.agent.present";
     public static final String IO_OPENTELEMETRY_JAVAAGENT = "io.opentelemetry.javaagent";
 
     @Test
-    @AddConfig(key = OTEL_AGENT_PRESENT, value = "true")
+    @AddConfig(key = TelemetryCdiExtension.OTEL_AGENT_PRESENT, value = "true")
     void shouldBeNoOpTelemetry(){
         Config config = CDI.current().select(Config.class).get();
         boolean present = HelidonOpenTelemetry.AgentDetector.isAgentPresent(config);
         assertThat(present, is(true));
     }
 
     @Test
-    @AddConfig(key = OTEL_AGENT_PRESENT, value = "false")
+    @AddConfig(key = TelemetryCdiExtension.OTEL_AGENT_PRESENT, value = "false")
     void shouldNotBeNoOpTelemetry(){
         Config config = CDI.current().select(Config.class).get();
         boolean present = HelidonOpenTelemetry.AgentDetector.isAgentPresent(config);