Skip to content

feat(bigquery observability): add version attribute to span tracing#12132

Open
ldetmer wants to merge 3 commits intomainfrom
add-version-tracking
Open

feat(bigquery observability): add version attribute to span tracing#12132
ldetmer wants to merge 3 commits intomainfrom
add-version-tracking

Conversation

@ldetmer
Copy link
Contributor

@ldetmer ldetmer commented Mar 23, 2026

This PR adds the gcp.client.version attribute to the span trace. It follows the general java guidance on retrieving version at runtime, by creating a Version.java file that stores the current version and is updated via release-please. See gapic version here.

Example trace with attribute.

There is a separate task to update release-please to handle updating this file.

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! 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 enhances the BigQuery client library's observability by integrating the client version into OpenTelemetry span traces. This addition provides crucial context for debugging and monitoring, allowing for easier identification of issues related to specific client versions. The change involves creating a dedicated version class and updating the telemetry tracer to utilize this version information.

Highlights

  • Telemetry Enhancement: Added the gcp.client.version attribute to span traces for BigQuery operations, improving observability and debugging capabilities.
  • Version Management: Introduced a new Version.java file to centrally manage and retrieve the client library version at runtime, following established Java guidance.
  • Test Coverage: Included new and updated existing tests to ensure the gcp.client.version attribute is correctly added and verified in span data.
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.

Footnotes

  1. 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.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces a new Version class to centralize the BigQuery client artifact version. This version is then integrated into the telemetry tracing mechanism, specifically by adding a GCP_CLIENT_VERSION attribute to OpenTelemetry spans. New and updated tests verify this telemetry attribute. A suggestion was made to reorder the Javadoc and annotations in the Version class to align with standard Java conventions.

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@ldetmer ldetmer marked this pull request as ready for review March 23, 2026 15:50
@ldetmer ldetmer requested review from a team as code owners March 23, 2026 15:50
Copy link
Contributor

@diegomarquezp diegomarquezp left a comment

Choose a reason for hiding this comment

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

Looks good overall, just a minor comment

Copy link
Contributor

Choose a reason for hiding this comment

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

This should be package private as per gax's approach.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants