Add AWS X-Ray Propagator support in OpenTelemetry tracing module, enhance TracingOpenTelemetry for additional span operations, and update dependencies.

Author: David-DAM

pom.xml

@@ -14,8 +14,8 @@
   -->
 
 <project xmlns="http://maven.apache.org/POM/4.0.0"
-    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
 
     <groupId>software.amazon.lambda</groupId>
@@ -25,7 +25,8 @@
 
     <name>Powertools for AWS Lambda (Java) - Parent</name>
     <description>
-        A suite of utilities for AWS Lambda Functions that makes tracing with AWS X-Ray, structured logging and creating custom metrics asynchronously easier.
+        A suite of utilities for AWS Lambda Functions that makes tracing with AWS X-Ray, structured logging and creating
+        custom metrics asynchronously easier.
     </description>
     <scm>
         <url>https://github.com/aws-powertools/powertools-lambda-java</url>
@@ -121,6 +122,7 @@
         <crac.version>1.5.0</crac.version>
         <native-maven-plugin.version>0.11.5</native-maven-plugin.version>
         <opentelemetry-api.version>1.65.0</opentelemetry-api.version>
+        <opentelemetry.aws.xray.propagator.version>1.59.0-alpha</opentelemetry.aws.xray.propagator.version>
 
         <!-- As we have a .mvn directory at the root of the project, this will evaluate to the root directory
             regardless of where maven is run - sub-module, or root. -->
@@ -473,7 +475,8 @@
                             <enabled>true</enabled>
                             <options>
                                 <enableExperimentalPredefinedClasses>true</enableExperimentalPredefinedClasses>
-                                <enableExperimentalUnsafeAllocationTracing>true</enableExperimentalUnsafeAllocationTracing>
+                                <enableExperimentalUnsafeAllocationTracing>true
+                                </enableExperimentalUnsafeAllocationTracing>
                             </options>
                             <metadataCopy>
                                 <disabledStages>
@@ -694,7 +697,9 @@
                         <artifactId>maven-surefire-plugin</artifactId>
                         <configuration>
                             <environmentVariables>
-                                <JDK_JAVA_OPTIONS>--add-opens java.base/java.util=ALL-UNNAMED --add-opens java.base/java.lang=ALL-UNNAMED</JDK_JAVA_OPTIONS>
+                                <JDK_JAVA_OPTIONS>--add-opens java.base/java.util=ALL-UNNAMED --add-opens
+                                    java.base/java.lang=ALL-UNNAMED
+                                </JDK_JAVA_OPTIONS>
                             </environmentVariables>
                         </configuration>
                     </plugin>

powertools-tracing-opentelemetry/pom.xml

@@ -48,6 +48,11 @@
             <artifactId>opentelemetry-exporter-otlp</artifactId>
             <version>${opentelemetry-api.version}</version>
         </dependency>
+        <dependency>
+            <groupId>io.opentelemetry.contrib</groupId>
+            <artifactId>opentelemetry-aws-xray-propagator</artifactId>
+            <version>${opentelemetry.aws.xray.propagator.version}</version>
+        </dependency>
         <dependency>
             <groupId>org.aspectj</groupId>
             <artifactId>aspectjrt</artifactId>

powertools-tracing-opentelemetry/src/main/java/software/amazon/lambda/powertools/tracing/opentelemetry/TracingOpenTelemetry.java

@@ -29,9 +29,7 @@
 import java.util.Collections;
 import java.util.List;
 import java.util.Objects;
-import software.amazon.lambda.powertools.common.internal.LambdaHandlerProcessor;
 import software.amazon.lambda.powertools.tracing.opentelemetry.context.LambdaEventContextExtractorResolver;
-import software.amazon.lambda.powertools.tracing.opentelemetry.internal.AttributesConstants;
 import software.amazon.lambda.powertools.tracing.opentelemetry.internal.SpanOperation;
 import software.amazon.lambda.powertools.tracing.opentelemetry.internal.SpanScope;
 import software.amazon.lambda.powertools.tracing.opentelemetry.provider.OpenTelemetryProvider;
@@ -76,6 +74,10 @@ public TracingOpenTelemetry(
         );
     }
 
+    public Tracer tracer() {
+        return tracer;
+    }
+
     public TextMapPropagator propagator() {
         return propagator;
     }
@@ -99,33 +101,33 @@ public SpanScope addSpan(String name, SpanKind kind) {
         return addSpan(name, kind, Attributes.empty());
     }
 
-
     public SpanScope addSpan(String name, SpanKind kind, Attributes attributes) {
 
-        Objects.requireNonNull(name, "name must not be null");
-        Objects.requireNonNull(kind, "kind must not be null");
-        Objects.requireNonNull(attributes, "attributes must not be null");
         return addSpan(name, kind, attributes, Context.current());
     }
 
-
     public SpanScope addSpan(String name, SpanKind kind, Attributes attributes, Context parentContext) {
 
-        Objects.requireNonNull(parentContext, "parentContext must not be null");
         return addSpan(name, kind, attributes, parentContext, Collections.emptyList());
     }
 
     public SpanScope addSpan(
-            String spanName,
-            SpanKind spanKind,
+            String name,
+            SpanKind kind,
             Attributes attributes,
             Context parentContext,
             List<SpanContext> spanContexts
     ) {
 
+        Objects.requireNonNull(name, "name must not be null");
+        Objects.requireNonNull(kind, "kind must not be null");
+        Objects.requireNonNull(attributes, "attributes must not be null");
+        Objects.requireNonNull(parentContext, "parentContext must not be null");
+        Objects.requireNonNull(spanContexts, "spanContexts must not be null");
+
         SpanBuilder spanBuilder = tracer
-                .spanBuilder(spanName)
-                .setSpanKind(spanKind)
+                .spanBuilder(name)
+                .setSpanKind(kind)
                 .setParent(parentContext)
                 .setAllAttributes(attributes);
 
@@ -137,43 +139,20 @@ public SpanScope addSpan(
 
     public <T> T withSpan(String name, SpanOperation<T> operation) throws Exception {
 
-        Objects.requireNonNull(operation, "operation must not be null");
-
-        try (SpanScope scope = addSpan(name)) {
-            try {
-                return operation.execute(scope.span());
-            } catch (Exception exception) {
-                scope.recordException(exception);
-                throw exception;
-            }
-        }
+        return withSpan(name, SpanKind.INTERNAL, Attributes.empty(), operation);
     }
 
-    public <T> T captureLambdaHandler(
+    public <T> T withSpan(
             String name,
-            com.amazonaws.services.lambda.runtime.Context lambdaContext,
-            io.opentelemetry.context.Context parentContext,
+            SpanKind kind,
+            Attributes attributes,
             SpanOperation<T> operation
     ) throws Exception {
-
-        Objects.requireNonNull(name, "name must not be null");
-        Objects.requireNonNull(parentContext, "parentContext must not be null");
         Objects.requireNonNull(operation, "operation must not be null");
 
-        Span span = tracer.spanBuilder(name)
-                .setParent(parentContext)
-                .setSpanKind(SpanKind.SERVER)
-                .setAttribute(AttributesConstants.AWS_LAMBDA_FUNCTION_ARN, LambdaHandlerProcessor.isColdStart())
-                .setAttribute(AttributesConstants.FAAS_INVOCATION_ID, lambdaContext.getAwsRequestId())
-                .startSpan();
-
-        try (SpanScope scope = new SpanScope(span)) {
+        try (SpanScope scope = addSpan(name, kind, attributes)) {
             try {
-                T result = operation.execute(span);
-
-                LambdaHandlerProcessor.coldStartDone();
-
-                return result;
+                return operation.execute(scope.span());
             } catch (Exception exception) {
                 scope.recordException(exception);
                 throw exception;
@@ -186,25 +165,24 @@ public <T> Context extractContext(T carrier, TextMapGetter<T> getter) {
         return extractContext(Context.current(), carrier, getter);
     }
 
-
     public <T> Context extractContext(Context context, T carrier, TextMapGetter<T> getter) {
 
         Objects.requireNonNull(context, "context must not be null");
+        Objects.requireNonNull(carrier, "carrier must not be null");
         Objects.requireNonNull(getter, "getter must not be null");
 
         return propagator.extract(context, carrier, getter);
     }
 
-
     public <T> void injectContext(T carrier, TextMapSetter<T> setter) {
 
         injectContext(Context.current(), carrier, setter);
     }
 
-
     public <T> void injectContext(Context context, T carrier, TextMapSetter<T> setter) {
 
         Objects.requireNonNull(context, "context must not be null");
+        Objects.requireNonNull(carrier, "carrier must not be null");
         Objects.requireNonNull(setter, "setter must not be null");
 
         propagator.inject(context, carrier, setter);
@@ -218,12 +196,10 @@ private static LambdaEventContextExtractorResolver createDefaultEventContextExtr
         return LambdaEventContextExtractorResolver.create();
     }
 
-
     public static TracingOpenTelemetry create() {
         return new TracingOpenTelemetry();
     }
 
-
     public static Builder builder() {
         return new Builder();
     }

powertools-tracing-opentelemetry/src/main/java/software/amazon/lambda/powertools/tracing/opentelemetry/provider/OpenTelemetryProvider.java

@@ -11,6 +11,7 @@
 import io.opentelemetry.api.trace.propagation.W3CTraceContextPropagator;
 import io.opentelemetry.context.propagation.TextMapGetter;
 import io.opentelemetry.context.propagation.TextMapPropagator;
+import io.opentelemetry.contrib.awsxray.propagator.AwsXrayPropagator;
 import io.opentelemetry.exporter.otlp.trace.OtlpGrpcSpanExporter;
 import io.opentelemetry.sdk.trace.SdkTracerProvider;
 import io.opentelemetry.sdk.trace.export.BatchSpanProcessor;
@@ -33,6 +34,7 @@ public final class OpenTelemetryProvider {
     private static final SdkTracerProvider TRACER_PROVIDER = createTracerProvider();
     private static final TraceContextPropagationMode TRACE_CONTEXT_PROPAGATION_MODE = retrieveTraceContextMode();
     private static final TextMapGetter<Map<String, String>> TEXT_MAP_GETTER = createTextMapGetter();
+    private static final TextMapPropagator PROPAGATOR = createPropagator();
     private static final ObjectMapper OBJECT_MAPPER = new ObjectMapper();
 
     private OpenTelemetryProvider() {
@@ -55,7 +57,7 @@ public static SdkTracerProvider tracerProvider() {
     }
 
     public static TextMapPropagator propagator() {
-        return createPropagator();
+        return PROPAGATOR;
     }
 
     public static TextMapGetter<Map<String, String>> textMapGetter() {
@@ -127,9 +129,11 @@ private static SdkTracerProvider createTracerProvider() {
                 .addSpanProcessor(processor)
                 .build();
     }
-
-    //TODO Pending adding AWS X-RAY propagation, the library opentelemetry-aws-xray-propagator is still in alpha
+    
     private static TextMapPropagator createPropagator() {
-        return W3CTraceContextPropagator.getInstance();
+        return TextMapPropagator.composite(
+                W3CTraceContextPropagator.getInstance(),
+                AwsXrayPropagator.getInstance()
+        );
     }
 }

powertools-tracing-opentelemetry/src/test/java/software/amazon/lambda/powertools/tracing/opentelemetry/TracingOpenTelemetryTest.java

@@ -19,18 +19,15 @@
 
 import io.opentelemetry.api.trace.Span;
 import io.opentelemetry.api.trace.SpanContext;
-import io.opentelemetry.api.trace.SpanKind;
 import io.opentelemetry.api.trace.Tracer;
 import io.opentelemetry.api.trace.propagation.W3CTraceContextPropagator;
 import io.opentelemetry.context.Context;
 import io.opentelemetry.context.propagation.TextMapGetter;
 import io.opentelemetry.context.propagation.TextMapPropagator;
 import io.opentelemetry.sdk.testing.exporter.InMemorySpanExporter;
 import io.opentelemetry.sdk.trace.SdkTracerProvider;
-import io.opentelemetry.sdk.trace.data.SpanData;
 import io.opentelemetry.sdk.trace.export.SimpleSpanProcessor;
 import java.util.HashMap;
-import java.util.List;
 import java.util.Map;
 import org.junit.jupiter.api.Test;
 import software.amazon.lambda.powertools.tracing.opentelemetry.internal.SpanScope;
@@ -249,78 +246,5 @@ void shouldReturnInvalidContextWhenTraceparentIsMissing() {
                 .isFalse();
     }
 
-    @Test
-    void shouldCreateServerSpanWithParentContext() throws Exception {
-
-        String traceId = "4bf92f3577b34da6a3ce929d0e0e4736";
-        String parentSpanId = "00f067aa0ba902b7";
-
-        Map<String, String> headers = new HashMap<>();
-        headers.put(
-                "traceparent",
-                "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01"
-        );
-
-        TextMapPropagator propagator =
-                W3CTraceContextPropagator.getInstance();
-
-        InMemorySpanExporter exporter =
-                InMemorySpanExporter.create();
-
-        SdkTracerProvider tracerProvider =
-                SdkTracerProvider.builder()
-                        .addSpanProcessor(
-                                SimpleSpanProcessor.create(exporter)
-                        )
-                        .build();
-
-        Tracer tracer = tracerProvider.get("test-tracer");
-
-        TracingOpenTelemetry tracing =
-                TracingOpenTelemetry.builder()
-                        .tracer(tracer)
-                        .propagator(propagator)
-                        .build();
-
-        Context parentContext = tracing.extractContext(
-                headers,
-                MAP_GETTER
-        );
-
-
-        tracing.captureLambdaHandler(
-                "lambda-handler",
-                null,
-                parentContext,
-                span -> "result"
-        );
-
-
-        List<SpanData> spans = exporter.getFinishedSpanItems();
-
-        assertThat(spans)
-                .hasSize(1);
-
-        SpanData span = spans.get(0);
-
-        assertThat(span.getName())
-                .isEqualTo("lambda-handler");
-
-        assertThat(span.getKind())
-                .isEqualTo(SpanKind.SERVER);
-
-        assertThat(span.getSpanContext().isValid())
-                .isTrue();
-
-        assertThat(span.getSpanContext().getTraceId())
-                .isEqualTo(traceId);
-
-        assertThat(span.getParentSpanId())
-                .isEqualTo(parentSpanId);
-
-        assertThat(span.getSpanId())
-                .isNotEqualTo(parentSpanId);
-    }
-
 
 }