Add AWS_LAMBDA_RESOURCE_MAPPING_ID Semantic Convention Support for AWS Lambda SDK

This PR adds support for the AWS_LAMBDA_RESOURCE_MAPPING_ID semantic convention attribute in the AWS Lambda SDK instrumentation library.

It also introduces the following two experimental attributes. Work is currently underway to add these keys to the AWS section of the Semantic Conventions (SemConv) registry:

aws.lambda.function.arn
aws.lambda.function.name

Name is extracted from request object.
ARN is extracted from response object.
Resource Mapping ID is extracted from both request and response objects.
This behavior is covered by unit tests.

Tests Run:
./gradlew spotlessCheck
./gradlew instrumentation:check
./gradlew :smoke-tests:test

All newly added tests pass, and no regressions were found.

Backward Compatibility:
This change is fully backward compatible. It introduces instrumentation for an additional AWS resource without modifying existing behavior in the auto-instrumentation library.

Author: lukeina2z

instrumentation/aws-sdk/aws-sdk-1.11/javaagent/build.gradle.kts

@@ -44,6 +44,7 @@ dependencies {
   testLibrary("com.amazonaws:aws-java-sdk-dynamodb:1.11.106")
   testLibrary("com.amazonaws:aws-java-sdk-ec2:1.11.106")
   testLibrary("com.amazonaws:aws-java-sdk-kinesis:1.11.106")
+  testLibrary("com.amazonaws:aws-java-sdk-lambda:1.11.106")
   testLibrary("com.amazonaws:aws-java-sdk-rds:1.11.106")
   testLibrary("com.amazonaws:aws-java-sdk-s3:1.11.106")
   testLibrary("com.amazonaws:aws-java-sdk-sns:1.11.106")

instrumentation/aws-sdk/aws-sdk-1.11/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/awssdk/v1_11/LambdaClientTest.java

@@ -0,0 +1,27 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.awssdk.v1_11;
+
+import com.amazonaws.services.lambda.AWSLambdaClientBuilder;
+import io.opentelemetry.instrumentation.awssdk.v1_11.AbstractLambdaClientTest;
+import io.opentelemetry.instrumentation.testing.junit.AgentInstrumentationExtension;
+import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+class LambdaClientTest extends AbstractLambdaClientTest {
+  @RegisterExtension
+  static final InstrumentationExtension testing = AgentInstrumentationExtension.create();
+
+  @Override
+  protected InstrumentationExtension testing() {
+    return testing;
+  }
+
+  @Override
+  public AWSLambdaClientBuilder configureClient(AWSLambdaClientBuilder clientBuilder) {
+    return clientBuilder;
+  }
+}

instrumentation/aws-sdk/aws-sdk-1.11/library/build.gradle.kts

@@ -14,6 +14,7 @@ dependencies {
   testLibrary("com.amazonaws:aws-java-sdk-dynamodb:1.11.106")
   testLibrary("com.amazonaws:aws-java-sdk-ec2:1.11.106")
   testLibrary("com.amazonaws:aws-java-sdk-kinesis:1.11.106")
+  testLibrary("com.amazonaws:aws-java-sdk-lambda:1.11.106")
   testLibrary("com.amazonaws:aws-java-sdk-rds:1.11.106")
   testLibrary("com.amazonaws:aws-java-sdk-s3:1.11.106")
   testLibrary("com.amazonaws:aws-java-sdk-sns:1.11.106")

instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/AwsExperimentalAttributes.java

@@ -17,5 +17,11 @@ final class AwsExperimentalAttributes {
   static final AttributeKey<String> AWS_STREAM_NAME = stringKey("aws.stream.name");
   static final AttributeKey<String> AWS_TABLE_NAME = stringKey("aws.table.name");
 
+  // Work is underway to add these two keys to the SemConv AWS registry, in line with other AWS
+  // resources.
+  // https://github.com/open-telemetry/semantic-conventions/blob/main/docs/registry/attributes/aws.md#amazon-lambda-attributes
+  static final AttributeKey<String> AWS_LAMBDA_ARN = stringKey("aws.lambda.function.arn");
+  static final AttributeKey<String> AWS_LAMBDA_NAME = stringKey("aws.lambda.function.name");
+
   private AwsExperimentalAttributes() {}
 }

instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/AwsSdkAttributesExtractor.java

@@ -26,6 +26,8 @@ class AwsSdkAttributesExtractor implements AttributesExtractor<Request<?>, Respo
   // Copied from AwsIncubatingAttributes
   private static final AttributeKey<String> AWS_SECRETSMANAGER_SECRET_ARN =
       stringKey("aws.secretsmanager.secret.arn");
+  private static final AttributeKey<String> AWS_LAMBDA_RESOURCE_MAPPING_ID =
+      stringKey("aws.lambda.resource_mapping.id");
   private static final AttributeKey<String> AWS_SNS_TOPIC_ARN = stringKey("aws.sns.topic.arn");
   private static final AttributeKey<String> AWS_STEP_FUNCTIONS_ACTIVITY_ARN =
       stringKey("aws.step_functions.activity.arn");
@@ -46,6 +48,11 @@ private static boolean canGetResponseMetadata() {
   @Override
   public void onStart(AttributesBuilder attributes, Context parentContext, Request<?> request) {
     Object originalRequest = request.getOriginalRequest();
+    setAttribute(
+        attributes,
+        AWS_LAMBDA_RESOURCE_MAPPING_ID,
+        originalRequest,
+        RequestAccess::getLambdaResourceMappingId);
     setAttribute(attributes, AWS_SNS_TOPIC_ARN, originalRequest, RequestAccess::getSnsTopicArn);
     setAttribute(
         attributes,
@@ -69,6 +76,11 @@ public void onEnd(
     Object awsResp = getAwsResponse(response);
     if (awsResp != null) {
       setAttribute(attributes, AWS_SECRETSMANAGER_SECRET_ARN, awsResp, RequestAccess::getSecretArn);
+      setAttribute(
+          attributes,
+          AWS_LAMBDA_RESOURCE_MAPPING_ID,
+          awsResp,
+          RequestAccess::getLambdaResourceMappingId);
       setAttribute(attributes, AWS_SNS_TOPIC_ARN, awsResp, RequestAccess::getSnsTopicArn);
       setAttribute(
           attributes,

instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/AwsSdkExperimentalAttributesExtractor.java

@@ -7,6 +7,8 @@
 
 import static io.opentelemetry.instrumentation.awssdk.v1_11.AwsExperimentalAttributes.AWS_AGENT;
 import static io.opentelemetry.instrumentation.awssdk.v1_11.AwsExperimentalAttributes.AWS_BUCKET_NAME;
+import static io.opentelemetry.instrumentation.awssdk.v1_11.AwsExperimentalAttributes.AWS_LAMBDA_ARN;
+import static io.opentelemetry.instrumentation.awssdk.v1_11.AwsExperimentalAttributes.AWS_LAMBDA_NAME;
 import static io.opentelemetry.instrumentation.awssdk.v1_11.AwsExperimentalAttributes.AWS_QUEUE_NAME;
 import static io.opentelemetry.instrumentation.awssdk.v1_11.AwsExperimentalAttributes.AWS_QUEUE_URL;
 import static io.opentelemetry.instrumentation.awssdk.v1_11.AwsExperimentalAttributes.AWS_STREAM_NAME;
@@ -35,6 +37,7 @@ public void onStart(AttributesBuilder attributes, Context parentContext, Request
     setRequestAttribute(attributes, AWS_QUEUE_NAME, originalRequest, RequestAccess::getQueueName);
     setRequestAttribute(attributes, AWS_STREAM_NAME, originalRequest, RequestAccess::getStreamName);
     setRequestAttribute(attributes, AWS_TABLE_NAME, originalRequest, RequestAccess::getTableName);
+    setRequestAttribute(attributes, AWS_LAMBDA_NAME, originalRequest, RequestAccess::getLambdaName);
   }
 
   private static void setRequestAttribute(
@@ -54,5 +57,17 @@ public void onEnd(
       Context context,
       Request<?> request,
       @Nullable Response<?> response,
-      @Nullable Throwable error) {}
+      @Nullable Throwable error) {
+    Object awsResponse = getAwsResponse(response);
+    if (awsResponse != null) {
+      setRequestAttribute(attributes, AWS_LAMBDA_ARN, awsResponse, RequestAccess::getLambdaArn);
+    }
+  }
+
+  private static Object getAwsResponse(Response<?> response) {
+    if (response == null) {
+      return null;
+    }
+    return response.getAwsResponse();
+  }
 }

instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/RequestAccess.java

@@ -8,11 +8,13 @@
 import java.lang.invoke.MethodHandle;
 import java.lang.invoke.MethodHandles;
 import java.lang.invoke.MethodType;
+import java.lang.reflect.Method;
 import javax.annotation.Nullable;
 
 final class RequestAccess {
   private static final String SECRETS_MANAGER_REQUEST_CLASS_PREFIX =
       "com.amazonaws.services.secretsmanager.model.";
+  private static final String LAMBDA_REQUEST_CLASS_PREFIX = "com.amazonaws.services.lambda.model.";
   private static final String STEP_FUNCTIONS_REQUEST_CLASS_PREFIX =
       "com.amazonaws.services.stepfunctions.model.";
 
@@ -24,6 +26,36 @@ protected RequestAccess computeValue(Class<?> type) {
         }
       };
 
+  @Nullable
+  static String getLambdaArn(Object request) {
+    RequestAccess access = REQUEST_ACCESSORS.get(request.getClass());
+    if (access.getLambdaConfiguration == null) {
+      return null;
+    }
+    try {
+      Object config = access.getLambdaConfiguration.invoke(request);
+      if (config == null) {
+        return null;
+      }
+      Method method = config.getClass().getMethod("getFunctionArn");
+      return (String) method.invoke(config);
+    } catch (Throwable t) {
+      return null;
+    }
+  }
+
+  @Nullable
+  static String getLambdaName(Object request) {
+    RequestAccess access = REQUEST_ACCESSORS.get(request.getClass());
+    return invokeOrNull(access.getLambdaName, request);
+  }
+
+  @Nullable
+  static String getLambdaResourceMappingId(Object request) {
+    RequestAccess access = REQUEST_ACCESSORS.get(request.getClass());
+    return invokeOrNull(access.getLambdaResourceMappingId, request);
+  }
+
   @Nullable
   static String getSecretArn(Object request) {
     RequestAccess access = REQUEST_ACCESSORS.get(request.getClass());
@@ -97,6 +129,9 @@ private static String invokeOrNull(@Nullable MethodHandle method, Object obj) {
   }
 
   @Nullable private final MethodHandle getBucketName;
+  @Nullable private final MethodHandle getLambdaConfiguration;
+  @Nullable private final MethodHandle getLambdaName;
+  @Nullable private final MethodHandle getLambdaResourceMappingId;
   @Nullable private final MethodHandle getQueueUrl;
   @Nullable private final MethodHandle getQueueName;
   @Nullable private final MethodHandle getSecretArn;
@@ -116,6 +151,10 @@ private RequestAccess(Class<?> clz) {
     getTopicArn = findAccessorOrNull(clz, "getTopicArn");
     getTargetArn = findAccessorOrNull(clz, "getTargetArn");
 
+    boolean isLambda = clz.getName().startsWith(LAMBDA_REQUEST_CLASS_PREFIX);
+    getLambdaConfiguration = isLambda ? findLambdaGetConfigurationMethod(clz) : null;
+    getLambdaName = isLambda ? findAccessorOrNull(clz, "getFunctionName") : null;
+    getLambdaResourceMappingId = isLambda ? findAccessorOrNull(clz, "getUUID") : null;
     boolean isSecretsManager = clz.getName().startsWith(SECRETS_MANAGER_REQUEST_CLASS_PREFIX);
     getSecretArn = isSecretsManager ? findAccessorOrNull(clz, "getARN") : null;
     boolean isStepFunction = clz.getName().startsWith(STEP_FUNCTIONS_REQUEST_CLASS_PREFIX);
@@ -125,9 +164,26 @@ private RequestAccess(Class<?> clz) {
 
   @Nullable
   private static MethodHandle findAccessorOrNull(Class<?> clz, String methodName) {
+    return findAccessorOrNull(clz, methodName, String.class);
+  }
+
+  @Nullable
+  private static MethodHandle findAccessorOrNull(
+      Class<?> clz, String methodName, Class<?> returnType) {
     try {
       return MethodHandles.publicLookup()
-          .findVirtual(clz, methodName, MethodType.methodType(String.class));
+          .findVirtual(clz, methodName, MethodType.methodType(returnType));
+    } catch (Throwable t) {
+      return null;
+    }
+  }
+
+  @Nullable
+  private static MethodHandle findLambdaGetConfigurationMethod(Class<?> clz) {
+    try {
+      Class<?> returnType =
+          Class.forName("com.amazonaws.services.lambda.model.FunctionConfiguration");
+      return findAccessorOrNull(clz, "getConfiguration", returnType);
     } catch (Throwable t) {
       return null;
     }

instrumentation/aws-sdk/aws-sdk-1.11/library/src/test/java/io/opentelemetry/instrumentation/awssdk/v1_11/LambdaClientTest.java

@@ -0,0 +1,30 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.instrumentation.awssdk.v1_11;
+
+import com.amazonaws.services.lambda.AWSLambdaClientBuilder;
+import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
+import io.opentelemetry.instrumentation.testing.junit.LibraryInstrumentationExtension;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+class LambdaClientTest extends AbstractLambdaClientTest {
+  @RegisterExtension
+  private static final InstrumentationExtension testing = LibraryInstrumentationExtension.create();
+
+  @Override
+  protected InstrumentationExtension testing() {
+    return testing;
+  }
+
+  @Override
+  public AWSLambdaClientBuilder configureClient(AWSLambdaClientBuilder clientBuilder) {
+    return clientBuilder.withRequestHandlers(
+        AwsSdkTelemetry.builder(testing().getOpenTelemetry())
+            .setCaptureExperimentalSpanAttributes(true)
+            .build()
+            .newRequestHandler());
+  }
+}

instrumentation/aws-sdk/aws-sdk-1.11/testing/build.gradle.kts

@@ -10,6 +10,7 @@ dependencies {
   compileOnly("com.amazonaws:aws-java-sdk-dynamodb:1.11.106")
   compileOnly("com.amazonaws:aws-java-sdk-ec2:1.11.106")
   compileOnly("com.amazonaws:aws-java-sdk-kinesis:1.11.106")
+  compileOnly("com.amazonaws:aws-java-sdk-lambda:1.11.106")
   compileOnly("com.amazonaws:aws-java-sdk-rds:1.11.106")
   compileOnly("com.amazonaws:aws-java-sdk-s3:1.11.106")
   compileOnly("com.amazonaws:aws-java-sdk-secretsmanager:1.12.80")