iframe-proxy

westarle · 2026-03-18T04:42:04Z

This PR introduces SLF4J logging for "Actionable Errors" occurring at the RPC Attempt level.

gemini-code-assist · 2026-03-18T04:42:26Z

Summary of Changes

Hello, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the observability of RPC calls within the GAX framework by implementing structured logging for "Actionable Errors." It provides detailed context for failed RPC attempts, making it easier to diagnose and understand issues at the application level, aligning with Application Centric Observability guidelines. The new logging is conditionally enabled via an environment variable and integrates seamlessly with existing tracing infrastructure.

Highlights

Actionable Error Logging: Introduced a new mechanism to log "Actionable Errors" at the RPC attempt (T4) level using SLF4J, providing enhanced observability.
Structured Context: Enhanced error logging to include structured google.rpc.ErrorInfo payload and ApiTracerContext attributes (e.g., server.port, rpc.method) for better diagnostic information.
Tracing Integration: Ensured error messages are natively tied to the active T4 span, facilitating OpenTelemetry correlation and improved tracing.
Conditional Activation: Implemented logging activation via the GOOGLE_SDK_JAVA_LOGGING=true environment variable, ensuring it operates independently of OpenTelemetry/OpenCensus backend configuration.
API Tracer Decoration: Introduced LoggingTracer and LoggingTracerFactory to decorate the ApiTracer interface and intercept attemptFailed callbacks for error capture.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist

Code Review

This pull request introduces logging for actionable errors within the ApiTracer framework, which is a great step towards better observability. The implementation uses a decorator pattern with LoggingTracer and LoggingTracerFactory to intercept failed RPC attempts and log relevant context, gated by an environment variable. The changes are well-structured. I have a couple of suggestions to improve maintainability and test robustness.

I am having trouble creating individual review comments. Click here to see my feedback.

gax-java/gax/src/main/java/com/google/api/gax/tracing/LoggingTracer.java (186-190)

The string literals for logging context keys like "error.type" are hardcoded. To improve maintainability and prevent potential typos, it's a good practice to define them as private static final constants at the top of the class and use them here.

For example, you could add:

private static final String ERROR_TYPE_ATTRIBUTE = "error.type";
private static final String GCP_ERRORS_DOMAIN_ATTRIBUTE = "gcp.errors.domain";
private static final String GCP_ERRORS_METADATA_PREFIX = "gcp.errors.metadata.";

And then use these constants in this block.

gax-java/gax/src/test/java/com/google/api/gax/logging/LoggingUtilsTest.java (120-137)

The testLogActionableError_success test is a bit weak as it only verifies that getLogger() and isInfoEnabled() are called. It doesn't confirm that the logging context and message are correctly passed to the underlying logging framework. To make the test more robust, you should also verify that addKeyValue is called with the expected key-value pairs from the context and that log is called with the correct message on the LoggingEventBuilder.

  @Test
  void testLogActionableError_success() {
    LoggingUtils.setLoggingEnabled(true);
    LoggerProvider loggerProvider = mock(LoggerProvider.class);
    Logger logger = mock(Logger.class);
    when(loggerProvider.getLogger()).thenReturn(logger);
    when(logger.isInfoEnabled()).thenReturn(true);

    org.slf4j.spi.LoggingEventBuilder eventBuilder = mock(org.slf4j.spi.LoggingEventBuilder.class);
    when(logger.atInfo()).thenReturn(eventBuilder);
    when(eventBuilder.addKeyValue(anyString(), any())).thenReturn(eventBuilder);

    Map<String, Object> context = Collections.singletonMap("key", "value");
    LoggingUtils.logActionableError(context, loggerProvider, "message");

    verify(loggerProvider).getLogger();
    verify(logger).isInfoEnabled();
    verify(eventBuilder).addKeyValue("key", "value");
    verify(eventBuilder).log("message");
  }

westarle · 2026-03-30T14:13:14Z

product-auto-label Bot added the size: l Pull request size is large. label Mar 18, 2026

westarle force-pushed the feat/actionable-errors-api-tracer branch from ba3c2cd to 865c099 Compare March 18, 2026 04:52

gemini-code-assist Bot reviewed Mar 18, 2026

View reviewed changes

blakeli0 reviewed Mar 18, 2026

View reviewed changes

Comment thread gax-java/gax/src/main/java/com/google/api/gax/rpc/ClientContext.java Outdated

Comment thread gax-java/gax/src/main/java/com/google/api/gax/tracing/LoggingTracer.java Outdated

westarle force-pushed the feat/actionable-errors-api-tracer branch 2 times, most recently from af203ff to ade532f Compare March 18, 2026 22:05

feat(gax): add utilities for logging actionable errors

ed367ec

westarle force-pushed the feat/actionable-errors-api-tracer branch from ade532f to a3ed812 Compare March 22, 2026 16:03

westarle added 2 commits March 22, 2026 12:24

fix(gax): make isLoggingEnabled and setLoggingEnabled package private

741cb2c

fix(gax): make isLoggingEnabled and setLoggingEnabled package private

8294d78

westarle force-pushed the feat/actionable-errors-api-tracer branch from a3ed812 to 1548dce Compare March 22, 2026 16:42

fix: Actionable error utility determines DEBUG log level internally

5d6bc5f

westarle force-pushed the feat/actionable-errors-api-tracer branch from 1548dce to 983d57d Compare March 22, 2026 17:27

fix: Actionable error utility determines DEBUG log level internally

38838d1

westarle force-pushed the feat/actionable-errors-api-tracer branch from 983d57d to b87215a Compare March 22, 2026 17:35

style(gax): format LoggingUtils

b51ef3c

westarle force-pushed the feat/actionable-errors-api-tracer branch 11 times, most recently from 76d0900 to 042c642 Compare March 23, 2026 20:23

product-auto-label Bot added size: m Pull request size is medium. and removed size: l Pull request size is large. labels Mar 23, 2026

westarle force-pushed the feat/actionable-errors-api-tracer branch from 31ce3f0 to 269c749 Compare March 24, 2026 02:42

product-auto-label Bot added size: l Pull request size is large. and removed size: m Pull request size is medium. labels Mar 24, 2026

feat(gax): implement actionable errors logging in ApiTracer framework

5d46299

westarle force-pushed the feat/actionable-errors-api-tracer branch from eb6ef7c to 5d46299 Compare March 24, 2026 15:46

westarle closed this Mar 30, 2026

Sunbelt Computer Software

PL/B Language Development and Support

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(gax): actionable errors logging in ApiTracer framework#4153

feat(gax): actionable errors logging in ApiTracer framework#4153
westarle wants to merge 7 commits into
googleapis:mainfrom
westarle:feat/actionable-errors-api-tracer

westarle commented Mar 18, 2026 •

edited

Loading

Uh oh!

gemini-code-assist Bot commented Mar 18, 2026

Uh oh!

gemini-code-assist Bot left a comment

Uh oh!

Uh oh!

Uh oh!

westarle commented Mar 30, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Sunbelt Computer Software

PL/B Language Development and Support

Uh oh!

Conversation

westarle commented Mar 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gemini-code-assist Bot commented Mar 18, 2026

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

gax-java/gax/src/main/java/com/google/api/gax/tracing/LoggingTracer.java (186-190)

gax-java/gax/src/test/java/com/google/api/gax/logging/LoggingUtilsTest.java (120-137)

Uh oh!

Uh oh!

Uh oh!

westarle commented Mar 30, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

westarle commented Mar 18, 2026 •

edited

Loading