feat: Add a --session-summary flag#7347
Conversation
There was a problem hiding this comment.
Summary of Changes
Hello @leehagoodjames, 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 introduces a new --session-summary command-line flag to the gemini-cli tool. This flag enables users to output detailed session statistics, such as API usage, token counts, and tool call metrics, into a specified JSON file. This enhancement provides a structured way to capture and analyze the performance and activity of gemini-cli sessions.
Highlights
- New CLI Flag: Implemented a --session-summary flag, allowing users to specify a JSON file for storing session metrics.
- Session Metrics Export: The CLI now collects and exports comprehensive session data, including model API requests, token usage (prompt, candidates, total, cached), and tool call statistics (total calls, success/fail, duration, decisions).
- Automated Cleanup Integration: The session summary is written to the specified file as part of the application's exit cleanup process, ensuring data is captured even in non-interactive modes.
- New Integration Test: A dedicated integration test (session-summary.test.ts) has been added to validate the correct functionality of the --session-summary flag in non-interactive scenarios.
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. ↩
There was a problem hiding this comment.
Code Review
This pull request introduces a --session-summary flag to output session metrics to a JSON file. The implementation correctly adds the command-line argument and registers a cleanup function to write the file. However, the cleanup function is only triggered for non-interactive mode. For interactive mode, the call to runExitCleanup() is missing, which means the session summary file will not be written. This should be addressed to fully meet the feature's requirements as described.
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. |
eaa4352 to
4a5eaa3
Compare
4a5eaa3 to
853b912
Compare
|
Thanks. It would be very useful if the summary stats file could also include the Session ID. |
(cherry picked from commit 6a9fb6d)
TLDR
Support a
--session-summaryflag that stores summary stats in a json object to evaluate multi-turn runs as well as for stats in nonInteractive mode (such as GitHub Actions).Dive Deeper
Example invocations
Example JSON file
Reviewer Test Plan
They should ensure
--session-summaryWAI, in interactive and non-interactive modes.Testing Matrix
Linked issues / bugs
Related to #6757