[OpenTelemetry] Add tracing support to GCP Spanner IO by stankiewicz · Pull Request #39149 · apache/beam

stankiewicz · 2026-06-29T12:57:29Z

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:

Mention the appropriate issue in your description (for example: 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, comment fixes #<ISSUE NUMBER> instead.
Update CHANGES.md with noteworthy changes.
If this contribution is large, please file an Apache Individual Contributor License Agreement.

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.

gemini-code-assist · 2026-06-29T13:06:44Z

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

OpenTelemetry Integration: Added comprehensive OpenTelemetry (OTel) support to Google Cloud Spanner IO, allowing for improved observability, tracing, and metrics within Beam pipelines.
Configuration Toggles: Introduced withEnableOpenTelemetryTracing() to SpannerConfig and SpannerIO, enabling users to toggle OTel tracing for Read and Write operations.
Client Initialization: Updated SpannerAccessor to accept an OpenTelemetry instance, enabling the configuration of extended, API, and end-to-end tracing while migrating from OpenCensus to OpenTelemetry.
Lifecycle Management: Updated @setup methods across various DoFns to inject the OpenTelemetry instance directly from PipelineOptions, ensuring consistent observability across the pipeline.

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

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

github-actions · 2026-06-29T19:38:12Z

Checks are failing. Will not request review until checks are succeeding. If you'd like to override that behavior, comment assign set of reviewers

github-actions · 2026-06-29T23:51:48Z

Assigning reviewers:

R: @kennknowles for label java.
R: @nielm for label spanner.

Note: If you would like to opt out of this review, comment assign to next reviewer.

Available commands:

stop reviewer notifications - opt out of the automated review tooling
remind me after tests pass - tag the comment author after tests pass
waiting on author - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)

The PR bot will only process comments in the main thread (not review comments).

github-actions · 2026-07-07T13:01:08Z

Reminder, please take a look at this pr: @kennknowles @nielm

github-actions · 2026-07-09T13:23:59Z

Assigning new set of reviewers because Pr has gone too long without review. If you would like to opt out of this review, comment assign to next reviewer:

R: @Abacn for label java.
R: @nielm for label spanner.

Available commands:

stop reviewer notifications - opt out of the automated review tooling
remind me after tests pass - tag the comment author after tests pass
waiting on author - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)

kennknowles

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)

kennknowles · 2026-07-09T17:25:00Z

    return this.tvfNameList;
  }

+  public void setOpenTelemetry(OpenTelemetry openTelemetry) {


It looks like this should be @Nullable since the pipeline option is passed in unconditionally

thanks, done

thanks, added

kennknowles · 2026-07-09T17:25:49Z

-      spannerAccessor = SpannerAccessor.getOrCreate(config);
+    public void setup(PipelineOptions options) throws Exception {
+      OpenTelemetry otel = options.as(SdkHarnessOptions.class).getOpenTelemetry();
+      spannerAccessor = SpannerAccessor.getOrCreate(config, otel);


Will this work if otel is null? (or can it never be null?)

spannerAccessor will handle null.

yes, spannerAccessor can handle null.

github-actions · 2026-07-17T12:36:30Z

Reminder, please take a look at this pr: @Abacn @nielm

github-actions · 2026-07-21T12:41:37Z

Assigning new set of reviewers because Pr has gone too long without review. If you would like to opt out of this review, comment assign to next reviewer:

R: @ahmedabu98 for label java.
R: @nielm for label spanner.

Available commands:

stop reviewer notifications - opt out of the automated review tooling
remind me after tests pass - tag the comment author after tests pass
waiting on author - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)

kennknowles · 2026-07-21T13:51:23Z

waiting on author

fdfd

github-actions Bot added java io gcp spanner labels Jun 29, 2026

gemini-code-assist Bot reviewed Jun 29, 2026

View reviewed changes

Comment thread .../google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/spanner/SpannerAccessor.java Outdated

Comment thread ...ava/org/apache/beam/sdk/io/gcp/spanner/changestreams/dofn/ReadChangeStreamPartitionDoFn.java Outdated

stankiewicz force-pushed the otel_spanner_db branch 3 times, most recently from e339a53 to ec299d4 Compare June 29, 2026 16:15

stankiewicz force-pushed the otel_spanner_db branch 2 times, most recently from e012325 to cdb1977 Compare June 29, 2026 21:19

github-actions Bot added the Next Action: Reviewers label Jun 29, 2026

github-actions Bot added the slow-review label Jul 7, 2026

github-actions Bot added reassigned-reviewers and removed slow-review labels Jul 9, 2026

kennknowles approved these changes Jul 9, 2026

View reviewed changes

github-actions Bot added the slow-review label Jul 17, 2026

github-actions Bot removed the slow-review label Jul 21, 2026

github-actions Bot added Next Action: Author and removed Next Action: Reviewers labels Jul 21, 2026

OTEL in spanner.

89f3db1

fdfd

stankiewicz force-pushed the otel_spanner_db branch from cdb1977 to 89f3db1 Compare July 22, 2026 13:09

github-actions Bot removed the Next Action: Author label Jul 22, 2026

github-actions Bot added the Next Action: Reviewers label Jul 22, 2026

stankiewicz requested a review from kennknowles July 22, 2026 15:13

Uh oh!

Conversation

stankiewicz commented Jun 29, 2026

GitHub Actions Tests Status (on master branch)

Uh oh!

gemini-code-assist Bot commented Jun 29, 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!

github-actions Bot commented Jun 29, 2026

Uh oh!

github-actions Bot commented Jun 29, 2026

Uh oh!

github-actions Bot commented Jul 7, 2026

Uh oh!

github-actions Bot commented Jul 9, 2026

Uh oh!

kennknowles left a comment

Choose a reason for hiding this comment

Uh oh!

kennknowles Jul 9, 2026

Choose a reason for hiding this comment

Uh oh!

stankiewicz Jul 22, 2026

Choose a reason for hiding this comment

Uh oh!

stankiewicz Jul 23, 2026

Choose a reason for hiding this comment

Uh oh!

kennknowles Jul 9, 2026

Choose a reason for hiding this comment

Uh oh!

stankiewicz Jul 22, 2026

Choose a reason for hiding this comment

Uh oh!

stankiewicz Jul 23, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Jul 17, 2026

Uh oh!

github-actions Bot commented Jul 21, 2026

Uh oh!

kennknowles commented Jul 21, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants