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 1 commit
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
2 changes: 1 addition & 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,7 @@ 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");
static final AttributeKey<String> AWS_REQUEST_ID = stringKey("aws.request_id");

private AwsExperimentalAttributes() {}
}
3 changes: 2 additions & 1 deletion ...c/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/TracingExecutionInterceptor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -362,7 +362,8 @@ private void onSdkResponse(
Span span, SdkResponse response, ExecutionAttributes executionAttributes) {
if (captureExperimentalSpanAttributes) {
if (response instanceof AwsResponse) {
span.setAttribute("aws.requestId", ((AwsResponse) response).responseMetadata().requestId());
span.setAttribute(
"aws.request_id", ((AwsResponse) response).responseMetadata().requestId());
}
AwsSdkRequest sdkRequest = executionAttributes.getAttribute(AWS_SDK_REQUEST_ATTRIBUTE);
if (sdkRequest != null) {
Expand Down
6 changes: 3 additions & 3 deletions ...ain/groovy/io/opentelemetry/instrumentation/awssdk/v2_2/AbstractAws2ClientCoreTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ abstract class AbstractAws2ClientCoreTest extends InstrumentationSpecification {
"$RpcIncubatingAttributes.RPC_SERVICE" "DynamoDb"
"$RpcIncubatingAttributes.RPC_METHOD" "CreateTable"
"aws.agent" "java-aws-sdk"
"aws.requestId" "$requestId"
"aws.request_id" "$requestId"
"aws.table.name" "sometable"
"$DbIncubatingAttributes.DB_SYSTEM" "dynamodb"
"$DbIncubatingAttributes.DB_OPERATION" "CreateTable"
Expand Down Expand Up @@ -179,7 +179,7 @@ abstract class AbstractAws2ClientCoreTest extends InstrumentationSpecification {
"$RpcIncubatingAttributes.RPC_SERVICE" "DynamoDb"
"$RpcIncubatingAttributes.RPC_METHOD" "Query"
"aws.agent" "java-aws-sdk"
"aws.requestId" "$requestId"
"aws.request_id" "$requestId"
"aws.table.name" "sometable"
"$DbIncubatingAttributes.DB_SYSTEM" "dynamodb"
"$DbIncubatingAttributes.DB_OPERATION" "Query"
Expand Down Expand Up @@ -211,7 +211,7 @@ abstract class AbstractAws2ClientCoreTest extends InstrumentationSpecification {
"$RpcIncubatingAttributes.RPC_SERVICE" "$service"
"$RpcIncubatingAttributes.RPC_METHOD" "${operation}"
"aws.agent" "java-aws-sdk"
"aws.requestId" "$requestId"
"aws.request_id" "$requestId"
"aws.table.name" "sometable"
"$DbIncubatingAttributes.DB_SYSTEM" "dynamodb"
"$DbIncubatingAttributes.DB_OPERATION" "${operation}"
Expand Down
4 changes: 2 additions & 2 deletions ...rc/main/groovy/io/opentelemetry/instrumentation/awssdk/v2_2/AbstractAws2ClientTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ abstract class AbstractAws2ClientTest extends AbstractAws2ClientCoreTest {
"$RpcIncubatingAttributes.RPC_SERVICE" "$service"
"$RpcIncubatingAttributes.RPC_METHOD" "${operation}"
"aws.agent" "java-aws-sdk"
"aws.requestId" "$requestId"
"aws.request_id" "$requestId"
if (service == "S3") {
"aws.bucket.name" "somebucket"
} else if (service == "Sqs" && operation == "CreateQueue") {
Expand Down Expand Up @@ -295,7 +295,7 @@ abstract class AbstractAws2ClientTest extends AbstractAws2ClientCoreTest {
"$RpcIncubatingAttributes.RPC_SERVICE" "$service"
"$RpcIncubatingAttributes.RPC_METHOD" "${operation}"
"aws.agent" "java-aws-sdk"
"aws.requestId" "$requestId"
"aws.request_id" "$requestId"
if (service == "S3") {
"aws.bucket.name" "somebucket"
} else if (service == "Sqs" && operation == "CreateQueue") {
Expand Down
8 changes: 4 additions & 4 deletions .../opentelemetry/instrumentation/awssdk/v2_2/AbstractAws2SqsSuppressReceiveSpansTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ abstract class AbstractAws2SqsSuppressReceiveSpansTest extends InstrumentationSp
attributes {
"aws.agent" "java-aws-sdk"
"aws.queue.name" "testSdkSqs"
"aws.requestId" { it == "00000000-0000-0000-0000-000000000000" || it == "UNKNOWN" }
"aws.request_id" { it == "00000000-0000-0000-0000-000000000000" || it == "UNKNOWN" }
"rpc.system" "aws-api"
"rpc.service" "Sqs"
"rpc.method" "CreateQueue"
Expand All @@ -148,7 +148,7 @@ abstract class AbstractAws2SqsSuppressReceiveSpansTest extends InstrumentationSp
attributes {
"aws.agent" "java-aws-sdk"
"aws.queue.url" "http://localhost:$sqsPort/000000000000/testSdkSqs"
"aws.requestId" { it == "00000000-0000-0000-0000-000000000000" || it == "UNKNOWN" }
"aws.request_id" { it == "00000000-0000-0000-0000-000000000000" || it == "UNKNOWN" }
"rpc.system" "aws-api"
"rpc.method" "SendMessage"
"rpc.service" "Sqs"
Expand Down Expand Up @@ -208,7 +208,7 @@ abstract class AbstractAws2SqsSuppressReceiveSpansTest extends InstrumentationSp
hasNoLinks()
attributes {
"aws.agent" "java-aws-sdk"
"aws.requestId" { it == "00000000-0000-0000-0000-000000000000" || it == "UNKNOWN" }
"aws.request_id" { it == "00000000-0000-0000-0000-000000000000" || it == "UNKNOWN" }
"rpc.method" "ReceiveMessage"
"aws.queue.url" "http://localhost:$sqsPort/000000000000/testSdkSqs"
"rpc.system" "aws-api"
Expand Down Expand Up @@ -320,7 +320,7 @@ abstract class AbstractAws2SqsSuppressReceiveSpansTest extends InstrumentationSp
attributes {
"aws.agent" "java-aws-sdk"
"aws.queue.url" "http://localhost:$sqsPort/000000000000/testSdkSqs"
"aws.requestId" { it.trim() == "00000000-0000-0000-0000-000000000000" || it == "UNKNOWN" }
"aws.request_id" { it.trim() == "00000000-0000-0000-0000-000000000000" || it == "UNKNOWN" }
"rpc.system" "aws-api"
"rpc.method" "SendMessageBatch"
"rpc.service" "Sqs"
Expand Down
86 changes: 42 additions & 44 deletions ...a/io/opentelemetry/instrumentation/awssdk/v2_2/AbstractAws2ClientRecordHttpErrorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,50 +156,48 @@ public void testSendDynamoDbRequestWithRetries() {

getTesting()
.waitAndAssertTraces(
trace -> {
trace.hasSpansSatisfyingExactly(
span -> {
span.hasKind(SpanKind.CLIENT);
span.hasNoParent();
span.hasAttributesSatisfying(
attributes -> {
assertThat(attributes)
.containsEntry(ServerAttributes.SERVER_ADDRESS, "127.0.0.1")
.containsEntry(ServerAttributes.SERVER_PORT, server.httpPort())
.containsEntry(HttpAttributes.HTTP_REQUEST_METHOD, method)
.containsEntry(HttpAttributes.HTTP_RESPONSE_STATUS_CODE, 200)
.containsEntry(RpcIncubatingAttributes.RPC_SYSTEM, "aws-api")
.containsEntry(RpcIncubatingAttributes.RPC_SERVICE, service)
.containsEntry(RpcIncubatingAttributes.RPC_METHOD, operation)
.containsEntry("aws.agent", "java-aws-sdk")
.containsEntry("aws.requestId", requestId)
.containsEntry("aws.table.name", "sometable")
.containsEntry(DbIncubatingAttributes.DB_SYSTEM, "dynamodb")
.containsEntry(DbIncubatingAttributes.DB_OPERATION, operation);
});
if (isRecordIndividualHttpErrorEnabled()) {
span.hasEventsSatisfyingExactly(
event ->
event
.hasName("HTTP request failure")
.hasAttributesSatisfyingExactly(
equalTo(HttpAttributes.HTTP_RESPONSE_STATUS_CODE, 500),
equalTo(
AttributeKey.stringKey("aws.http.error_message"),
"DynamoDB could not process your request")),
event ->
event
.hasName("HTTP request failure")
.hasAttributesSatisfyingExactly(
equalTo(HttpAttributes.HTTP_RESPONSE_STATUS_CODE, 503),
equalTo(
AttributeKey.stringKey("aws.http.error_message"),
"DynamoDB is currently unavailable")));
} else {
span.hasEventsSatisfying(events -> assertThat(events.size()).isEqualTo(0));
}
});
});
trace ->
trace.hasSpansSatisfyingExactly(
span -> {
span.hasKind(SpanKind.CLIENT);
span.hasNoParent();
span.hasAttributesSatisfying(
attributes ->
assertThat(attributes)
.containsEntry(ServerAttributes.SERVER_ADDRESS, "127.0.0.1")
.containsEntry(ServerAttributes.SERVER_PORT, server.httpPort())
.containsEntry(HttpAttributes.HTTP_REQUEST_METHOD, method)
.containsEntry(HttpAttributes.HTTP_RESPONSE_STATUS_CODE, 200)
.containsEntry(RpcIncubatingAttributes.RPC_SYSTEM, "aws-api")
.containsEntry(RpcIncubatingAttributes.RPC_SERVICE, service)
.containsEntry(RpcIncubatingAttributes.RPC_METHOD, operation)
.containsEntry("aws.agent", "java-aws-sdk")
.containsEntry("aws.request_id", requestId)
.containsEntry("aws.table.name", "sometable")
.containsEntry(DbIncubatingAttributes.DB_SYSTEM, "dynamodb")
.containsEntry(DbIncubatingAttributes.DB_OPERATION, operation));
if (isRecordIndividualHttpErrorEnabled()) {
span.hasEventsSatisfyingExactly(
event ->
event
.hasName("HTTP request failure")
.hasAttributesSatisfyingExactly(
equalTo(HttpAttributes.HTTP_RESPONSE_STATUS_CODE, 500),
equalTo(
AttributeKey.stringKey("aws.http.error_message"),
"DynamoDB could not process your request")),
event ->
event
.hasName("HTTP request failure")
.hasAttributesSatisfyingExactly(
equalTo(HttpAttributes.HTTP_RESPONSE_STATUS_CODE, 503),
equalTo(
AttributeKey.stringKey("aws.http.error_message"),
"DynamoDB is currently unavailable")));
} else {
span.hasEventsSatisfying(events -> assertThat(events.size()).isEqualTo(0));
}
}));

// make sure the response body input stream is still available and check its content to be
// expected
Expand Down
8 changes: 4 additions & 4 deletions ...rc/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/AbstractAws2SqsTracingTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ void assertSqsTraces(Boolean withParent, Boolean captureHeaders) {
equalTo(stringKey("aws.agent"), "java-aws-sdk"),
equalTo(stringKey("aws.queue.name"), "testSdkSqs"),
satisfies(
stringKey("aws.requestId"),
stringKey("aws.request_id"),
val ->
val.satisfiesAnyOf(
v ->
Expand Down Expand Up @@ -196,7 +196,7 @@ void assertSqsTraces(Boolean withParent, Boolean captureHeaders) {
stringKey("aws.queue.url"),
"http://localhost:" + sqsPort + "/000000000000/testSdkSqs"),
satisfies(
stringKey("aws.requestId"),
stringKey("aws.request_id"),
val ->
val.satisfiesAnyOf(
v ->
Expand Down Expand Up @@ -260,7 +260,7 @@ void assertSqsTraces(Boolean withParent, Boolean captureHeaders) {
stringKey("aws.queue.url"),
"http://localhost:" + sqsPort + "/000000000000/testSdkSqs"),
satisfies(
stringKey("aws.requestId"),
stringKey("aws.request_id"),
val ->
val.satisfiesAnyOf(
v ->
Expand Down Expand Up @@ -507,7 +507,7 @@ void testBatchSqsProducerConsumerServicesSync() throws URISyntaxException {
stringKey("aws.queue.url"),
"http://localhost:" + sqsPort + "/000000000000/testSdkSqs"),
satisfies(
stringKey("aws.requestId"),
stringKey("aws.request_id"),
val ->
val.satisfiesAnyOf(
v ->
Expand Down
Loading