Skip to content

feat: log actionable errors on operation failure in LoggingTracer #14460

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

Draft
jinseopkim0 wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

feat: log actionable errors on operation failure in LoggingTracer #14460

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
e329bde
feat: log actionable errors on operation failure in LoggingTracer
jinseopkim0 Sep 21, 2026
3ad7451
test: detach appender and clear events in ITActionableErrorsLogging
jinseopkim0 Sep 21, 2026
054f23c
fix: check instanceof ch.qos.logback.classic.Logger before detaching …
jinseopkim0 Sep 21, 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
5 changes: 5 additions & 0 deletions ...wcase/src/test/java/com/google/showcase/v1beta1/it/logging/ITActionableErrorsLogging.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,10 @@ void setupTestLogger() {
void teardownTestLogger() {
if (testAppender != null) {
testAppender.stop();
org.slf4j.Logger logger = LoggerFactory.getLogger("com.google.api.gax.tracing.LoggingTracer");
if (logger instanceof ch.qos.logback.classic.Logger) {
((ch.qos.logback.classic.Logger) logger).detachAppender(testAppender);
}
}
}

Expand Down Expand Up @@ -264,6 +268,7 @@ void testGrpc_logEmittedForLowLevelRequestFailure() {

@Test
void testGrpc_noLogEmittedForSuccess() {
testAppender.clearEvents();
EchoRequest request = EchoRequest.newBuilder().setContent("Success").build();
grpcClient.echo(request);
assertThat(testAppender.events.size()).isEqualTo(0);
Expand Down
5 changes: 5 additions & 0 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 @@ -64,6 +64,11 @@ public void attemptFailedRetriesExhausted(Throwable error) {
recordActionableError(error);
}

@Override
public void operationFailed(Throwable error) {
recordActionableError(error);
}

@Override
public void attemptPermanentFailure(Throwable error) {
recordActionableError(error);
Expand Down
12 changes: 12 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 @@ -93,6 +93,18 @@ void testAttemptPermanentFailure_LogsError() {
assertEquals("generic permanent failure", testLogger.getMessageList().get(0));
}

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

Exception error = new RuntimeException("generic operation failure");
tracer.operationFailed(error);

assertEquals(1, testLogger.getMessageList().size());
assertEquals("generic operation failure", testLogger.getMessageList().get(0));
}

@Test
void testRecordActionableError_logsErrorMessage() {
ApiTracerContext context = ApiTracerContext.empty();
Expand Down
Loading