Skip to content

Commit c6a4e0a

Browse files
committed
feat(otel): Add X-Ray e2e integration tests for span validation
1 parent f8c265f commit c6a4e0a

8 files changed

Lines changed: 518 additions & 2 deletions

File tree

.github/workflows/e2e-tests.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,5 +78,5 @@ jobs:
7878
'ParameterKey=Architecture,ParameterValue=x86_64 ParameterKey=JavaVersion,ParameterValue=java${{ matrix.java }} ParameterKey=RoleArn,ParameterValue=${{ secrets.DURABLE_INTEGRATION_TEST_ROLE_ARN }}'
7979
working-directory: ./examples
8080
- name: Cloud Based Integration Tests
81-
run: mvn clean test -B -Dtest.cloud.enabled=true -Dtest=CloudBasedIntegrationTest -Dtest.function.name.suffix='-java${{ matrix.java }}-runtime'
81+
run: mvn clean test -B -Dtest.cloud.enabled=true -Dtest="CloudBasedIntegrationTest,OtelXRayIntegrationTest" -Dtest.function.name.suffix='-java${{ matrix.java }}-runtime'
8282
working-directory: ./examples

examples/pom.xml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,25 @@
5050
<version>1.63.0</version>
5151
</dependency>
5252

53+
<!-- OTLP gRPC exporter (required for X-Ray via ADOT collector) -->
54+
<dependency>
55+
<groupId>io.opentelemetry</groupId>
56+
<artifactId>opentelemetry-exporter-otlp</artifactId>
57+
<version>1.63.0</version>
58+
</dependency>
59+
60+
<!-- AWS X-Ray UDP Exporter (sends spans directly to Lambda's X-Ray daemon) -->
61+
<dependency>
62+
<groupId>software.amazon.distro.opentelemetry</groupId>
63+
<artifactId>aws-opentelemetry-xray-udp-span-exporter</artifactId>
64+
<version>0.0.1</version>
65+
</dependency>
66+
<dependency>
67+
<groupId>io.grpc</groupId>
68+
<artifactId>grpc-netty-shaded</artifactId>
69+
<version>1.72.0</version>
70+
</dependency>
71+
5372
<!-- AWS Lambda Java Core -->
5473
<dependency>
5574
<groupId>com.amazonaws</groupId>
@@ -91,6 +110,11 @@
91110
<artifactId>sts</artifactId>
92111
<scope>test</scope>
93112
</dependency>
113+
<dependency>
114+
<groupId>software.amazon.awssdk</groupId>
115+
<artifactId>xray</artifactId>
116+
<scope>test</scope>
117+
</dependency>
94118
<dependency>
95119
<groupId>org.junit.jupiter</groupId>
96120
<artifactId>junit-jupiter</artifactId>
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
2+
// SPDX-License-Identifier: Apache-2.0
3+
package software.amazon.lambda.durable.examples.otel;
4+
5+
import io.opentelemetry.sdk.trace.SdkTracerProvider;
6+
import io.opentelemetry.sdk.trace.export.SimpleSpanProcessor;
7+
import software.amazon.distro.opentelemetry.exporter.xray.udp.trace.AwsXrayUdpSpanExporterBuilder;
8+
import software.amazon.lambda.durable.DurableConfig;
9+
import software.amazon.lambda.durable.DurableContext;
10+
import software.amazon.lambda.durable.DurableHandler;
11+
import software.amazon.lambda.durable.examples.types.GreetingRequest;
12+
import software.amazon.lambda.durable.otel.OpenTelemetryDurablePlugin;
13+
14+
/**
15+
* OTel + X-Ray example: simple steps in a single invocation.
16+
*
17+
* <p>Exports spans directly to X-Ray via the UDP span exporter. Requires {@code Tracing: Active} on the Lambda
18+
* function.
19+
*
20+
* <p>Expected trace structure in X-Ray:
21+
*
22+
* <pre>
23+
* durable.invocation
24+
* ├── durable.step:create-greeting
25+
* │ └── durable.step:create-greeting [attempt 1]
26+
* └── durable.step:transform
27+
* └── durable.step:transform [attempt 1]
28+
* </pre>
29+
*/
30+
public class OtelXRayStepExample extends DurableHandler<GreetingRequest, String> {
31+
32+
@Override
33+
protected DurableConfig createConfiguration() {
34+
var xrayExporter = new AwsXrayUdpSpanExporterBuilder().build();
35+
36+
var otelPlugin = new OpenTelemetryDurablePlugin(
37+
SdkTracerProvider.builder().addSpanProcessor(SimpleSpanProcessor.create(xrayExporter)));
38+
39+
return DurableConfig.builder().withPlugins(otelPlugin).build();
40+
}
41+
42+
@Override
43+
public String handleRequest(GreetingRequest input, DurableContext context) {
44+
context.getLogger().info("Starting OTel X-Ray step example for {}", input.getName());
45+
46+
var greeting = context.step("create-greeting", String.class, stepCtx -> "Hello, " + input.getName());
47+
48+
var result = context.step("transform", String.class, stepCtx -> greeting.toUpperCase() + "!");
49+
50+
context.getLogger().info("OTel X-Ray step example complete: {}", result);
51+
return result;
52+
}
53+
}
Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
2+
// SPDX-License-Identifier: Apache-2.0
3+
package software.amazon.lambda.durable.examples.otel;
4+
5+
import io.opentelemetry.sdk.trace.SdkTracerProvider;
6+
import io.opentelemetry.sdk.trace.export.SimpleSpanProcessor;
7+
import java.time.Duration;
8+
import software.amazon.distro.opentelemetry.exporter.xray.udp.trace.AwsXrayUdpSpanExporterBuilder;
9+
import software.amazon.lambda.durable.DurableConfig;
10+
import software.amazon.lambda.durable.DurableContext;
11+
import software.amazon.lambda.durable.DurableHandler;
12+
import software.amazon.lambda.durable.examples.types.GreetingRequest;
13+
import software.amazon.lambda.durable.otel.OpenTelemetryDurablePlugin;
14+
15+
/**
16+
* OTel + X-Ray example: step → wait → step pattern that forces multiple Lambda invocations.
17+
*
18+
* <p>This handler exercises the critical multi-invocation tracing scenario:
19+
*
20+
* <ol>
21+
* <li>Invocation 1: "before-wait" step completes → wait suspends execution
22+
* <li>Invocation 2: replays "before-wait" (no-op) → wait completes → "after-wait" step runs
23+
* </ol>
24+
*
25+
* <p>Exports spans directly to X-Ray via the UDP span exporter. Requires {@code Tracing: Active} on the Lambda
26+
* function.
27+
*
28+
* <p>Expected trace structure in X-Ray:
29+
*
30+
* <pre>
31+
* Trace (single trace ID across both invocations)
32+
* ├── durable.invocation (invocation 1)
33+
* │ ├── durable.step:before-wait
34+
* │ │ └── durable.step:before-wait [attempt 1]
35+
* │ └── durable.wait:pause (ended as PENDING)
36+
* └── durable.invocation (invocation 2)
37+
* ├── durable.wait:pause (completed)
38+
* └── durable.step:after-wait
39+
* └── durable.step:after-wait [attempt 1]
40+
* </pre>
41+
*
42+
* <p>All spans share the same deterministic trace ID derived from the execution ARN.
43+
*/
44+
public class OtelXRayWaitExample extends DurableHandler<GreetingRequest, String> {
45+
46+
@Override
47+
protected DurableConfig createConfiguration() {
48+
var xrayExporter = new AwsXrayUdpSpanExporterBuilder().build();
49+
50+
var otelPlugin = new OpenTelemetryDurablePlugin(
51+
SdkTracerProvider.builder().addSpanProcessor(SimpleSpanProcessor.create(xrayExporter)));
52+
53+
return DurableConfig.builder().withPlugins(otelPlugin).build();
54+
}
55+
56+
@Override
57+
public String handleRequest(GreetingRequest input, DurableContext context) {
58+
context.getLogger().info("Starting OTel X-Ray wait example for {}", input.getName());
59+
60+
var before = context.step("before-wait", String.class, stepCtx -> "Prepared: " + input.getName());
61+
62+
// This wait forces Lambda to suspend and re-invoke after the duration
63+
context.wait("pause", Duration.ofSeconds(5));
64+
65+
var after = context.step("after-wait", String.class, stepCtx -> before + " | Resumed and completed");
66+
67+
context.getLogger().info("OTel X-Ray wait example complete: {}", after);
68+
return after;
69+
}
70+
}
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
receivers:
2+
otlp:
3+
protocols:
4+
grpc:
5+
endpoint: "localhost:4317"
6+
http:
7+
endpoint: "localhost:4318"
8+
9+
exporters:
10+
awsxray:
11+
12+
service:
13+
pipelines:
14+
traces:
15+
receivers: [otlp]
16+
exporters: [awsxray]

0 commit comments

Comments
 (0)