Skip to content

Emit AWS SDK exceptions as logs under the opt-in preview #18894

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
laurit merged 3 commits into from
Jun 10, 2026
+107 −25
Merged

Emit AWS SDK exceptions as logs under the opt-in preview #18894

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b8aad6c
Add AWS SDK exception event extractor wiring
trask Jun 3, 2026
6fc3a9b
Address review comment: test AWS SDK v2 exception logs
trask Jun 9, 2026
fee0b32
Address review comment: test AWS SDK v1 exception logs
trask Jun 9, 2026
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
8 changes: 7 additions & 1 deletion instrumentation/aws-sdk/aws-sdk-1.11/library/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,13 @@ tasks {
jvmArgs("-Dotel.semconv-stability.opt-in=database")
}

val testExceptionSignalLogs by registering(Test::class) {
testClassesDirs = sourceSets.test.get().output.classesDirs
classpath = sourceSets.test.get().runtimeClasspath
jvmArgs("-Dotel.semconv.exception.signal.preview=logs")
}

check {
dependsOn(testing.suites, testStableSemconv)
dependsOn(testing.suites, testStableSemconv, testExceptionSignalLogs)
}
}
27 changes: 20 additions & 7 deletions ...ava/io/opentelemetry/instrumentation/awssdk/v1_11/internal/AwsSdkInstrumenterFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,12 @@

package io.opentelemetry.instrumentation.awssdk.v1_11.internal;

import static io.opentelemetry.instrumentation.api.incubator.semconv.db.internal.DbExceptionEventExtractors.setDbClientExceptionEventExtractor;
import static io.opentelemetry.instrumentation.api.incubator.semconv.messaging.internal.MessagingExceptionEventExtractors.setMessagingProcessExceptionEventExtractor;
import static io.opentelemetry.instrumentation.api.incubator.semconv.messaging.internal.MessagingExceptionEventExtractors.setMessagingReceiveExceptionEventExtractor;
import static io.opentelemetry.instrumentation.api.incubator.semconv.messaging.internal.MessagingExceptionEventExtractors.setMessagingSendExceptionEventExtractor;
import static io.opentelemetry.instrumentation.api.incubator.semconv.rpc.internal.RpcExceptionEventExtractors.setRpcClientExceptionEventExtractor;
import static java.util.Arrays.asList;
import static java.util.Collections.emptyList;
import static java.util.Collections.singletonList;

import com.amazonaws.Request;
Expand Down Expand Up @@ -81,7 +85,7 @@ public Instrumenter<Request<?>, Response<?>> requestInstrumenter() {
new AwsSdkSpanNameExtractor(),
SpanKindExtractor.alwaysClient(),
attributesExtractors(),
emptyList(),
builder -> setRpcClientExceptionEventExtractor(builder),
Comment thread
trask marked this conversation as resolved.
true);
}

Expand Down Expand Up @@ -110,6 +114,7 @@ public Instrumenter<SqsReceiveRequest, Response<?>> consumerReceiveInstrumenter(
SpanKindExtractor.alwaysConsumer(),
toSqsRequestExtractors(attributesExtractors()),
singletonList(messagingAttributeExtractor),
builder -> setMessagingReceiveExceptionEventExtractor(builder),
messagingReceiveInstrumentationEnabled);
}

Expand All @@ -126,6 +131,7 @@ public Instrumenter<SqsProcessRequest, Response<?>> consumerProcessInstrumenter(
MessagingSpanNameExtractor.create(getter, operation))
.addAttributesExtractors(toSqsRequestExtractors(attributesExtractors()))
.addAttributesExtractor(messagingAttributeExtractor);
setMessagingProcessExceptionEventExtractor(builder);

if (messagingReceiveInstrumentationEnabled) {
builder.addSpanLinksExtractor(
Expand Down Expand Up @@ -178,6 +184,7 @@ public Instrumenter<Request<?>, Response<?>> producerInstrumenter() {
SpanKindExtractor.alwaysProducer(),
attributesExtractors(),
singletonList(messagingAttributeExtractor),
builder -> setMessagingSendExceptionEventExtractor(builder),
true);
}

Expand All @@ -187,10 +194,12 @@ public Instrumenter<Request<?>, Response<?>> dynamoDbInstrumenter() {
new AwsSdkSpanNameExtractor(),
SpanKindExtractor.alwaysClient(),
attributesExtractors(),
builder ->
builder
.addAttributesExtractor(new DynamoDbAttributesExtractor())
.addOperationMetrics(DbClientMetrics.get()),
builder -> {
builder
.addAttributesExtractor(new DynamoDbAttributesExtractor())
.addOperationMetrics(DbClientMetrics.get());
setDbClientExceptionEventExtractor(builder);
},
true);
}

Expand All @@ -200,13 +209,17 @@ private static <REQUEST, RESPONSE> Instrumenter<REQUEST, RESPONSE> createInstrum
SpanKindExtractor<REQUEST> spanKindExtractor,
List<? extends AttributesExtractor<? super REQUEST, ? super RESPONSE>> attributeExtractors,
List<AttributesExtractor<REQUEST, RESPONSE>> additionalAttributeExtractors,
Consumer<InstrumenterBuilder<REQUEST, RESPONSE>> exceptionEventCustomizer,
boolean enabled) {
return createInstrumenter(
openTelemetry,
spanNameExtractor,
spanKindExtractor,
attributeExtractors,
builder -> builder.addAttributesExtractors(additionalAttributeExtractors),
builder -> {
builder.addAttributesExtractors(additionalAttributeExtractors);
exceptionEventCustomizer.accept(builder);
},
enabled);
}

Expand Down
34 changes: 30 additions & 4 deletions ...ing/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/AbstractS3ClientTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

import static io.opentelemetry.api.common.AttributeKey.stringKey;
import static io.opentelemetry.api.trace.SpanKind.CLIENT;
import static io.opentelemetry.instrumentation.api.internal.SemconvExceptionSignal.emitExceptionAsLogs;
import static io.opentelemetry.instrumentation.api.internal.SemconvExceptionSignal.emitExceptionAsSpanEvents;
import static io.opentelemetry.instrumentation.test.utils.PortUtils.UNUSABLE_PORT;
import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.equalTo;
import static io.opentelemetry.semconv.ErrorAttributes.ERROR_TYPE;
Expand All @@ -29,6 +31,7 @@
import com.amazonaws.retry.PredefinedRetryPolicies;
import com.amazonaws.services.s3.AmazonS3;
import com.amazonaws.services.s3.AmazonS3ClientBuilder;
import io.opentelemetry.api.logs.Severity;
import io.opentelemetry.api.trace.Span;
import io.opentelemetry.sdk.testing.assertj.AttributeAssertion;
import io.opentelemetry.sdk.trace.data.StatusData;
Expand Down Expand Up @@ -120,7 +123,7 @@ void testSendRequestToClosedPort() {
span.hasName("S3.GetObject")
.hasKind(CLIENT)
.hasStatus(StatusData.error())
.hasException(caught)
.hasException(emitExceptionAsSpanEvents() ? caught : null)
.hasNoParent()
.hasAttributesSatisfyingExactly(
equalTo(URL_FULL, "http://127.0.0.1:" + UNUSABLE_PORT),
Expand All @@ -133,6 +136,17 @@ void testSendRequestToClosedPort() {
equalTo(stringKey("aws.agent"), "java-aws-sdk"),
equalTo(AWS_S3_BUCKET, "someBucket"),
equalTo(ERROR_TYPE, SdkClientException.class.getName()))));

if (emitExceptionAsLogs()) {
testing()
.waitAndAssertLogRecords(
logRecord ->
logRecord
.hasSeverity(Severity.WARN)
.hasEventName("rpc.client.call.exception")
.hasException(caught)
.hasTotalAttributeCount(3));
}
}

@Test
Expand All @@ -154,6 +168,9 @@ void testTimeoutAndRetryErrorsNotCaptured() {
Throwable caught = catchThrowable(() -> client.getObject("someBucket", "someKey"));
assertThat(caught).isInstanceOf(AmazonClientException.class);
assertThat(Span.current().getSpanContext().isValid()).isFalse();
SdkClientException error =
new SdkClientException(
"Unable to execute HTTP request: Request did not complete before the request timeout configuration.");

testing()
.waitAndAssertTraces(
Expand All @@ -164,9 +181,7 @@ void testTimeoutAndRetryErrorsNotCaptured() {
.hasKind(CLIENT)
.hasStatus(StatusData.error())
.hasNoParent()
.hasException(
new SdkClientException(
"Unable to execute HTTP request: Request did not complete before the request timeout configuration."))
.hasException(emitExceptionAsSpanEvents() ? error : null)
.hasAttributesSatisfyingExactly(
equalTo(URL_FULL, server.httpUri().toString()),
equalTo(HTTP_REQUEST_METHOD, "GET"),
Expand All @@ -178,5 +193,16 @@ void testTimeoutAndRetryErrorsNotCaptured() {
equalTo(stringKey("aws.agent"), "java-aws-sdk"),
equalTo(AWS_S3_BUCKET, "someBucket"),
equalTo(ERROR_TYPE, SdkClientException.class.getName()))));

if (emitExceptionAsLogs()) {
testing()
.waitAndAssertLogRecords(
logRecord ->
logRecord
.hasSeverity(Severity.WARN)
.hasEventName("rpc.client.call.exception")
.hasException(error)
.hasTotalAttributeCount(3));
}
}
}
9 changes: 8 additions & 1 deletion instrumentation/aws-sdk/aws-sdk-2.2/library/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,14 @@ tasks {
jvmArgs("-Dotel.semconv-stability.opt-in=database")
}

val testExceptionSignalLogs by registering(Test::class) {
testClassesDirs = sourceSets.test.get().output.classesDirs
classpath = sourceSets.test.get().runtimeClasspath

jvmArgs("-Dotel.semconv.exception.signal.preview=logs")
}

check {
dependsOn(testing.suites, testStableSemconv)
dependsOn(testing.suites, testStableSemconv, testExceptionSignalLogs)
}
}
38 changes: 27 additions & 11 deletions ...java/io/opentelemetry/instrumentation/awssdk/v2_2/internal/AwsSdkInstrumenterFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,13 @@

package io.opentelemetry.instrumentation.awssdk.v2_2.internal;

import static io.opentelemetry.instrumentation.api.incubator.semconv.db.internal.DbExceptionEventExtractors.setDbClientExceptionEventExtractor;
import static io.opentelemetry.instrumentation.api.incubator.semconv.genai.internal.GenAiExceptionEventExtractors.setGenAiClientExceptionEventExtractor;
import static io.opentelemetry.instrumentation.api.incubator.semconv.messaging.internal.MessagingExceptionEventExtractors.setMessagingProcessExceptionEventExtractor;
import static io.opentelemetry.instrumentation.api.incubator.semconv.messaging.internal.MessagingExceptionEventExtractors.setMessagingReceiveExceptionEventExtractor;
import static io.opentelemetry.instrumentation.api.incubator.semconv.messaging.internal.MessagingExceptionEventExtractors.setMessagingSendExceptionEventExtractor;
import static io.opentelemetry.instrumentation.api.incubator.semconv.rpc.internal.RpcExceptionEventExtractors.setRpcClientExceptionEventExtractor;
import static java.util.Arrays.asList;
import static java.util.Collections.emptyList;
import static java.util.Collections.singletonList;

import io.opentelemetry.api.OpenTelemetry;
Expand Down Expand Up @@ -103,7 +108,7 @@ public Instrumenter<ExecutionAttributes, Response> requestInstrumenter() {
AwsSdkInstrumenterFactory::spanName,
SpanKindExtractor.alwaysClient(),
attributesExtractors(),
emptyList(),
builder -> setRpcClientExceptionEventExtractor(builder),
Comment thread
trask marked this conversation as resolved.
true);
}

Expand Down Expand Up @@ -138,6 +143,7 @@ public Instrumenter<SqsReceiveRequest, Response> consumerReceiveInstrumenter() {
SpanKindExtractor.alwaysConsumer(),
toSqsRequestExtractors(consumerAttributesExtractors()),
singletonList(messagingAttributeExtractor),
builder -> setMessagingReceiveExceptionEventExtractor(builder),
messagingReceiveInstrumentationEnabled);
}

Expand All @@ -152,6 +158,7 @@ public Instrumenter<SqsProcessRequest, Response> consumerProcessInstrumenter() {
MessagingSpanNameExtractor.create(getter, operation))
.addAttributesExtractors(toSqsRequestExtractors(consumerAttributesExtractors()))
.addAttributesExtractor(messagingAttributesExtractor(getter, operation));
setMessagingProcessExceptionEventExtractor(builder);

if (messagingReceiveInstrumentationEnabled) {
builder.addSpanLinksExtractor(
Expand Down Expand Up @@ -205,6 +212,7 @@ public Instrumenter<ExecutionAttributes, Response> producerInstrumenter() {
SpanKindExtractor.alwaysProducer(),
attributesExtractors(),
singletonList(messagingAttributeExtractor),
builder -> setMessagingSendExceptionEventExtractor(builder),
true);
}

Expand All @@ -214,10 +222,12 @@ public Instrumenter<ExecutionAttributes, Response> dynamoDbInstrumenter() {
AwsSdkInstrumenterFactory::spanName,
SpanKindExtractor.alwaysClient(),
attributesExtractors(),
builder ->
builder
.addAttributesExtractor(new DynamoDbAttributesExtractor())
.addOperationMetrics(DbClientMetrics.get()),
builder -> {
builder
.addAttributesExtractor(new DynamoDbAttributesExtractor())
.addOperationMetrics(DbClientMetrics.get());
setDbClientExceptionEventExtractor(builder);
},
true);
}

Expand All @@ -228,10 +238,12 @@ public Instrumenter<ExecutionAttributes, Response> bedrockRuntimeInstrumenter()
GenAiSpanNameExtractor.create(getter),
SpanKindExtractor.alwaysClient(),
attributesExtractors(),
builder ->
builder
.addAttributesExtractor(GenAiAttributesExtractor.create(getter))
.addOperationMetrics(GenAiClientMetrics.get()),
builder -> {
builder
.addAttributesExtractor(GenAiAttributesExtractor.create(getter))
.addOperationMetrics(GenAiClientMetrics.get());
setGenAiClientExceptionEventExtractor(builder);
},
true);
}

Expand All @@ -245,14 +257,18 @@ private static <REQUEST, RESPONSE> Instrumenter<REQUEST, RESPONSE> createInstrum
SpanKindExtractor<REQUEST> spanKindExtractor,
List<? extends AttributesExtractor<? super REQUEST, ? super RESPONSE>> attributeExtractors,
List<AttributesExtractor<REQUEST, RESPONSE>> additionalAttributeExtractors,
Consumer<InstrumenterBuilder<REQUEST, RESPONSE>> exceptionEventCustomizer,
boolean enabled) {

return createInstrumenter(
openTelemetry,
spanNameExtractor,
spanKindExtractor,
attributeExtractors,
builder -> builder.addAttributesExtractors(additionalAttributeExtractors),
builder -> {
builder.addAttributesExtractors(additionalAttributeExtractors);
exceptionEventCustomizer.accept(builder);
},
enabled);
}

Expand Down
16 changes: 15 additions & 1 deletion ...ng/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/AbstractAws2ClientTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
package io.opentelemetry.instrumentation.awssdk.v2_2;

import static io.opentelemetry.api.common.AttributeKey.stringKey;
import static io.opentelemetry.instrumentation.api.internal.SemconvExceptionSignal.emitExceptionAsLogs;
import static io.opentelemetry.instrumentation.api.internal.SemconvExceptionSignal.emitExceptionAsSpanEvents;
import static io.opentelemetry.instrumentation.testing.util.TestLatestDeps.testLatestDeps;
import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.equalTo;
import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.satisfies;
Expand Down Expand Up @@ -37,6 +39,7 @@
import static org.assertj.core.api.Assertions.assertThatThrownBy;
import static org.assertj.core.api.Assertions.catchThrowable;

import io.opentelemetry.api.logs.Severity;
import io.opentelemetry.api.trace.SpanKind;
import io.opentelemetry.context.Context;
import io.opentelemetry.sdk.testing.assertj.AttributeAssertion;
Expand Down Expand Up @@ -891,7 +894,7 @@ void testTimeoutAndRetryErrorsAreNotCaptured() {
span.hasName("S3.GetObject")
.hasKind(SpanKind.CLIENT)
.hasStatus(StatusData.error())
.hasException(thrown)
.hasException(emitExceptionAsSpanEvents() ? thrown : null)
.hasNoParent()
.hasAttributesSatisfyingExactly(
// Starting with AWS SDK V2 2.18.0, the s3 sdk will prefix the
Expand Down Expand Up @@ -920,6 +923,17 @@ void testTimeoutAndRetryErrorsAreNotCaptured() {
equalTo(RPC_METHOD, "GetObject"),
equalTo(stringKey("aws.agent"), "java-aws-sdk"),
equalTo(AWS_S3_BUCKET, "somebucket"))));

if (emitExceptionAsLogs()) {
getTesting()
.waitAndAssertLogRecords(
logRecord ->
logRecord
.hasSeverity(Severity.WARN)
.hasEventName("rpc.client.call.exception")
.hasException(thrown)
.hasTotalAttributeCount(3));
}
}

// regression test for
Expand Down
Loading