Skip to content

Update AWS SDK request id to match semantic conventions #12352

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Oct 9, 2024
Merged

Update AWS SDK request id to match semantic conventions #12352

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
351a23f
update attribute name for sqs request id to match sem conv
jaydeluca Sep 28, 2024
60e5e76
fix missing request_id in aws 1.11 instrumentation
jaydeluca Sep 28, 2024
5912c1d
bump min aws sdk version to fix muzzle checks
jaydeluca Sep 30, 2024
e8ed1d8
use reflection instead of bumping aws sdk version, fix remaining tests
jaydeluca Sep 30, 2024
26e7134
undo readme change
jaydeluca Sep 30, 2024
0dd6deb
change reference to request ID to use AwsIncubatingAttributes, update…
jaydeluca Oct 1, 2024
ef5408e
imports
jaydeluca Oct 1, 2024
3b4b367
emit aws request_id attribute by default
jaydeluca Oct 3, 2024
7a51fbd
update reference to attribute key
jaydeluca Oct 8, 2024
74b5a07
Merge branch 'main' of github.com:jaydeluca/opentelemetry-java-instru…
jaydeluca Oct 8, 2024
c9ea7bb
Merge branch 'main' of github.com:jaydeluca/opentelemetry-java-instru…
jaydeluca Oct 8, 2024
65300a5
update spring tests
jaydeluca Oct 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 25 additions & 11 deletions instrumentation/aws-sdk/aws-sdk-1.11/javaagent/src/test/groovy/S3TracingTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

import io.opentelemetry.instrumentation.test.AgentInstrumentationSpecification
import io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes
import io.opentelemetry.semconv.incubating.AwsIncubatingAttributes
import io.opentelemetry.semconv.ServerAttributes
import io.opentelemetry.semconv.HttpAttributes
import io.opentelemetry.semconv.NetworkAttributes
Expand Down Expand Up @@ -60,8 +61,9 @@ class S3TracingTest extends AgentInstrumentationSpecification {
attributes {
"aws.agent" "java-aws-sdk"
"aws.endpoint" String
"rpc.method" "CreateQueue"
"aws.queue.name" queueName
"$AwsIncubatingAttributes.AWS_REQUEST_ID" String
"rpc.method" "CreateQueue"
"rpc.system" "aws-api"
"rpc.service" "AmazonSQS"
"$HttpAttributes.HTTP_REQUEST_METHOD" "POST"
Expand All @@ -82,10 +84,10 @@ class S3TracingTest extends AgentInstrumentationSpecification {
attributes {
"aws.agent" "java-aws-sdk"
"aws.endpoint" String
"aws.bucket.name" bucketName
"rpc.method" "CreateBucket"
"rpc.system" "aws-api"
"rpc.service" "Amazon S3"
"aws.bucket.name" bucketName
"$HttpAttributes.HTTP_REQUEST_METHOD" "PUT"
"$HttpAttributes.HTTP_RESPONSE_STATUS_CODE" 200
"$UrlAttributes.URL_FULL" { it.startsWith("http://") }
Expand All @@ -104,8 +106,9 @@ class S3TracingTest extends AgentInstrumentationSpecification {
attributes {
"aws.agent" "java-aws-sdk"
"aws.endpoint" String
"rpc.method" "GetQueueAttributes"
"aws.queue.url" queueUrl
"$AwsIncubatingAttributes.AWS_REQUEST_ID" String
"rpc.method" "GetQueueAttributes"
"rpc.system" "aws-api"
"rpc.service" "AmazonSQS"
"$HttpAttributes.HTTP_REQUEST_METHOD" "POST"
Expand All @@ -126,8 +129,9 @@ class S3TracingTest extends AgentInstrumentationSpecification {
attributes {
"aws.agent" "java-aws-sdk"
"aws.endpoint" String
"rpc.method" "SetQueueAttributes"
"aws.queue.url" queueUrl
"$AwsIncubatingAttributes.AWS_REQUEST_ID" String
"rpc.method" "SetQueueAttributes"
"rpc.system" "aws-api"
"rpc.service" "AmazonSQS"
"$HttpAttributes.HTTP_REQUEST_METHOD" "POST"
Expand Down Expand Up @@ -188,8 +192,9 @@ class S3TracingTest extends AgentInstrumentationSpecification {
attributes {
"aws.agent" "java-aws-sdk"
"aws.endpoint" String
"rpc.method" "ReceiveMessage"
"aws.queue.url" queueUrl
"$AwsIncubatingAttributes.AWS_REQUEST_ID" String
"rpc.method" "ReceiveMessage"
"rpc.system" "aws-api"
"rpc.service" "AmazonSQS"
"$HttpAttributes.HTTP_REQUEST_METHOD" "POST"
Expand Down Expand Up @@ -282,8 +287,9 @@ class S3TracingTest extends AgentInstrumentationSpecification {
attributes {
"aws.agent" "java-aws-sdk"
"aws.endpoint" String
"rpc.method" "PurgeQueue"
"aws.queue.url" queueUrl
"$AwsIncubatingAttributes.AWS_REQUEST_ID" String
"rpc.method" "PurgeQueue"
"rpc.system" "aws-api"
"rpc.service" "AmazonSQS"
"$HttpAttributes.HTTP_REQUEST_METHOD" "POST"
Expand Down Expand Up @@ -336,8 +342,9 @@ class S3TracingTest extends AgentInstrumentationSpecification {
attributes {
"aws.agent" "java-aws-sdk"
"aws.endpoint" String
"rpc.method" "CreateQueue"
"aws.queue.name" queueName
"$AwsIncubatingAttributes.AWS_REQUEST_ID" String
"rpc.method" "CreateQueue"
"rpc.system" "aws-api"
"rpc.service" "AmazonSQS"
"$HttpAttributes.HTTP_REQUEST_METHOD" "POST"
Expand All @@ -357,8 +364,9 @@ class S3TracingTest extends AgentInstrumentationSpecification {
attributes {
"aws.agent" "java-aws-sdk"
"aws.endpoint" String
"rpc.method" "GetQueueAttributes"
"aws.queue.url" queueUrl
"$AwsIncubatingAttributes.AWS_REQUEST_ID" String
"rpc.method" "GetQueueAttributes"
"rpc.system" "aws-api"
"rpc.service" "AmazonSQS"
"$HttpAttributes.HTTP_REQUEST_METHOD" "POST"
Expand Down Expand Up @@ -399,6 +407,7 @@ class S3TracingTest extends AgentInstrumentationSpecification {
attributes {
"aws.agent" "java-aws-sdk"
"aws.endpoint" String
"$AwsIncubatingAttributes.AWS_REQUEST_ID" String
"rpc.method" "CreateTopic"
"rpc.system" "aws-api"
"rpc.service" "AmazonSNS"
Expand All @@ -419,6 +428,7 @@ class S3TracingTest extends AgentInstrumentationSpecification {
attributes {
"aws.agent" "java-aws-sdk"
"aws.endpoint" String
"$AwsIncubatingAttributes.AWS_REQUEST_ID" String
"rpc.method" "Subscribe"
"rpc.system" "aws-api"
"rpc.service" "AmazonSNS"
Expand All @@ -440,8 +450,9 @@ class S3TracingTest extends AgentInstrumentationSpecification {
attributes {
"aws.agent" "java-aws-sdk"
"aws.endpoint" String
"rpc.method" "SetQueueAttributes"
"aws.queue.url" queueUrl
"$AwsIncubatingAttributes.AWS_REQUEST_ID" String
"rpc.method" "SetQueueAttributes"
"rpc.system" "aws-api"
"rpc.service" "AmazonSQS"
"$HttpAttributes.HTTP_REQUEST_METHOD" "POST"
Expand All @@ -461,6 +472,7 @@ class S3TracingTest extends AgentInstrumentationSpecification {
attributes {
"aws.agent" "java-aws-sdk"
"aws.endpoint" String
"$AwsIncubatingAttributes.AWS_REQUEST_ID" String
"rpc.method" "SetTopicAttributes"
"rpc.system" "aws-api"
"rpc.service" "AmazonSNS"
Expand Down Expand Up @@ -524,8 +536,9 @@ class S3TracingTest extends AgentInstrumentationSpecification {
attributes {
"aws.agent" "java-aws-sdk"
"aws.endpoint" String
"rpc.method" "ReceiveMessage"
"aws.queue.url" queueUrl
"$AwsIncubatingAttributes.AWS_REQUEST_ID" String
"rpc.method" "ReceiveMessage"
"rpc.system" "aws-api"
"rpc.service" "AmazonSQS"
"$HttpAttributes.HTTP_REQUEST_METHOD" "POST"
Expand Down Expand Up @@ -618,8 +631,9 @@ class S3TracingTest extends AgentInstrumentationSpecification {
attributes {
"aws.agent" "java-aws-sdk"
"aws.endpoint" String
"rpc.method" "PurgeQueue"
"aws.queue.url" queueUrl
"$AwsIncubatingAttributes.AWS_REQUEST_ID" String
"rpc.method" "PurgeQueue"
"rpc.system" "aws-api"
"rpc.service" "AmazonSQS"
"$HttpAttributes.HTTP_REQUEST_METHOD" "POST"
Expand Down
14 changes: 11 additions & 3 deletions instrumentation/aws-sdk/aws-sdk-1.11/javaagent/src/test/groovy/SnsTracingTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

import io.opentelemetry.instrumentation.test.AgentInstrumentationSpecification
import io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes
import io.opentelemetry.semconv.incubating.AwsIncubatingAttributes
import io.opentelemetry.semconv.ServerAttributes
import io.opentelemetry.semconv.HttpAttributes
import io.opentelemetry.semconv.NetworkAttributes
Expand Down Expand Up @@ -52,8 +53,9 @@ class SnsTracingTest extends AgentInstrumentationSpecification {
attributes {
"aws.agent" "java-aws-sdk"
"aws.endpoint" String
"rpc.method" "CreateQueue"
"aws.queue.name" queueName
"$AwsIncubatingAttributes.AWS_REQUEST_ID" String
"rpc.method" "CreateQueue"
"rpc.system" "aws-api"
"rpc.service" "AmazonSQS"
"$HttpAttributes.HTTP_REQUEST_METHOD" "POST"
Expand All @@ -74,8 +76,9 @@ class SnsTracingTest extends AgentInstrumentationSpecification {
attributes {
"aws.agent" "java-aws-sdk"
"aws.endpoint" String
"rpc.method" "GetQueueAttributes"
"aws.queue.url" queueUrl
"$AwsIncubatingAttributes.AWS_REQUEST_ID" String
"rpc.method" "GetQueueAttributes"
"rpc.system" "aws-api"
"rpc.service" "AmazonSQS"
"$HttpAttributes.HTTP_REQUEST_METHOD" "POST"
Expand All @@ -96,8 +99,9 @@ class SnsTracingTest extends AgentInstrumentationSpecification {
attributes {
"aws.agent" "java-aws-sdk"
"aws.endpoint" String
"rpc.method" "SetQueueAttributes"
"aws.queue.url" queueUrl
"$AwsIncubatingAttributes.AWS_REQUEST_ID" String
"rpc.method" "SetQueueAttributes"
"rpc.system" "aws-api"
"rpc.service" "AmazonSQS"
"$HttpAttributes.HTTP_REQUEST_METHOD" "POST"
Expand All @@ -118,6 +122,7 @@ class SnsTracingTest extends AgentInstrumentationSpecification {
attributes {
"aws.agent" "java-aws-sdk"
"aws.endpoint" String
"$AwsIncubatingAttributes.AWS_REQUEST_ID" String
"rpc.method" "CreateTopic"
"rpc.system" "aws-api"
"rpc.service" "AmazonSNS"
Expand All @@ -139,6 +144,7 @@ class SnsTracingTest extends AgentInstrumentationSpecification {
attributes {
"aws.agent" "java-aws-sdk"
"aws.endpoint" String
"$AwsIncubatingAttributes.AWS_REQUEST_ID" String
"rpc.method" "Subscribe"
"rpc.system" "aws-api"
"rpc.service" "AmazonSNS"
Expand All @@ -160,6 +166,7 @@ class SnsTracingTest extends AgentInstrumentationSpecification {
attributes {
"aws.agent" "java-aws-sdk"
"aws.endpoint" String
"$AwsIncubatingAttributes.AWS_REQUEST_ID" String
"rpc.method" "Publish"
"rpc.system" "aws-api"
"rpc.service" "AmazonSNS"
Expand All @@ -180,6 +187,7 @@ class SnsTracingTest extends AgentInstrumentationSpecification {
"aws.agent" "java-aws-sdk"
"aws.endpoint" String
"aws.queue.url" queueUrl
"$AwsIncubatingAttributes.AWS_REQUEST_ID" String
"rpc.system" "aws-api"
"rpc.service" "AmazonSQS"
"rpc.method" "ReceiveMessage"
Expand Down
1 change: 0 additions & 1 deletion ...rc/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/AwsExperimentalAttributes.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ final class AwsExperimentalAttributes {
static final AttributeKey<String> AWS_QUEUE_NAME = stringKey("aws.queue.name");
static final AttributeKey<String> AWS_STREAM_NAME = stringKey("aws.stream.name");
static final AttributeKey<String> AWS_TABLE_NAME = stringKey("aws.table.name");
static final AttributeKey<String> AWS_REQUEST_ID = stringKey("aws.requestId");

private AwsExperimentalAttributes() {}
}
66 changes: 66 additions & 0 deletions ...rc/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/AwsSdkAttributesExtractor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
/*
* Copyright The OpenTelemetry Authors
* SPDX-License-Identifier: Apache-2.0
*/

package io.opentelemetry.instrumentation.awssdk.v1_11;

import static io.opentelemetry.api.common.AttributeKey.stringKey;

import com.amazonaws.AmazonWebServiceResult;
import com.amazonaws.Request;
import com.amazonaws.Response;
import com.amazonaws.ResponseMetadata;
import io.opentelemetry.api.common.AttributeKey;
import io.opentelemetry.api.common.AttributesBuilder;
import io.opentelemetry.context.Context;
import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
import io.opentelemetry.javaagent.tooling.muzzle.NoMuzzle;
import javax.annotation.Nullable;

class AwsSdkAttributesExtractor implements AttributesExtractor<Request<?>, Response<?>> {
private static final boolean CAN_GET_RESPONSE_METADATA = canGetResponseMetadata();
private static final AttributeKey<String> AWS_REQUEST_ID = stringKey("aws.request_id");

// AmazonWebServiceResult is only available in v1.11.33 and later
private static boolean canGetResponseMetadata() {
try {
Class<?> clazz = Class.forName("com.amazonaws.AmazonWebServiceResult");
clazz.getMethod("getSdkResponseMetadata");
return true;
} catch (ClassNotFoundException | NoSuchMethodException exception) {
return false;
}
}

@Override
public void onStart(AttributesBuilder attributes, Context parentContext, Request<?> request) {}

@Override
public void onEnd(
AttributesBuilder attributes,
Context context,
Request<?> request,
@Nullable Response<?> response,
@Nullable Throwable error) {
ResponseMetadata responseMetadata = getResponseMetadata(response);

if (responseMetadata != null) {
String requestId = responseMetadata.getRequestId();
if (requestId != null) {
attributes.put(AWS_REQUEST_ID, requestId);
}
}
}

@NoMuzzle
private static ResponseMetadata getResponseMetadata(Response<?> response) {
if (CAN_GET_RESPONSE_METADATA
&& response != null
&& response.getAwsResponse() instanceof AmazonWebServiceResult) {
AmazonWebServiceResult<?> awsResp = (AmazonWebServiceResult<?>) response.getAwsResponse();
return awsResp.getSdkResponseMetadata();
}
return null;
}
}
12 changes: 1 addition & 11 deletions .../io/opentelemetry/instrumentation/awssdk/v1_11/AwsSdkExperimentalAttributesExtractor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,9 @@
import static io.opentelemetry.instrumentation.awssdk.v1_11.AwsExperimentalAttributes.AWS_ENDPOINT;
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_REQUEST_ID;
import static io.opentelemetry.instrumentation.awssdk.v1_11.AwsExperimentalAttributes.AWS_STREAM_NAME;
import static io.opentelemetry.instrumentation.awssdk.v1_11.AwsExperimentalAttributes.AWS_TABLE_NAME;

import com.amazonaws.AmazonWebServiceResponse;
import com.amazonaws.Request;
import com.amazonaws.Response;
import io.opentelemetry.api.common.AttributeKey;
Expand Down Expand Up @@ -58,13 +56,5 @@ public void onEnd(
Context context,
Request<?> request,
@Nullable Response<?> response,
@Nullable Throwable error) {
if (response != null && response.getAwsResponse() instanceof AmazonWebServiceResponse) {
AmazonWebServiceResponse<?> awsResp = (AmazonWebServiceResponse<?>) response.getAwsResponse();
String requestId = awsResp.getRequestId();
if (requestId != null) {
attributes.put(AWS_REQUEST_ID, requestId);
}
}
}
@Nullable Throwable error) {}
}
27 changes: 19 additions & 8 deletions ...rc/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/AwsSdkInstrumenterFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,18 +39,14 @@ final class AwsSdkInstrumenterFactory {
RpcClientAttributesExtractor.create(AwsSdkRpcAttributesGetter.INSTANCE);
private static final AwsSdkExperimentalAttributesExtractor experimentalAttributesExtractor =
new AwsSdkExperimentalAttributesExtractor();
private static final AwsSdkAttributesExtractor sdkAttributesExtractor =
new AwsSdkAttributesExtractor();
private static final SnsAttributesExtractor snsAttributesExtractor = new SnsAttributesExtractor();

private static final List<AttributesExtractor<Request<?>, Response<?>>>
defaultAttributesExtractors =
Arrays.asList(httpAttributesExtractor, rpcAttributesExtractor, snsAttributesExtractor);
defaultAttributesExtractors = createAttributesExtractors(false);
private static final List<AttributesExtractor<Request<?>, Response<?>>>
extendedAttributesExtractors =
Arrays.asList(
httpAttributesExtractor,
rpcAttributesExtractor,
snsAttributesExtractor,
experimentalAttributesExtractor);
extendedAttributesExtractors = createAttributesExtractors(true);
private static final AwsSdkSpanNameExtractor spanName = new AwsSdkSpanNameExtractor();

private final OpenTelemetry openTelemetry;
Expand All @@ -69,6 +65,21 @@ final class AwsSdkInstrumenterFactory {
this.messagingReceiveInstrumentationEnabled = messagingReceiveInstrumentationEnabled;
}

private static List<AttributesExtractor<Request<?>, Response<?>>> createAttributesExtractors(
boolean includeExperimental) {
List<AttributesExtractor<Request<?>, Response<?>>> extractors =
new ArrayList<>(
Arrays.asList(
httpAttributesExtractor,
rpcAttributesExtractor,
snsAttributesExtractor,
sdkAttributesExtractor));
if (includeExperimental) {
extractors.add(experimentalAttributesExtractor);
}
return extractors;
}

Instrumenter<Request<?>, Response<?>> requestInstrumenter() {
return createInstrumenter(
openTelemetry,
Expand Down
4 changes: 4 additions & 0 deletions ...c/main/groovy/io/opentelemetry/instrumentation/awssdk/v1_11/AbstractAws1ClientTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ import io.opentelemetry.api.trace.Span
import io.opentelemetry.instrumentation.test.InstrumentationSpecification
import io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes
import io.opentelemetry.semconv.incubating.RpcIncubatingAttributes
import io.opentelemetry.semconv.incubating.AwsIncubatingAttributes
import io.opentelemetry.semconv.ServerAttributes
import io.opentelemetry.semconv.ErrorAttributes
import io.opentelemetry.semconv.HttpAttributes
Expand Down Expand Up @@ -103,6 +104,8 @@ abstract class AbstractAws1ClientTest extends InstrumentationSpecification {
client.requestHandler2s != null
client.requestHandler2s.find { it.getClass().getSimpleName() == "TracingRequestHandler" } != null

def hasRequestId = service in ["SNS", "RDS", "EC2"]

assertTraces(1) {
trace(0, 1) {
span(0) {
Expand All @@ -121,6 +124,7 @@ abstract class AbstractAws1ClientTest extends InstrumentationSpecification {
"$RpcIncubatingAttributes.RPC_METHOD" "${operation}"
"aws.endpoint" "${server.httpUri()}"
"aws.agent" "java-aws-sdk"
"$AwsIncubatingAttributes.AWS_REQUEST_ID" hasRequestId ? String : null
for (def addedTag : additionalAttributes) {
"$addedTag.key" "$addedTag.value"
}
Expand Down
Loading
Loading