Skip to content

docs(spanner): Update client side metrics and permission issues in README #13491

Merged
sakthivelmanii merged 3 commits intomainfrom
update_client_libraries_readme_to_mention_permission_issue
Dec 17, 2025
Merged

docs(spanner): Update client side metrics and permission issues in README #13491
sakthivelmanii merged 3 commits intomainfrom
update_client_libraries_readme_to_mention_permission_issue

Conversation

@sakthivelmanii
Copy link
Copy Markdown
Contributor

@sakthivelmanii sakthivelmanii commented Dec 17, 2025

No description provided.

@sakthivelmanii sakthivelmanii requested review from a team December 17, 2025 07:24
@sakthivelmanii sakthivelmanii requested a review from a team as a code owner December 17, 2025 07:24
@product-auto-label product-auto-label bot added the api: spanner Issues related to the Spanner API. label Dec 17, 2025
@gemini-code-assist
Copy link
Copy Markdown
Contributor

gemini-code-assist bot commented Dec 17, 2025

Summary of Changes

Hello @sakthivelmanii, 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 significantly enhances the documentation for the Cloud Spanner client by introducing a dedicated section in the README.md file. This new content thoroughly explains the concept and utility of client-side metrics, detailing their default activation, methods for disabling them, and the essential IAM permissions required for successful metric export. The update aims to provide users with clearer guidance for monitoring and troubleshooting their Spanner applications.

Highlights

  • New Metrics Documentation: A new section titled 'Metrics' has been added to the spanner/README.md file, providing comprehensive information on Cloud Spanner client-side metrics.
  • Client-Side Metrics Details: The documentation now explains what client-side metrics are, how they differ from server-side metrics, and that they are enabled by default.
  • Disabling Metrics: Instructions are provided on how to opt out of client-side metrics programmatically using spanner.ClientConfig{DisableNativeMetrics: true} and via the SPANNER_DISABLE_BUILTIN_METRICS environment variable.
  • IAM Permissions for Metrics: Crucially, the updated README clarifies that monitoring.timeSeries.create IAM permission is required to export metrics data, recommending the Monitoring Metric Writer role.
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.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

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

@sakthivelmanii
Copy link
Copy Markdown
Contributor Author

sakthivelmanii commented Dec 17, 2025

/gemini review

gemini-code-assist[bot]
gemini-code-assist bot reviewed Dec 17, 2025
View reviewed changes
Copy link
Copy Markdown
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 updates the spanner/README.md to include a new section on client-side metrics. The documentation change is clear and well-structured, explaining what client-side metrics are, how to disable them, and the necessary IAM permissions. I have one suggestion to improve the phrasing of the note on IAM permissions for better clarity and grammar.

gemini-code-assist[bot]
gemini-code-assist bot reviewed Dec 17, 2025
View reviewed changes
Copy link
Copy Markdown
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 adds a helpful section to the spanner/README.md file about client-side metrics. The new documentation clearly explains what these metrics are, how to disable them, and the necessary IAM permissions. The changes are well-structured and informative. I have one minor suggestion to improve the wording for clarity and grammatical correctness in the note about IAM permissions.

@sakthivelmanii @gemini-code-assist
Update spanner/README.md
44c33ce 
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@sakthivelmanii
Copy link
Copy Markdown
Contributor Author

sakthivelmanii commented Dec 17, 2025

/gemini review

gemini-code-assist[bot]
gemini-code-assist bot reviewed Dec 17, 2025
View reviewed changes
Copy link
Copy Markdown
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 adds a new section to the spanner/README.md file, documenting the client-side metrics feature. The documentation explains what these metrics are, how to disable them, and the required IAM permissions for exporting them. The added content is valuable and well-structured. I have provided one suggestion to enhance the clarity and formatting of the note regarding IAM permissions, making it easier for users to understand the requirements.

@sakthivelmanii @gemini-code-assist
Update spanner/README.md
9edb7ce 
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@sakthivelmanii sakthivelmanii merged commit ab56892 into main Dec 17, 2025
9 checks passed
@sakthivelmanii sakthivelmanii deleted the update_client_libraries_readme_to_mention_permission_issue branch December 17, 2025 09:21
@rahul2393 rahul2393 mentioned this pull request Feb 11, 2026
Merged
rahul2393 added a commit that referenced this pull request Feb 11, 2026
@rahul2393
chore: librarian release pull request: 20260211T232929Z (#13835)
80561cb 
PR created by the Librarian CLI to initialize a release. Merging this PR
will auto trigger a release.

Librarian Version: v1.0.0
Language Image:
us-central1-docker.pkg.dev/cloud-sdk-librarian-prod/images-prod/librarian-go@sha256:19bb93e8f1f916c61b597db2bad65dc432f79baaabb210499d7d0e4ad1dffe29
<details><summary>spanner: 1.88.0</summary>

##
[1.88.0](spanner/v1.87.0...spanner/v1.88.0)
(2026-02-11)

### Features

* Adding Send and Ack Mutation Support for Cloud Spanner Queue (#13616)
([1cf600d](1cf600d6))

* include cache updates into the ResultSet response (PiperOrigin-RevId:
865546011)
([6f31019](6f310199))

* add a ClientContext field to Spanner requests (PiperOrigin-RevId:
853323071)
([80379ed](80379edb))

* add Secure Parameters to the ClientContext (PiperOrigin-RevId:
853323071)
([80379ed](80379edb))

* PGNumeric implements Scanner and Valuer (#13722)
([85bc9db](85bc9dbf))

* support struct literal (#13766)
([b4a6f4c](b4a6f4c5))

* Exposing total CPU related fields in AutoscalingConfig
(PiperOrigin-RevId: 845819318)
([db65e79](db65e792))

* add ClientContext support (#13775)
([e85d706](e85d7061))

### Bug Fixes

* disable config logging by default (#13478)
([ad19592](ad19592e))

* decode PG JSONB array to PGJsonB struct (#13602)
([d72d0f4](d72d0f45))

### Performance Improvements

* only create sessions if multiplexed sessions are disabled (#13477)
([e44e58f](e44e58f6))

### Documentation

* A comment for field `param_types` in message
`.google.spanner.v1.PartitionQueryRequest` is changed
(PiperOrigin-RevId: 865546011)
([6f31019](6f310199))

* A comment for field `transaction_tag` in message
`.google.spanner.v1.RequestOptions` is changed (PiperOrigin-RevId:
865546011)
([6f31019](6f310199))

* A comment for field `commit_timestamp` in message
`.google.spanner.v1.BatchWriteResponse` is changed (PiperOrigin-RevId:
865546011)
([6f31019](6f310199))

* A comment for field `params` in message
`.google.spanner.v1.PartitionQueryRequest` is changed
(PiperOrigin-RevId: 865546011)
([6f31019](6f310199))

* Update client side metrics and permission issues in README (#13491)
([ab56892](ab56892e))

* Update high_priority_cpu_utilization_percent in AutoscalingConfig to
be Optional and clarify its behavior when not specified
(PiperOrigin-RevId: 845819318)
([db65e79](db65e792))

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

Reviewers

@surbhigarg92 surbhigarg92 surbhigarg92 approved these changes

@rahul2393 rahul2393 rahul2393 approved these changes

+1 more reviewer

@gemini-code-assist gemini-code-assist[bot] gemini-code-assist[bot] left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

api: spanner Issues related to the Spanner API.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@sakthivelmanii @surbhigarg92 @rahul2393