[OpenTelemetry] Add tracing support to GCP Spanner IO#39149
Conversation
Summary of ChangesHello, 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 observability of Google Cloud Spanner IO within Apache Beam by integrating OpenTelemetry. By enabling users to configure OTel tracing and metrics, it provides a more modern and standardized approach to monitoring Spanner operations. The changes involve updating the Spanner client initialization, configuring pipeline options, and ensuring that all relevant DoFns and DAOs are aware of the OpenTelemetry instance. Highlights
New Features🧠 You can now enable Memory (public preview) to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe 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
Customization To customize the 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 Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counterproductive. 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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request integrates OpenTelemetry tracing and metrics support into the Beam Google Cloud Spanner IO connector. It updates various DoFn setup methods to retrieve OpenTelemetry from PipelineOptions and configures SpannerAccessor and SpannerConfig to enable OpenTelemetry tracing when specified. The review feedback highlights two issues: a potential IllegalStateException or NullPointerException in SpannerAccessor when calling get() on a ValueProvider without checking isAccessible() or handling nulls, and a malformed Javadoc comment in ReadChangeStreamPartitionDoFn containing nested {@link} tags.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
e339a53 to
ec299d4
Compare
|
Checks are failing. Will not request review until checks are succeeding. If you'd like to override that behavior, comment |
e012325 to
cdb1977
Compare
|
Assigning reviewers: R: @kennknowles for label java. Note: If you would like to opt out of this review, comment Available commands:
The PR bot will only process comments in the main thread (not review comments). |
|
Reminder, please take a look at this pr: @kennknowles @nielm |
|
Assigning new set of reviewers because Pr has gone too long without review. If you would like to opt out of this review, comment R: @Abacn for label java. Available commands:
|
kennknowles
left a comment
kennknowles
left a comment
There was a problem hiding this comment.
Looks fine, but the code jumped out at me as odd because it passed something clearly optional without any checks - I had to review more carefully to see that nullness was suppressed. Good follow up would be to un-suppress that (which will force you to add the annotation I suggested)
| return this.tvfNameList; | ||
| } | ||
|
|
||
| public void setOpenTelemetry(OpenTelemetry openTelemetry) { |
There was a problem hiding this comment.
It looks like this should be @Nullable since the pipeline option is passed in unconditionally
| spannerAccessor = SpannerAccessor.getOrCreate(config); | ||
| public void setup(PipelineOptions options) throws Exception { | ||
| OpenTelemetry otel = options.as(SdkHarnessOptions.class).getOpenTelemetry(); | ||
| spannerAccessor = SpannerAccessor.getOrCreate(config, otel); |
There was a problem hiding this comment.
Will this work if otel is null? (or can it never be null?)
There was a problem hiding this comment.
spannerAccessor will handle null.
|
Assigning new set of reviewers because Pr has gone too long without review. If you would like to opt out of this review, comment R: @ahmedabu98 for label java. Available commands:
|
|
waiting on author |
fdfd
cdb1977 to
89f3db1
Compare
2 participants
This PR introduces OpenTelemetry (OTel) support for Google Cloud Spanner IO, enabling better observability, tracing, and metrics for Spanner operations within Beam pipelines.
Configuration: Added withEnableOpenTelemetryTracing() to SpannerConfig and SpannerIO (Write and ReadChangeStream) to allow users to easily toggle OTel tracing.
Client Initialization: Updated SpannerAccessor and its underlying SpannerOptions builder to accept an OpenTelemetry instance. When enabled, this automatically configures extended tracing, API tracing, and end-to-end tracing, while swapping OpenCensus for OpenTelemetry metrics/traces in the Spanner client.
Pipeline Options Integration: Updated the @setup lifecycle methods across various DoFns (e.g., BatchSpannerRead, NaiveSpannerRead, CreateTransactionFn, and Change Stream DoFns) to extract the OpenTelemetry instance directly from PipelineOptions via SdkHarnessOptions.
Change Streams DAO: Updated DaoFactory to hold and pass the OpenTelemetry instance to the Spanner metadata and admin clients.
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, commentfixes #<ISSUE NUMBER>instead.CHANGES.mdwith noteworthy changes.See the Contributor Guide for more tips on how to make review process smoother.
To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md
GitHub Actions Tests Status (on master branch)
See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.