UDP Exporter release workflow (#1049)

*Description of changes:*
The validation steps for the GitHub workflow intended to manually
trigger a UDP exporter release to Maven Central includes:
The workflow will first build the UDP exporter.
The workflow will then set up and run an instance of X-Ray daemon.
Following setup, it will run a validation app to send traces to X-Ray
daemon via UDP exporter.
Finally, it will execute a validation step to verify that daemon
received the traces.

TODO:
1. Add a publish to Maven Central step to release workflow.

Test workflow link:
https://github.com/aws-observability/aws-otel-java-instrumentation/actions/runs/14043198263

By submitting this pull request, I confirm that my contribution is made
under the terms of the Apache 2.0 license.

---------

Co-authored-by: Jeel Mehta <jeelmm@amazon.com>
Co-authored-by: Michael He <53622546+yiyuan-he@users.noreply.github.com>
Co-authored-by: Jonathan Lee <107072447+jj22ee@users.noreply.github.com>
Co-authored-by: jjllee <jjllee@amazon.com>

Author: 4 people

.github/workflows/pr-build.yml

@@ -88,6 +88,10 @@ jobs:
         with:
           arguments: build integrationTests --stacktrace -PenableCoverage=true -PlocalDocker=true
 
+      - name: Build and Test UDP exporter
+        run: |
+          ./gradlew build -p exporters/aws-opentelemetry-xray-udp-span-exporter
+
       - name: Set up Java version for tests
         uses: actions/setup-java@v4
         with:

.github/workflows/release-udp-exporter.yml

@@ -0,0 +1,39 @@
+name: Release ADOT X-Ray UDP Exporter
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: The version to tag the release with, e.g., 1.2.0
+        required: true
+        type: string
+
+permissions:
+  id-token: write
+
+jobs:
+  validate-udp-exporter-e2e-test:
+    name: "Validate X-Ray UDP Exporter E2E Test Succeeds"
+    uses: ./.github/workflows/udp-exporter-e2e-test.yml
+    secrets: inherit
+    permissions:
+      id-token: write
+
+  release-udp-exporter:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Java
+        uses: actions/setup-java@v3
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+          cache: 'gradle'
+
+      - name: Build and Test UDP exporter
+        run: |
+          ./gradlew build -p exporters/aws-opentelemetry-xray-udp-span-exporter
+
+      # TODO: Steps to publish to Maven Central

.github/workflows/udp-exporter-e2e-test.yml

@@ -0,0 +1,74 @@
+name: Test ADOT X-Ray UDP Exporter
+on:
+  workflow_call:
+  push:
+    branches:
+      - main
+
+permissions:
+  id-token: write
+
+jobs:
+  udp-exporter-e2e-test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Java
+        uses: actions/setup-java@v3
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+          cache: 'gradle'
+
+      - name: Configure AWS credentials for Testing Tracing
+        uses: aws-actions/configure-aws-credentials@v4
+        with:
+          role-to-assume: ${{ secrets.XRAY_UDP_EXPORTER_TEST_ROLE }}
+          aws-region: 'us-east-1'
+
+      - name: Download and run X-Ray Daemon
+        run: |
+          mkdir xray-daemon
+          cd xray-daemon
+          wget https://s3.us-east-2.amazonaws.com/aws-xray-assets.us-east-2/xray-daemon/aws-xray-daemon-linux-3.x.zip
+          unzip aws-xray-daemon-linux-3.x.zip
+          ./xray -o -n us-east-2 -f ./daemon-logs.log --log-level debug &
+
+      - name: Publish UDP exporter to Maven Local
+        id: build-udp-exporter
+        working-directory: exporters/aws-opentelemetry-xray-udp-span-exporter
+        run: |
+          gradle build 
+          gradle publishToMavenLocal
+          echo "xrayUdpSpanExporterVersion=$(gradle -q printVersion)" >> $GITHUB_OUTPUT
+
+      - name: Setup and Run Sample App in Background
+        working-directory: sample-apps/integ-test-app
+        run: |
+          export XRAY_UDP_SPAN_EXPORTER_VERSION=${{ steps.build-udp-exporter.outputs.xrayUdpSpanExporterVersion }}
+          echo "Running Sample App against X-Ray UDP Span Exporter version: $XRAY_UDP_SPAN_EXPORTER_VERSION"
+          gradle build
+          gradle bootRun &
+          sleep 5
+
+      - name: Call Sample App Endpoint
+        id: call-endpoint
+        run: |
+          echo "traceId=$(curl localhost:8080/test)" >> $GITHUB_OUTPUT
+
+      - name: Check if traces are successfully sent to AWS X-Ray
+        run: |
+          sleep 20
+          # # Print Daemon Logs for debugging
+          # cat xray-daemon/daemon-logs.log
+
+          traceId=${{ steps.call-endpoint.outputs.traceId }}
+          numTracesFound=$(aws xray batch-get-traces --trace-ids $traceId --region us-east-2 | jq '.Traces' | jq length)
+          if [[ numTracesFound -ne "1" ]]; then
+            echo "TraceId $traceId not found in X-Ray."
+            exit 1
+          else
+            echo "TraceId $traceId found in X-Ray."
+          fi

exporters/aws-opentelemetry-xray-lambda-exporter/build.gradle.kts renamed to exporters/aws-opentelemetry-xray-udp-span-exporter/build.gradle.kts

@@ -19,16 +19,14 @@ plugins {
   id("maven-publish")
 }
 
-group = "software.amazon.distro.opentelemetry.exporter.xray.lambda"
+group = "software.amazon.distro.opentelemetry.exporter.xray.udp.trace"
 version = "0.1.0"
 
 dependencies {
   implementation(platform("io.opentelemetry.instrumentation:opentelemetry-instrumentation-bom:2.10.0"))
-  compileOnly("io.opentelemetry:opentelemetry-api")
-  compileOnly("io.opentelemetry:opentelemetry-sdk")
-  compileOnly("io.opentelemetry:opentelemetry-exporter-otlp-common")
+  implementation("io.opentelemetry:opentelemetry-sdk")
+  implementation("io.opentelemetry:opentelemetry-exporter-otlp-common")
   compileOnly("com.google.code.findbugs:jsr305:3.0.2")
-  testImplementation("io.opentelemetry:opentelemetry-api")
   testImplementation("io.opentelemetry:opentelemetry-sdk")
   testImplementation("io.opentelemetry:opentelemetry-exporter-otlp-common")
   testImplementation(platform("org.junit:junit-bom:5.9.2"))
@@ -89,12 +87,18 @@ tasks.named<Jar>("sourcesJar") {
   duplicatesStrategy = DuplicatesStrategy.EXCLUDE
 }
 
+tasks.create("printVersion") {
+  doLast {
+    println(project.version.toString())
+  }
+}
+
 publishing {
   publications {
     create<MavenPublication>("mavenJava") {
       from(components["java"])
       groupId = project.group.toString()
-      artifactId = "aws-opentelemetry-xray-lambda-exporter"
+      artifactId = "aws-opentelemetry-xray-udp-span-exporter"
       version = project.version.toString()
     }
   }

exporters/aws-opentelemetry-xray-udp-span-exporter/settings.gradle.kts

@@ -0,0 +1,12 @@
+rootProject.name = "aws-opentelemetry-xray-udp-span-exporter"
+
+dependencyResolutionManagement {
+  repositories {
+    mavenCentral()
+    mavenLocal()
+
+    maven {
+      setUrl("https://oss.sonatype.org/content/repositories/snapshots")
+    }
+  }
+}

exporters/aws-opentelemetry-xray-lambda-exporter/src/main/java/software/amazon/distro/opentelemetry/exporter/xray/lambda/AwsXrayLambdaExporter.java renamed to exporters/aws-opentelemetry-xray-udp-span-exporter/src/main/java/software/amazon/distro/opentelemetry/exporter/xray/udp/trace/AwsXrayUdpSpanExporter.java

@@ -13,7 +13,7 @@
  * permissions and limitations under the License.
  */
 
-package software.amazon.distro.opentelemetry.exporter.xray.lambda;
+package software.amazon.distro.opentelemetry.exporter.xray.udp.trace;
 
 import io.opentelemetry.exporter.internal.otlp.traces.TraceRequestMarshaler;
 import io.opentelemetry.sdk.common.CompletableResultCode;
@@ -37,16 +37,16 @@
  * specific information.
  */
 @Immutable
-public class AwsXrayLambdaExporter implements SpanExporter {
+public class AwsXrayUdpSpanExporter implements SpanExporter {
 
-  private static final Logger logger = Logger.getLogger(AwsXrayLambdaExporter.class.getName());
+  private static final Logger logger = Logger.getLogger(AwsXrayUdpSpanExporter.class.getName());
 
   private final AtomicBoolean isShutdown = new AtomicBoolean();
 
   private final UdpSender sender;
   private final String payloadPrefix;
 
-  AwsXrayLambdaExporter(UdpSender sender, String payloadPrefix) {
+  AwsXrayUdpSpanExporter(UdpSender sender, String payloadPrefix) {
     this.sender = sender;
     this.payloadPrefix = payloadPrefix;
   }
@@ -94,4 +94,4 @@ UdpSender getSender() {
   String getPayloadPrefix() {
     return payloadPrefix;
   }
-}
+}

exporters/aws-opentelemetry-xray-lambda-exporter/src/main/java/software/amazon/distro/opentelemetry/exporter/xray/lambda/AwsXrayLambdaExporterBuilder.java renamed to exporters/aws-opentelemetry-xray-udp-span-exporter/src/main/java/software/amazon/distro/opentelemetry/exporter/xray/udp/trace/AwsXrayUdpSpanExporterBuilder.java

@@ -13,13 +13,13 @@
  * permissions and limitations under the License.
  */
 
-package software.amazon.distro.opentelemetry.exporter.xray.lambda;
+package software.amazon.distro.opentelemetry.exporter.xray.udp.trace;
 
 import static java.util.Objects.requireNonNull;
 
 import java.util.Map;
 
-public final class AwsXrayLambdaExporterBuilder {
+public final class AwsXrayUdpSpanExporterBuilder {
 
   private static final String DEFAULT_HOST = "127.0.0.1";
   private static final int DEFAULT_PORT = 2000;
@@ -41,7 +41,7 @@ public final class AwsXrayLambdaExporterBuilder {
   private static final String AWS_LAMBDA_FUNCTION_NAME_CONFIG = "AWS_LAMBDA_FUNCTION_NAME";
   private static final String AWS_XRAY_DAEMON_ADDRESS_CONFIG = "AWS_XRAY_DAEMON_ADDRESS";
 
-  public AwsXrayLambdaExporterBuilder setEndpoint(String endpoint) {
+  public AwsXrayUdpSpanExporterBuilder setEndpoint(String endpoint) {
     requireNonNull(endpoint, "endpoint must not be null");
     try {
       this.sender = createSenderFromEndpoint(endpoint);
@@ -51,7 +51,7 @@ public AwsXrayLambdaExporterBuilder setEndpoint(String endpoint) {
     return this;
   }
 
-  public AwsXrayLambdaExporterBuilder setPayloadSampleDecision(TracePayloadSampleDecision decision) {
+  public AwsXrayUdpSpanExporterBuilder setPayloadSampleDecision(TracePayloadSampleDecision decision) {
     this.tracePayloadPrefix =
         decision == TracePayloadSampleDecision.SAMPLED
             ? FORMAT_OTEL_SAMPLED_TRACES_BINARY_PREFIX
@@ -67,7 +67,7 @@ private UdpSender createSenderFromEndpoint(String endpoint) {
     }
 
   // For testing purposes
-  AwsXrayLambdaExporterBuilder withEnvironmentVariables(Map<String, String> env) {
+  AwsXrayUdpSpanExporterBuilder withEnvironmentVariables(Map<String, String> env) {
     this.environmentVariables = env;
     return this;
   }
@@ -77,7 +77,7 @@ Map<String, String> getEnvironmentVariables() {
     return environmentVariables;
   }
 
-  public AwsXrayLambdaExporter build() {
+  public AwsXrayUdpSpanExporter build() {
     if (sender == null) {
       String endpoint = null;
 
@@ -87,7 +87,7 @@ public AwsXrayLambdaExporter build() {
         if (endpoint != null && !endpoint.isEmpty()) {
           try {
             this.sender = createSenderFromEndpoint(endpoint);
-            return new AwsXrayLambdaExporter(
+            return new AwsXrayUdpSpanExporter(
                 this.sender, PROTOCOL_HEADER + PROTOCOL_DELIMITER + tracePayloadPrefix);
           } catch (Exception e) {
             // Fallback to defaults if parsing fails
@@ -99,7 +99,7 @@ public AwsXrayLambdaExporter build() {
       // Use defaults if not in Lambda or if daemon address is invalid/unavailable
       this.sender = new UdpSender(DEFAULT_HOST, DEFAULT_PORT);
     }
-    return new AwsXrayLambdaExporter(
+    return new AwsXrayUdpSpanExporter(
         this.sender, PROTOCOL_HEADER + PROTOCOL_DELIMITER + tracePayloadPrefix);
   }
 
@@ -109,7 +109,7 @@ private boolean isLambdaEnvironment() {
   }
 
   // Only for testing
-  AwsXrayLambdaExporterBuilder setSender(UdpSender sender) {
+  AwsXrayUdpSpanExporterBuilder setSender(UdpSender sender) {
     this.sender = sender;
     return this;
   }
@@ -118,4 +118,4 @@ AwsXrayLambdaExporterBuilder setSender(UdpSender sender) {
 enum TracePayloadSampleDecision {
   SAMPLED,
   UNSAMPLED
-}
+}

exporters/aws-opentelemetry-xray-lambda-exporter/src/main/java/software/amazon/distro/opentelemetry/exporter/xray/lambda/UdpSender.java renamed to exporters/aws-opentelemetry-xray-udp-span-exporter/src/main/java/software/amazon/distro/opentelemetry/exporter/xray/udp/trace/UdpSender.java

@@ -13,7 +13,7 @@
  * permissions and limitations under the License.
  */
 
-package software.amazon.distro.opentelemetry.exporter.xray.lambda;
+package software.amazon.distro.opentelemetry.exporter.xray.udp.trace;
 
 import io.opentelemetry.sdk.common.CompletableResultCode;
 import java.io.IOException;