impl(o11y): introduce error attributes by diegomarquezp · Pull Request #12189 · googleapis/google-cloud-java

diegomarquezp · 2026-03-24T19:55:12Z

Ports the error.type and status.message telemetry features from sdk-platform-java.

gemini-code-assist · 2026-03-24T19:55:37Z

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 refines the tracing telemetry by introducing dedicated attributes for error types, exception types, and status messages. These additions provide a more detailed and standardized way to categorize and understand failures occurring within client-side operations, improving observability and debugging capabilities. The changes ensure that critical error information is consistently captured in OpenTelemetry spans, offering clearer insights into the root causes of issues.

Highlights

Enhanced Error Telemetry: Introduced new OpenTelemetry attributes (error.type, status.message, exception.type) to provide more granular details on client-side errors within tracing spans.
Standardized Error Type Extraction: Added a new utility class ErrorTypeUtil to consistently extract low-cardinality error types from Throwable objects, prioritizing google.rpc.ErrorInfo.reason, client-side network/operational errors, specific server codes, and language-specific exception names.
Span Attribute Population: Modified SpanTracer to automatically populate the new error telemetry attributes on attempt spans when operations fail, including a recursive search for the most relevant error message.
API Tracer Update: Extended the ApiTracer interface with a new default method requestSent(long requestSize) to allow for tracking the size of streaming requests.
Comprehensive Testing: Added extensive unit and integration tests to validate the correct extraction and recording of error types and messages across various client-side and server-side failure scenarios for both gRPC and HTTP/JSON transports.

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 a new ErrorTypeUtil class to provide a standardized way of classifying exceptions into specific error types (e.g., client timeout, connection error, authentication error) for OpenTelemetry tracing. It adds new observability attributes (error.type, exception.type, status.message) and integrates this error classification into the SpanTracer to enrich span data upon failed attempts. The changes also include comprehensive unit and integration tests to validate the new error type extraction and tracing functionality. Feedback from the review includes correcting incorrect copyright years, removing redundant semicolons and toString() overrides, and updating Javadoc for accuracy.

sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/ErrorTypeUtil.java

sdk-platform-java/gax-java/gax/src/test/java/com/google/api/gax/tracing/ErrorTypeUtilTest.java

...va-showcase/gapic-showcase/src/test/java/com/google/showcase/v1beta1/it/ITOtelErrorType.java

sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/ApiTracer.java

sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/ErrorTypeUtil.java

…Manager

This reverts commit 0ce71dd.

…-attr-error-type-transfer

diegomarquezp · 2026-03-26T18:49:18Z

sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/ErrorTypeUtil.java

+import javax.annotation.Nullable;
+import javax.net.ssl.SSLHandshakeException;
+
+public class ErrorTypeUtil {


Ideally other libraries can rely on this logic

For bigquery etc?

Yes, exactly.

…avoid ADC issues in CI

… tests

diegomarquezp · 2026-03-27T13:59:13Z

01:03:56:592 [ERROR] Failed to execute goal org.graalvm.buildtools:native-maven-plugin:0.10.6:test (test-native) on project google-auth-library-credentials: Execution test-native of goal org.graalvm.buildtools:native-maven-plugin:0.10.6:test failed: Test configuration file wasn't found. -> [Help 1]
01:03:56:593 [ERROR] Failed to execute goal org.graalvm.buildtools:native-maven-plugin:0.10.6:test (test-native) on project api-common: Execution test-native of goal org.graalvm.buildtools:native-maven-plugin:0.10.6:test failed: Test configuration file wasn't found. -> [Help 1]
01:03:56:593 [ERROR] Failed to execute goal org.graalvm.buildtools:native-maven-plugin:0.10.6:test (test-native) on project google-auth-library-appengine: Execution test-native of goal org.graalvm.buildtools:native-maven-plugin:0.10.6:test failed: Test configuration file wasn't found. -> [Help 1]
01:03:56:593 [ERROR] Failed to execute goal org.apache.maven.plugins:maven-surefire-plugin:3.5.2:test (default-test) on project google-auth-library-cab-token-generator:

GraalVM failures seem unrelated

This reverts commit 4f6ff6e.

blakeli0 · 2026-03-27T16:00:07Z

...form-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/ObservabilityAttributes.java

+   * The specific error type. Value will be google.rpc.ErrorInfo.reason, a specific Server Error
+   * Code, Client-Side Network/Operational Error (e.g., CLIENT_TIMEOUT) or internal fallback.
+   */
+  public static final String ERROR_TYPE_ATTRIBUTE = "error.type";


FYI, Wes is adding the same attribute in #12202. Depending on which PR gets merged in first, you may need to rebase this PR based on his changes.

sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/ErrorTypeUtil.java

blakeli0 · 2026-03-27T17:55:43Z

sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/ErrorTypeUtil.java

+  private static boolean hasErrorClassInCauseChain(
+      Throwable t, Set<Class<? extends Throwable>> errorClasses) {
+    Throwable current = t;
+    while (current != null) {


While this is nice to check all possible causes, I'm not sure it is the correct way. Do you have a concrete example that a cause is nested? It also introduces more questions like what if there is a SocketTimeoutException caused by a ConnectException?

Is this what other languages are doing? If not, I'm leaning towards only checking the top level.

To double check wrapper exceptions and specify them directly in here. The point of ambiguity is valid.

I removed the recursive check for now and I'm confirming the need of it internally.

sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/ErrorTypeUtil.java

...va-showcase/gapic-showcase/src/test/java/com/google/showcase/v1beta1/it/ITOtelErrorType.java

blakeli0 · 2026-03-28T04:10:10Z

sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/SpanTracer.java

+
+  private String extractErrorMessage(Throwable error) {
+    Throwable cause = error;
+    while (cause != null) {


I don't think we need to recursively get the error message as well.

Thanks for the catch. Done.

blakeli0 · 2026-03-28T04:10:40Z

sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/ErrorTypeUtil.java

+import javax.annotation.Nullable;
+import javax.net.ssl.SSLHandshakeException;
+
+public class ErrorTypeUtil {


For bigquery etc?

blakeli0 · 2026-03-28T04:11:46Z

sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/ErrorTypeUtil.java

+
+public class ErrorTypeUtil {
+
+  public enum ErrorType {


This enum can be package private. I don't think other libraries would use this enum directly?

diegomarquezp

Comments addressed

diegomarquezp · 2026-03-28T12:00:53Z

sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/ErrorTypeUtil.java

+import javax.annotation.Nullable;
+import javax.net.ssl.SSLHandshakeException;
+
+public class ErrorTypeUtil {


Yes, exactly.

diegomarquezp · 2026-03-28T12:02:13Z

sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/ErrorTypeUtil.java

+
+public class ErrorTypeUtil {
+
+  public enum ErrorType {


diegomarquezp · 2026-03-28T12:02:33Z

sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/SpanTracer.java

+
+  private String extractErrorMessage(Throwable error) {
+    Throwable cause = error;
+    while (cause != null) {


Thanks for the catch. Done.

feat: Refine tracing telemetry for client-side attributes

e9382ee

gemini-code-assist bot reviewed Mar 24, 2026

View reviewed changes

docs: indicate return INTERNAL

678f80d

diegomarquezp changed the title ~~feat: Refine tracing telemetry for client-side attributes~~ impl(o11y): introduce error attributes Mar 24, 2026

diegomarquezp added 9 commits March 24, 2026 17:03

test: fix ITOtelErrorType compilation by replacing OpenTelemetryTrace…

3353528

…Manager

build: add missing license headers to showcase tests

0ce71dd

Revert "build: add missing license headers to showcase tests"

86d6cab

This reverts commit 0ce71dd.

docs(o11y): fix Javadoc for extractErrorType

fe5ee04

chore: format

fc1ebb2

Merge branch 'main' into observability/tracing-attr-error-type-transfer

318d0ab

fix: remove unrelated change

38ac1e6

test: fix unavailable exception

446bb56

Merge remote-tracking branch 'origin/main' into observability/tracing…

a6e6cad

…-attr-error-type-transfer

diegomarquezp marked this pull request as ready for review March 26, 2026 18:48

diegomarquezp requested a review from a team as a code owner March 26, 2026 18:48

diegomarquezp commented Mar 26, 2026

View reviewed changes

diegomarquezp added 3 commits March 26, 2026 16:13

chore: Resolve fully qualified class names in ITOtelErrorType.java

fe20c3d

test: add timeouts to ITOtelErrorType.java

f45a32e

chore: Add class-level timeout to ITOtelErrorType.java

11b0541

diegomarquezp marked this pull request as draft March 26, 2026 20:32

diegomarquezp added 2 commits March 26, 2026 17:36

fix(showcase): use NoCredentialsProvider in ITOtelErrorType tests to …

2b92891

…avoid ADC issues in CI

fix(showcase): use NoCredentialsProvider in remaining ITOtelErrorType…

9c16df5

… tests

diegomarquezp added 5 commits March 27, 2026 10:16

docs: correct error type logic comment

b149819

test: revert unnecessary change

4f6ff6e

Revert "test: revert unnecessary change"

d6b562b

This reverts commit 4f6ff6e.

test: do not use mocks

2ba70e2

Merge branch 'main' into observability/tracing-attr-error-type-transfer

d1470dd

diegomarquezp marked this pull request as ready for review March 27, 2026 15:43

blakeli0 reviewed Mar 27, 2026

View reviewed changes

diegomarquezp mentioned this pull request Mar 27, 2026

feat(gax): Actionable Errors Logging API Tracer #12202

Open

diegomarquezp commented Mar 27, 2026

View reviewed changes

...va-showcase/gapic-showcase/src/test/java/com/google/showcase/v1beta1/it/ITOtelErrorType.java Outdated Show resolved Hide resolved

diegomarquezp added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Mar 27, 2026

yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Mar 27, 2026

Simplify error classification and merge observability integration tests

d7a8fef

blakeli0 reviewed Mar 28, 2026

View reviewed changes

diegomarquezp added 2 commits March 28, 2026 07:56

fix: remove recursive error logic in SpanTracer

1610b38

fix: make ErrorType enum package private

09bcc2d

diegomarquezp commented Mar 28, 2026

View reviewed changes

diegomarquezp added 2 commits March 28, 2026 08:09

fix: simplify logic

b80757b

test: move ErroTypeUtilTest to correct package

2bf5470

Conversation

diegomarquezp commented Mar 24, 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 24, 2026

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

diegomarquezp commented Mar 27, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

diegomarquezp left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

diegomarquezp commented Mar 24, 2026 •

edited

Loading