Skip to content

feat(storage): add OpenTelemetry tracing support for gRPC bidi APIs - #18397

Open
shradhakatyal wants to merge 9 commits into
googleapis:mainfrom
shradhakatyal:feat/zb-traces
Open

shradhakatyal wants to merge 9 commits into
googleapis:mainfrom
shradhakatyal:feat/zb-traces

Conversation

@shradhakatyal

@shradhakatyal shradhakatyal commented Sep 16, 2026 •

Copy link
Copy Markdown
Contributor

This PR adds OpenTelemetry tracing support for gRPC bidi APIs (Rapid Storage and Standard buckets) across the asynchronous gRPC client and streaming classes (AsyncGrpcClient, AsyncAppendableObjectWriter, and AsyncMultiRangeDownloader).

The implementation aligns with existing regional bucket tracing conventions:

  • Instruments T2 (Client API) spans using the naming format Storage.<Class>.<methodName>.
  • Reuses existing opt-in environment variables (ENABLE_GCS_PYTHON_CLIENT_OTEL_TRACES and DISABLE_GCS_PYTHON_CLIENT_OTEL_BUCKET_METADATA).
  • Sets rpc.system="grpc" and attaches App-Centric Observability (ACO) attributes (gcp.resource.destination.id and gcp.resource.destination.location).
  • Injects W3C traceparent headers directly into gRPC request metadata tuples.

Fixes: b/489239033

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

Copy link
Copy Markdown
Contributor

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 OpenTelemetry tracing support for zonal buckets (Rapid Storage) in async gRPC classes. It refactors tracing span creation to support both synchronous and asynchronous context managers, injects traceparent metadata into gRPC requests, and updates the bucket metadata cache to support asynchronous gRPC fetches. The review feedback recommends defensively checking for __aenter__ and __aexit__ in _TraceSpanHelperContext to ensure compatibility with synchronous context managers (such as mocked spans in unit tests) and refactoring the project number extraction in update_from_bucket to use getattr more idiomatically.

@shradhakatyal
shradhakatyal marked this pull request as ready for review September 28, 2026 05:26
@shradhakatyal
shradhakatyal requested a review from a team as a code owner September 28, 2026 05:26
@cpriti-os
cpriti-os self-requested a review September 28, 2026 06:02
shradhakatyal and others added 5 commits September 29, 2026 09:28
…adata_cache.py

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
…ache

- Add T2 trace spans to AsyncAppendableObjectWriter.simple_flush and finalize
- Prevent nested T2 spans during internal stream reconnects and finalize_on_close
- Simplify _is_otel_traces_enabled() and clean up fixture teardown
- Avoid duplicate exception events on GoogleAPICallError in _TraceSpanContext
- Track background asyncio tasks in BucketMetadataCache and refresh cache on GetBucket
- Add unit tests for 403/404 cache handling and span error recording

[Generated-by: AI]
@shradhakatyal

Copy link
Copy Markdown
Contributor Author

/gcbrun 6a01c38

@chandra-siri

Copy link
Copy Markdown
Contributor

@shradhakatyal , can you check the performance regression caused because of this PR - screen/228ingun6e470

… is disabled

- Add _NoOpTraceSpanContext singleton and fast-path create_trace_span and create_trace_span_helper when tracing is disabled
- Add __slots__ to _TraceSpanContext and _TraceSpanHelperContext and avoid async coroutine wrapping for sync span context managers
- Replace @asynccontextmanager in AsyncAppendableObjectWriter._trace_span with slotted _WriterTraceSpanContext and no-op fast path
- Fast-path inject_traceparent_to_metadata without copying metadata when disabled and cache TraceContextTextMapPropagator
- Avoid duplicate cache lookup in BucketMetadataCache.get_or_queue_fetch

[Generated-by: AI]
@shradhakatyal

Copy link
Copy Markdown
Contributor Author

/gcbrun (bd89f56)

@chandra-siri chandra-siri self-assigned this Oct 20, 2026
@shradhakatyal

Copy link
Copy Markdown
Contributor Author

/gcbrun (bd89f56)

@shradhakatyal
shradhakatyal requested a review from a team as a code owner October 26, 2026 12:04
@shradhakatyal

Copy link
Copy Markdown
Contributor Author

/gcbrun (7b87f4b)

@shradhakatyal

Copy link
Copy Markdown
Contributor Author

@shradhakatyal , can you check the performance regression caused because of this PR - screen/228ingun6e470

Fixed, please check.

@chandra-siri

Copy link
Copy Markdown
Contributor

@shradhakatyal

nit: modify the title to "feat(storage): add OpenTelemetry tracing support for gRPC bidi APIs"

reason: grpc bidi includes Rapid Storage ( zonal buckets) & they also started supporting Standard buckets.

@cpriti-os cpriti-os left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM, thanks for addressing the feedback!

@shradhakatyal shradhakatyal changed the title feat(storage): add OpenTelemetry tracing support for Zonal Buckets feat(storage): add OpenTelemetry tracing support for gRPC bidi APIs Nov 1, 2026
@shradhakatyal

Copy link
Copy Markdown
Contributor Author

nit: modify the title to "feat(storage): add OpenTelemetry tracing support for gRPC bidi APIs"

Done

Co-authored by AI Agent

@shradhakatyal

Copy link
Copy Markdown
Contributor Author

@shradhakatyal

nit: modify the title to "feat(storage): add OpenTelemetry tracing support for gRPC bidi APIs"

reason: grpc bidi includes Rapid Storage ( zonal buckets) & they also started supporting Standard buckets.

Done!

@shradhakatyal

Copy link
Copy Markdown
Contributor Author

/gcbrun (1df0886)

async with self._trace_span(
"Storage.AsyncAppendableObjectWriter.append",
attributes={"gcp.storage.append.bytes": len(data)},
):

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

In the cross-SDK trace attributes spec, the standard attribute name for payload size on gRPC spans is gcp.storage.payload.size_bytes — could we use gcp.storage.payload.size_bytes here instead of gcp.storage.append.bytes?

This branch has not been deployed

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

3 participants