fix(metrics) - Remove the error field from ApiResponseEvent#8207
Merged
fix(metrics) - Remove the error field from ApiResponseEvent#8207
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Summary of Changes
Hello @shishu314, 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 refactors the telemetry system by eliminating an unused 'error' field from the 'ApiResponseEvent' class. This change streamlines the event structure and associated logging and metrics collection, as error reporting is already managed by a dedicated 'ApiErrorEvent'. The modification ensures that the codebase accurately reflects current telemetry practices and reduces unnecessary data points.
Highlights
- Removed Unused Error Field: The 'error' field has been removed from 'ApiResponseEvent' as it was not being utilized for logging errors, which are instead handled by 'ApiErrorEvent'.
- Telemetry Streamlining: The change simplifies the telemetry logging process by removing redundant error handling within 'ApiResponseEvent' and its associated metrics.
- Deprecated Metadata Key: The 'GEMINI_CLI_API_ERROR_MESSAGE' metadata key has been marked as deprecated, reflecting its removal from active use.
- Test Case Updates: Corresponding test cases in 'loggers.test.ts' have been updated to reflect the removal of the 'error' field from 'ApiResponseEvent' logging.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| 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 issue 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
-
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. ↩
Contributor
There was a problem hiding this comment.
Code Review
This pull request correctly removes the unused error field from ApiResponseEvent and its related logic across multiple files, which simplifies the telemetry code. The changes are consistent and well-executed. I have one suggestion to further improve the cleanup by completely removing a now-unused enum key instead of just deprecating it.
packages/core/src/telemetry/clearcut-logger/event-metadata-key.ts
Outdated
Show resolved
Hide resolved
|
Size Change: -308 B (0%) Total Size: 13.2 MB ℹ️ View Unchanged
|
Code Coverage Summary
CLI Package - Full Text ReportCore Package - Full Text ReportFor detailed HTML reports, please see the 'coverage-reports-22.x-ubuntu-latest' artifact from the main CI run. |
richieforeman
approved these changes
Sep 11, 2025
Member
richieforeman
left a comment
richieforeman
left a comment
There was a problem hiding this comment.
Tagging @cornmander for final
giraffe-tree
pushed a commit
to giraffe-tree/gemini-cli
that referenced
this pull request
Oct 10, 2025
…emini#8207) Co-authored-by: Shi Shu <shii@google.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
TLDR
We log our errors with ApiErrorEvent, the error field is not used at all
Dive Deeper
None of our events have this metadata logged, as seen from https://github.com/google-gemini/maintainers-gemini-cli/issues/733
When we have an error, we log it as
ApiErrorEvent:gemini-cli/packages/core/src/core/loggingContentGenerator.ts
Line 125 in b9b6fe1
Reviewer Test Plan
run build and preflight
Testing Matrix
Linked issues / bugs
Fixes https://github.com/google-gemini/maintainers-gemini-cli/issues/733