feat(copilotcli): enhance usage reporting in CopilotCLISession with detailed token metrics#309440
Merged
DonJayamanne merged 3 commits intomainfrom Apr 13, 2026
Merged
feat(copilotcli): enhance usage reporting in CopilotCLISession with detailed token metrics#309440DonJayamanne merged 3 commits intomainfrom
DonJayamanne merged 3 commits intomainfrom
Conversation
…etailed token metrics
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves token usage reporting for Copilot CLI chat sessions so the chat context-usage indicator can reflect more accurate prompt usage and show a breakdown of prompt token categories, addressing the reported “compaction doesn’t work” symptom.
Changes:
- Adds reporting of
promptTokenDetails(system instructions, tool definitions, messages) alongside prompt/completion token counts. - Listens for
session.usage_infoevents to capture current token distribution and report it to the response stream. - Attempts to refresh usage after each request by querying
_sdkSession.usage.getMetrics().
Show a summary per file
| File | Description |
|---|---|
| extensions/copilot/src/extension/chatSessions/copilotcli/node/copilotcliSession.ts | Adds usage reporting helpers, hooks session.usage_info, and builds prompt token breakdown for the context usage widget. |
Copilot's findings
Comments suppressed due to low confidence (2)
extensions/copilot/src/extension/chatSessions/copilotcli/node/copilotcliSession.ts:585
- The
session.usage_infohandler assumes all token fields are numbers, butevent.dataappears to be untyped (similar toassistant.usage, which guards withtypeof === 'number'). Please add type checks (at least forcurrentTokens) before assigning tolastUsageInfoto avoid propagatingNaN/invalid values into the context usage widget.
disposables.add(toDisposable(this._sdkSession.on('session.usage_info', (event) => {
lastUsageInfo = {
currentTokens: event.data.currentTokens,
systemTokens: event.data.systemTokens,
conversationTokens: event.data.conversationTokens,
extensions/copilot/src/extension/chatSessions/copilotcli/node/copilotcliSession.ts:590
reportUsage(lastUsageInfo.currentTokens, 0)resetscompletionTokensto 0 wheneversession.usage_infofires. The context usage widget computes used tokens aspromptTokens + completionTokens, so this will under-report usage and can cause the indicator to jump backwards if this event arrives afterassistant.usage. Consider preserving the latest known completion token count (or usingmetrics.lastCallOutputTokens) when reportingsession.usage_info.
reportUsage(lastUsageInfo.currentTokens, 0);
})));
- Files reviewed: 1/1 changed files
- Comments generated: 1
extensions/copilot/src/extension/chatSessions/copilotcli/node/copilotcliSession.ts
Show resolved
Hide resolved
roblourens
approved these changes
Apr 13, 2026
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
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.
Fixes #300491