Skip to content

feat(docs): add o11y sample - #9456

Merged
shivanee-p merged 7 commits into
mainfrom
shivaneep-o11y-sample
Sep 28, 2026
Merged

shivanee-p merged 7 commits into
mainfrom
shivaneep-o11y-sample

Conversation

@shivanee-p

Copy link
Copy Markdown
Contributor

Adds a standalone code sample demonstrating how customers can configure OpenTelemetry tracing for Google Cloud Node.js client libraries using google-gax.

The sample demonstrates enabling:

  • T4 Tracing (Wire / Transport Spans): Using @opentelemetry/instrumentation-http and @opentelemetry/instrumentation-grpc to capture low-level network calls.
  • T3 Tracing (Client / RPC Spans): Using the GOOGLE_SDK_NODE_ENABLE_TRACING=true environment variable to capture google-gax RPC attempt spans.

@product-auto-label product-auto-label Bot added the samples Issues that are directly related to samples. label Sep 26, 2026

@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 a new observability sample demonstrating how to configure OpenTelemetry tracing for Google Cloud client libraries, and updates the README to document it. The review feedback suggests moving the OpenTelemetry initialization, instrumentation registration, and environment variable configuration to the top level of the file rather than inside the main() function, ensuring that network modules are properly patched before any client libraries are imported.

Comment thread core/packages/gax/samples/observability.js Outdated
@shivanee-p
shivanee-p marked this pull request as ready for review September 26, 2026 00:22
@shivanee-p
shivanee-p requested a review from a team as a code owner September 26, 2026 00:22
@shivanee-p
shivanee-p enabled auto-merge (squash) September 26, 2026 00:22
@shivanee-p shivanee-p changed the title feat(gax): add o11y sample feat(docs): add o11y sample Sep 26, 2026

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

I'll mark approve to not hold you up, but it looks like there might be a few things to look at.

Comment thread core/packages/gax/samples/README.md Outdated
Comment thread core/packages/gax/samples/observability.js Outdated
Comment thread core/packages/gax/samples/observability.js Outdated
Comment thread core/packages/gax/samples/observability.js Outdated
Comment thread core/packages/gax/samples/system-test/test.observability.js Outdated
@feywind
feywind disabled auto-merge September 28, 2026 17:51
@shivanee-p
shivanee-p force-pushed the shivaneep-o11y-sample branch from ee8f0ae to 8d51928 Compare September 28, 2026 22:18
@shivanee-p
shivanee-p removed the request for review from danieljbruce September 28, 2026 22:20
@shivanee-p
shivanee-p enabled auto-merge (squash) September 28, 2026 22:26
@shivanee-p
shivanee-p merged commit c0e0540 into main Sep 28, 2026
50 checks passed
@shivanee-p
shivanee-p deleted the shivaneep-o11y-sample branch September 28, 2026 22:34
@release-please release-please Bot mentioned this pull request Sep 28, 2026
codyoss pushed a commit that referenced this pull request Sep 29, 2026
🤖 I have created a release *beep* *boop*
---


<details><summary>google-gax: 6.10.0</summary>

##
[6.10.0](google-gax-v6.9.0...google-gax-v6.10.0)
(2026-09-29)


### Features

* **docs:** Add o11y sample
([#9456](#9456))
([c0e0540](c0e0540))
</details>

<details><summary>api-gateway: 5.4.0</summary>

##
[5.4.0](api-gateway-v5.3.1...api-gateway-v5.4.0)
(2026-09-29)


### Features

* Update API sources and regenerate
([#9472](#9472))
([514e2f6](514e2f6))
</details>

<details><summary>google-cloud-bigtable-api: 0.9.0</summary>

##
[0.9.0](google-cloud-bigtable-api-v0.8.0...google-cloud-bigtable-api-v0.9.0)
(2026-09-29)


### Features

* Update API sources and regenerate
([#9472](#9472))
([514e2f6](514e2f6))
</details>

<details><summary>compute: 7.6.0</summary>

##
[7.6.0](compute-v7.5.1...compute-v7.6.0)
(2026-09-29)


### Features

* Update API sources and regenerate
([#9472](#9472))
([514e2f6](514e2f6))
</details>

<details><summary>dataform: 3.4.0</summary>

##
[3.4.0](dataform-v3.3.1...dataform-v3.4.0)
(2026-09-29)


### Features

* Update API sources and regenerate
([#9472](#9472))
([514e2f6](514e2f6))
</details>

<details><summary>dialogflow: 8.2.0</summary>

##
[8.2.0](dialogflow-v8.1.1...dialogflow-v8.2.0)
(2026-09-29)


### Features

* Update API sources and regenerate
([#9472](#9472))
([514e2f6](514e2f6))
</details>

<details><summary>retail: 5.4.0</summary>

##
[5.4.0](retail-v5.3.1...retail-v5.4.0)
(2026-09-29)


### Features

* Update API sources and regenerate
([#9472](#9472))
([514e2f6](514e2f6))
</details>

<details><summary>health: 0.8.0</summary>

##
[0.8.0](health-v0.7.0...health-v0.8.0)
(2026-09-29)


### Features

* Update API sources and regenerate
([#9472](#9472))
([514e2f6](514e2f6))
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

samples Issues that are directly related to samples.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants