docs: clarify telemetry setup and comprehensive data map

[jerop]

Refactored the telemetry guide to focus on the value of logs, metrics, and traces as the foundation for AI observability.

• Simplified Google Cloud setup with two authentication methods (ADC vs CLI Auth).
• Moved developer-only collector scripts to the local development guide.
• Added a centralized 'View Google Cloud telemetry' section with direct console links and official documentation.
• Completed a comprehensive scan of the telemetry implementation to include all missing logs, metrics, and trace attributes.
• Standardized headings, introductory paragraphs, and applied 80-character text wrapping.

Closes #21882
Preview: https://github.com/google-gemini/gemini-cli/blob/docs/clarify-telemetry/docs/cli/telemetry.md

[github-actions]

Size Change: -4 B (0%)

Total Size: 26.2 MB

ℹ️ View Unchanged

Filename	Size	Change
./bundle/gemini.js	25.7 MB	-4 B (0%)
./bundle/node_modules/@google/gemini-cli-devtools/dist/client/main.js	221 kB	0 B
./bundle/node_modules/@google/gemini-cli-devtools/dist/src/_client-assets.js	227 kB	0 B
./bundle/node_modules/@google/gemini-cli-devtools/dist/src/index.js	11.5 kB	0 B
./bundle/node_modules/@google/gemini-cli-devtools/dist/src/types.js	132 B	0 B
./bundle/sandbox-macos-permissive-open.sb	890 B	0 B
./bundle/sandbox-macos-permissive-proxied.sb	1.31 kB	0 B
./bundle/sandbox-macos-restrictive-open.sb	3.36 kB	0 B
./bundle/sandbox-macos-restrictive-proxied.sb	3.56 kB	0 B
./bundle/sandbox-macos-strict-open.sb	4.82 kB	0 B
./bundle/sandbox-macos-strict-proxied.sb	5.02 kB	0 B

_{compressed-size-action}

[gemini-code-assist]

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 significantly enhances the Gemini CLI's observability documentation by restructuring the telemetry guide. The changes aim to provide a clearer, more concise understanding of how logs, metrics, and traces contribute to AI observability, simplifying the setup process for Google Cloud, and centralizing information for viewing telemetry data. This refactoring improves the user experience for developers seeking to debug and optimize agent behavior.

Highlights

• Telemetry Guide Refactoring: The telemetry guide was refactored to emphasize the value of logs, metrics, and traces as foundational for AI observability.
• Simplified Google Cloud Setup: Google Cloud telemetry setup was simplified by clarifying two authentication methods: Application Default Credentials (ADC) and CLI Auth.
• Developer-Only Scripts Relocation: Developer-only collector scripts were moved from the main telemetry guide to the local development guide for better organization.
• Centralized Google Cloud Telemetry Viewing: A new, centralized section was added for viewing Google Cloud telemetry, including direct console links and official documentation references.
• Comprehensive Telemetry Data Map Update: A thorough review of the telemetry implementation was completed, resulting in the inclusion of all previously missing logs, metrics, and trace attributes.
• Documentation Formatting Standardization: Headings, introductory paragraphs, and text wrapping were standardized to an 80-character limit across the documentation.

Changelog

• docs/cli/telemetry.md
  • Updated the introductory content to highlight AI observability and the three pillars of telemetry.
  • Streamlined the 'OpenTelemetry integration' and 'Configuration' sections for clarity.
  • Revised the Google Cloud telemetry prerequisites, detailing ADC and CLI Auth methods.
  • Removed the 'Collector-based export (advanced)' sections for both Google Cloud and local telemetry.
  • Introduced a dedicated 'View Google Cloud telemetry' section with direct links to console explorers and official documentation.
  • Condensed and updated the descriptions of logs, metrics, and traces, including new miscellaneous log entries and refined trace attributes.
  • Applied consistent 80-character text wrapping throughout the document.
• docs/local-development.md
  • Updated the introductory text for local development features and tracing.
  • Renamed sections for viewing traces to 'View traces', 'Use Genkit', and 'Use Jaeger'.
  • Added a new 'Use Google Cloud' section for viewing traces via an OpenTelemetry collector.
  • Clarified the output description for the npm run telemetry command and added collector log file paths.
  • Refined the explanation and example for instrumenting code with runInDevTraceSpan.

Activity

• No human activity has been recorded on this pull request yet.

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

[gemini-code-assist]

Code Review

This pull request significantly refactors the telemetry documentation to improve clarity and structure. The changes simplify the setup instructions for Google Cloud, move developer-specific collector information to the local development guide, and centralize instructions for viewing telemetry data.

While the refactoring is a great improvement, I've identified a couple of areas where important information was removed. One is a warning about a specific configuration conflict (useCliAuth and useCollector), and the other is the removal of detailed attribute lists for logs and metrics, which reduces the document's utility as a comprehensive data reference. My review includes suggestions to restore this information to ensure the documentation remains complete and accurate for users.

_{Note: Security Review has been skipped due to the limited scope of the PR.}

[mattKorwel]

LGTM