Skip to content

fix: Add error attributes to logging #12685

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
blakeli0 merged 12 commits into from
Apr 6, 2026
Merged

fix: Add error attributes to logging #12685

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
86b9e94
fix: update observability attributes and tests
blakeli0 Apr 3, 2026
04bcc1f
fix: format
blakeli0 Apr 3, 2026
a062871
fix: format
blakeli0 Apr 3, 2026
944d05c
fix: fix typo
blakeli0 Apr 3, 2026
f33bbdd
fix: rename
blakeli0 Apr 4, 2026
7d35ea9
fix: rename
blakeli0 Apr 4, 2026
0148485
feat: Enhance LoggingTracer with exception details and reuse getRespo…
blakeli0 Apr 6, 2026
8426daf
Merge branch 'main' into fix-logging-tracer-exception-details
blakeli0 Apr 6, 2026
c36d985
fix: format
blakeli0 Apr 6, 2026
7ef71c2
fix: make extractErrorType nonnull
blakeli0 Apr 6, 2026
31f8c9a
feat: Use EXCEPTION_MESSAGE_ATTRIBUTE and clean up LoggingTracer
blakeli0 Apr 6, 2026
381405a
test: Remove redundant assertTrue assertions in LoggingTracerTest
blakeli0 Apr 6, 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
11 changes: 5 additions & 6 deletions sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/LoggingTracer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,16 +77,15 @@ void recordActionableError(Throwable error) {
}

Map<String, Object> logContext = new HashMap<>(apiTracerContext.getAttemptAttributes());
logContext.putAll(
ObservabilityUtils.getResponseAttributes(error, apiTracerContext.transport()));

logContext.put(
ObservabilityAttributes.RPC_RESPONSE_STATUS_ATTRIBUTE,
ObservabilityUtils.extractStatus(error).toString());
if (error != null && error.getMessage() != null) {
Comment thread
blakeli0 marked this conversation as resolved.
Outdated
logContext.put("exception.message", error.getMessage());
}

ErrorInfo errorInfo = ObservabilityUtils.extractErrorInfo(error);
if (errorInfo != null) {
if (errorInfo.getReason() != null && !errorInfo.getReason().isEmpty()) {
logContext.put(ObservabilityAttributes.ERROR_TYPE_ATTRIBUTE, errorInfo.getReason());
}
if (errorInfo.getDomain() != null && !errorInfo.getDomain().isEmpty()) {
logContext.put(ObservabilityAttributes.ERROR_DOMAIN_ATTRIBUTE, errorInfo.getDomain());
}
Expand Down
41 changes: 41 additions & 0 deletions ...latform-java/gax-java/gax/src/test/java/com/google/api/gax/tracing/LoggingTracerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,47 @@ void testRecordActionableError_logsErrorInfo() {
attributesMap.get(ObservabilityAttributes.ERROR_METADATA_ATTRIBUTE_PREFIX + "test_key"));
}

@Test
void testRecordActionableError_logsExceptionDetails() {
ApiTracerContext context = ApiTracerContext.empty();
LoggingTracer tracer = new LoggingTracer(context);

Exception error = new RuntimeException("test error message");
tracer.recordActionableError(error);

Map<String, ?> attributesMap = getAttributesMap();

assertTrue(attributesMap != null && !attributesMap.isEmpty());
Copy link
Copy Markdown
Member

@lqiu96 lqiu96 Apr 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Can this be broken into two assert: assertNotNull(attributeMap) and assertFalse(attributeMaps.isEmpty()).

IIRC, the error message for assertTrue isn't as clear when indicating which condition failed

Copy link
Copy Markdown
Contributor Author

@blakeli0 blakeli0 Apr 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed. I was following the existing pattern but I don't think these assertions are needed anymore. Because attributeMap can never be null and we are already asserting a key later so not empty is also not necessary.
Removed this assertion altogether.

assertEquals(
"java.lang.RuntimeException",
attributesMap.get(ObservabilityAttributes.EXCEPTION_TYPE_ATTRIBUTE));
assertEquals("test error message", attributesMap.get("exception.message"));
}

@Test
void testRecordActionableError_logsHttpStatus() {
ApiTracerContext context =
ApiTracerContext.empty().toBuilder().setTransport(ApiTracerContext.Transport.HTTP).build();
LoggingTracer tracer = new LoggingTracer(context);

Exception error =
ApiExceptionFactory.createException(
"test error message",
new RuntimeException("cause"),
FakeStatusCode.of(StatusCode.Code.INVALID_ARGUMENT),
false);

tracer.recordActionableError(error);

Map<String, ?> attributesMap = getAttributesMap();

assertTrue(attributesMap != null && !attributesMap.isEmpty());
assertEquals(
"INVALID_ARGUMENT",
attributesMap.get(ObservabilityAttributes.RPC_RESPONSE_STATUS_ATTRIBUTE));
assertEquals(400L, attributesMap.get(ObservabilityAttributes.HTTP_RESPONSE_STATUS_ATTRIBUTE));
}

private Map<String, ?> getAttributesMap() {
if (!testLogger.getMDCMap().isEmpty()) {
return testLogger.getMDCMap();
Expand Down
Loading