copilot-metrics 0.1.3 → 0.1.5

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## 0.1.5 - 2026-05-31
+
+### Fixed
+
+- VS Code Copilot token usage is now attributed to Jira labels by matching OTel `gen_ai.response.id` values to VS Code chat session `responseId` values.
+- Existing local stores with older VS Code usage rows are repaired by backfilling missing response IDs from already imported raw OTel records.
+- VS Code chat session files are parsed only in memory for label extraction; full chat content is not persisted in the metrics store.
+- Versioned model IDs such as dated Copilot telemetry model names now use the canonical per-token pricing row when one is available, so estimates show what the token usage would cost even during included or `0x` periods.
+
+## 0.1.4 - 2026-05-31
+
+### Changed
+
+- `setup` now performs setup by default: VS Code settings are merged into user settings and Copilot hooks are installed for the selected scope. `--print` keeps the old print-only behavior.
+- `report label <id>` now includes a per-model breakdown by default while `report labels` remains accumulated by label.
+- Human reports rename `Credits`/`Status` to clearer `AI Credits est.` and `Usage status` wording.
+
+### Fixed
+
+- `hooks --surface both` now installs both Copilot CLI and VS Code hook event names.
+- Report auto-import skips already imported Copilot session-state files and imported JSONL lines instead of reparsing all historical session files on each report.
+- Existing config files are upgraded with the Copilot session-state source instead of being left stale.
+
 ## 0.1.3 - 2026-05-31
 
 ### Fixed

package/README.md

@@ -9,8 +9,8 @@ Costs are estimates, not official billing records. GitHub billing remains the so
 From npm:
 
 ```bash
-npx copilot-metrics@0.1.3 --help
-npx copilot-metrics@0.1.3 init
+npx copilot-metrics@0.1.5 --help
+npx copilot-metrics@0.1.5 init
 ```
 
 From this checkout:
@@ -38,27 +38,35 @@ export COPILOT_METRICS_HOME=/path/to/copilot-metrics-data
 Useful commands:
 
 ```bash
-npx copilot-metrics@0.1.3 init
-npx copilot-metrics@0.1.3 paths --json
+npx copilot-metrics@0.1.5 init
+npx copilot-metrics@0.1.5 paths --json
 ```
 
+`init` only creates the central data directory and local config. It does not modify editor or hook settings. `setup` performs integration setup for the current machine/workspace.
+
 ## Configure Telemetry
 
 For Copilot CLI, `init` plus hooks are enough for local token reporting. Reports import Copilot's local session-state `events.jsonl` files and extract shutdown usage totals without requiring telemetry environment variables.
 
-Print VS Code Insiders Copilot Chat OpenTelemetry settings:
+Install VS Code Copilot Chat OpenTelemetry settings:
+
+```bash
+npx copilot-metrics@0.1.5 setup vscode
+```
+
+Install Copilot CLI hooks for the current workspace:
 
 ```bash
-npx copilot-metrics@0.1.3 setup vscode
+npx copilot-metrics@0.1.5 setup copilot-cli
 ```
 
-Print Copilot CLI OpenTelemetry environment exports:
+Or set up both VS Code settings and workspace hooks in one command:
 
 ```bash
-npx copilot-metrics@0.1.3 setup copilot-cli
+npx copilot-metrics@0.1.5 setup
 ```
 
-This is optional. Use it only when you also want Copilot CLI OTel JSONL output.
+Use `setup vscode --print` or `setup copilot-cli --print` to print the settings/optional environment exports without writing files. Copilot CLI OTel exports are optional because CLI token usage is read from local session-state files.
 
 Content capture is disabled by default. Do not enable richer prompt capture unless you explicitly accept the privacy tradeoff.
 
@@ -67,14 +75,14 @@ Content capture is disabled by default. Do not enable richer prompt capture unle
 Preview repo-local hook config. The default `--surface both` emits the Copilot CLI lower camel case hook format:
 
 ```bash
-npx copilot-metrics@0.1.3 hooks preview --scope local --surface both
+npx copilot-metrics@0.1.5 hooks preview --scope local --surface both
 ```
 
 Install repo-local or user-global hook config:
 
 ```bash
-npx copilot-metrics@0.1.3 hooks install --scope local --surface both
-npx copilot-metrics@0.1.3 hooks install --scope global --surface both
+npx copilot-metrics@0.1.5 hooks install --scope local --surface both
+npx copilot-metrics@0.1.5 hooks install --scope global --surface both
 ```
 
 Local install writes `.github/hooks/copilot-metrics.json`. Global install updates `~/.copilot/settings.json` idempotently, replacing prior `copilot-metrics` hook entries while preserving other settings and hooks. Use `--surface vscode` for VS Code-only PascalCase events or `--surface copilot-cli` for CLI-native lower camel case events. The hook logger writes redacted JSONL metadata to the central data directory. It extracts Jira-style labels such as `DEMO-12345` from safe metadata and does not store full prompt text by default.
@@ -84,35 +92,40 @@ Local install writes `.github/hooks/copilot-metrics.json`. Global install update
 Initialize the local SQLite store and import JSONL files manually:
 
 ```bash
-npx copilot-metrics@0.1.3 store init
-npx copilot-metrics@0.1.3 import --source vscode --file ~/.local/share/copilot-metrics/telemetry/vscode-copilot-otel.jsonl
-npx copilot-metrics@0.1.3 import --source copilot-cli --file ~/.local/share/copilot-metrics/telemetry/copilot-cli-otel.jsonl
-npx copilot-metrics@0.1.3 import --source copilot-session --file ~/.copilot/session-state/<session-id>/events.jsonl
-npx copilot-metrics@0.1.3 import --source hooks --file ~/.local/share/copilot-metrics/hooks/copilot-hooks.jsonl
+npx copilot-metrics@0.1.5 store init
+npx copilot-metrics@0.1.5 import --source vscode --file ~/.local/share/copilot-metrics/telemetry/vscode-copilot-otel.jsonl
+npx copilot-metrics@0.1.5 import --source copilot-cli --file ~/.local/share/copilot-metrics/telemetry/copilot-cli-otel.jsonl
+npx copilot-metrics@0.1.5 import --source copilot-session --file ~/.copilot/session-state/<session-id>/events.jsonl
+npx copilot-metrics@0.1.5 import --source vscode-chat --file ~/.config/Code\ -\ Insiders/User/workspaceStorage/<workspace-id>/chatSessions/<session-id>.jsonl
+npx copilot-metrics@0.1.5 import --source hooks --file ~/.local/share/copilot-metrics/hooks/copilot-hooks.jsonl
 ```
 
-Imports persist raw records, normalized LLM usage records, hook events, label evidence, and import warnings. Re-importing the same JSONL rows is idempotent. For Copilot session-state files, only shutdown usage rows are persisted; prompt-bearing session events are used in memory for label extraction and context and are not stored as raw records.
+Imports persist raw records, normalized LLM usage records, hook events, label evidence, and import warnings. Re-importing the same JSONL rows is idempotent. For Copilot session-state files, only shutdown usage rows are persisted; prompt-bearing session events are used in memory for label extraction and context and are not stored as raw records. VS Code chat session files are also parsed only in memory, then reduced to label evidence linked to VS Code OTel usage by exact response ID.
 
 ## Reports
 
 Run local reports from the SQLite store:
 
 ```bash
-npx copilot-metrics@0.1.3 report labels
-npx copilot-metrics@0.1.3 report label DEMO-12345
-npx copilot-metrics@0.1.3 report label DEMO-12345 --detail
-npx copilot-metrics@0.1.3 report models
-npx copilot-metrics@0.1.3 report repos
-npx copilot-metrics@0.1.3 report unattributed
+npx copilot-metrics@0.1.5 report labels
+npx copilot-metrics@0.1.5 report label DEMO-12345
+npx copilot-metrics@0.1.5 report label DEMO-12345 --detail
+npx copilot-metrics@0.1.5 report models
+npx copilot-metrics@0.1.5 report repos
+npx copilot-metrics@0.1.5 report unattributed
 ```
 
 Every report supports `--json`:
 
 ```bash
-npx copilot-metrics@0.1.3 report labels --json
+npx copilot-metrics@0.1.5 report labels --json
 ```
 
-Report commands automatically import newly appended configured VS Code OTel, optional Copilot CLI OTel, Copilot CLI session-state, and hook JSONL files before querying. Label reports include input, output, cache read, cache creation, and reasoning token totals. Labels seen only in hooks remain visible as hook-only evidence with zero usage records, so attribution hints do not imply token-bearing usage.
+Report commands automatically import newly appended configured VS Code OTel, VS Code chat session metadata, optional Copilot CLI OTel, Copilot CLI session-state, and hook JSONL files before querying. Repeated reports skip already imported session-state files and already imported JSONL lines.
+
+`report labels` shows accumulated totals per label. `report label <id>` shows the selected label summary plus a per-model breakdown by default. Label reports include input, output, cache read, cache creation, and reasoning token totals. Labels seen only in hooks remain visible as `evidence-only` with zero usage records, so attribution hints do not imply token-bearing usage.
+
+`AI Credits est.` is a local what-would-this-cost estimate derived from the token pricing table, not a claim that the interaction was billed today. Some included or request-based models can appear as `0x` in Copilot while still having published per-token prices. The project treats 1 AI Credit as $0.01 for estimates; GitHub billing remains the source of truth.
 
 ## Attribution Model
 
@@ -120,6 +133,8 @@ The default extractor finds Jira-style labels such as `DEMO-12345` from safe met
 
 Attribution is stored as evidence with source, field, session, repo, branch, cwd, confidence, and related usage or hook record IDs. This makes the data useful for later analysis, such as deciding whether a label was the main task or a sidetrack.
 
+For VS Code Copilot Chat, token records from OTel are linked to chat labels by exact response ID. The OTel `gen_ai.response.id` value must match the VS Code chat session `responseId`; timestamp-only attribution is not used.
+
 Full prompt content is not stored by default. Prompt-like fields are only used to extract labels and the stored source value is reduced to the matched label.
 
 ## Custom Label Extractors
@@ -175,7 +190,7 @@ The manual prompt performs one harmless tool call so Copilot CLI hook execution
 ## Current Limits
 
 - Costs are estimates, not official billing records.
-- Official GitHub usage report reconciliation is not included in `0.1.3`.
-- Local OTLP collector mode is not included in `0.1.3`.
-- Richer prompt/content capture and redaction controls are not included in `0.1.3`.
+- Official GitHub usage report reconciliation is not included in `0.1.5`.
+- Local OTLP collector mode is not included in `0.1.5`.
+- Richer prompt/content capture and redaction controls are not included in `0.1.5`.
 - Dashboard views are deferred until the CLI/query model proves useful.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "copilot-metrics",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "Local-first Copilot usage telemetry setup and reporting tools.",
   "type": "commonjs",
   "homepage": "https://github.com/nnexai/copilot-metrics#readme",

package/src/cli.js

@@ -4,6 +4,7 @@ const { resolvePaths } = require('./paths');
 const {
   ensureDataDirs,
   vscodeSettings,
+  installVscodeSettings,
   copilotCliEnvironment,
   shellExports,
   hookConfig,
@@ -17,12 +18,13 @@ const { MODEL_PRICES, PRICING_VERSION } = require('./pricing');
 const {
   labelOverview,
   labelSummary,
+  labelModelBreakdown,
   labelDetails,
   modelReport,
   repoReport,
   unattributedReport,
   formatLabels,
-  formatLabelSummary,
+  formatLabelReport,
   formatModels,
   formatRepos,
   formatUnattributed,
@@ -70,13 +72,14 @@ function helpText() {
 Usage:
   copilot-metrics init [--json]
   copilot-metrics paths [--json]
-  copilot-metrics setup vscode [--json]
-  copilot-metrics setup copilot-cli [--json]
+  copilot-metrics setup [all] [--scope local|global] [--json]
+  copilot-metrics setup vscode [--settings-file <path>] [--json]
+  copilot-metrics setup copilot-cli [--scope local|global] [--json]
   copilot-metrics hooks preview [--scope local|global] [--surface both|vscode|copilot-cli] [--json]
   copilot-metrics hooks install [--scope local|global] [--surface both|vscode|copilot-cli] [--json]
   copilot-metrics hook-log --event <name>
   copilot-metrics store init [--json]
-  copilot-metrics import --source vscode|copilot-cli|copilot-session|hooks --file <path> [--json]
+  copilot-metrics import --source vscode|vscode-chat|copilot-cli|copilot-session|hooks --file <path> [--json]
   copilot-metrics report labels [--json]
   copilot-metrics report label <id> [--detail] [--json]
   copilot-metrics report models [--json]
@@ -111,6 +114,13 @@ function formatVscode(settings) {
   ].join('\n');
 }
 
+function formatVscodeInstall(results) {
+  return [
+    `Installed VS Code Copilot telemetry settings: ${results.map((result) => result.target).join(', ')}`,
+    'Content capture is disabled.',
+  ].join('\n');
+}
+
 function formatCopilotCli(env) {
   return [
     'Export these variables before running Copilot CLI:',
@@ -122,6 +132,13 @@ function formatCopilotCli(env) {
   ].join('\n');
 }
 
+function formatCopilotCliSetup(result) {
+  return [
+    `Installed ${result.scope} Copilot hook config: ${result.target}`,
+    'Copilot CLI token usage is imported from local session-state; OTel exports are optional.',
+  ].join('\n');
+}
+
 function telemetryDiagnostics(importResults) {
   const hookResult = importResults.find((result) => result.source === 'hooks' && result.raw_records > 0);
   if (!hookResult) return [];
@@ -189,23 +206,49 @@ async function main(args, io) {
 
   if (command === 'setup') {
     if (subcommand === 'vscode') {
-      const settings = vscodeSettings(paths);
-      writeOutput(io.stdout, json ? settings : formatVscode(settings), json);
+      ensureDataDirs(paths);
+      if (flags.print === true || flags.dryRun === true) {
+        const settings = vscodeSettings(paths);
+        writeOutput(io.stdout, json ? settings : formatVscode(settings), json);
+        return;
+      }
+      const results = installVscodeSettings(paths, { env: io.env, target: flags.settingsFile });
+      writeOutput(io.stdout, json ? { installed: results } : formatVscodeInstall(results), json);
       return;
     }
     if (subcommand === 'copilot-cli') {
-      const env = copilotCliEnvironment(paths);
-      writeOutput(io.stdout, json ? env : formatCopilotCli(env), json);
+      ensureDataDirs(paths);
+      if (flags.print === true || flags.dryRun === true) {
+        const env = copilotCliEnvironment(paths);
+        writeOutput(io.stdout, json ? env : formatCopilotCli(env), json);
+        return;
+      }
+      const result = installHook(paths, {
+        cwd: io.cwd,
+        scope: flags.scope || 'local',
+        surface: 'copilot-cli',
+        command: io.commandPath,
+      });
+      writeOutput(io.stdout, json ? { installed: result } : formatCopilotCliSetup({ ...result, scope: flags.scope || 'local' }), json);
       return;
     }
     if (!subcommand || subcommand === 'all') {
-      const snapshot = setupSnapshot({ env: io.env, cwd: io.cwd, home: flags.home, command: io.commandPath });
+      const snapshot = setupSnapshot({
+        env: io.env,
+        cwd: io.cwd,
+        home: flags.home,
+        command: io.commandPath,
+        install: flags.print !== true && flags.dryRun !== true,
+        scope: flags.scope || 'local',
+        surface: flags.surface || 'both',
+        target: flags.settingsFile,
+      });
       writeOutput(io.stdout, json ? snapshot : [
         formatPaths(snapshot.paths),
         '',
-        formatVscode(snapshot.vscode),
+        snapshot.vscodeInstalled.length ? formatVscodeInstall(snapshot.vscodeInstalled) : formatVscode(snapshot.vscode),
         '',
-        formatCopilotCli(snapshot.copilotCli),
+        snapshot.hooksInstalled ? formatCopilotCliSetup({ ...snapshot.hooksInstalled, scope: flags.scope || 'local' }) : formatCopilotCli(snapshot.copilotCli),
       ].join('\n'), json);
       return;
     }
@@ -262,8 +305,8 @@ async function main(args, io) {
         : source === 'hooks'
           ? paths.hookEventsJsonl
           : null);
-    if (!['vscode', 'copilot-cli', 'copilot-session', 'hooks'].includes(source)) {
-      throw new Error('import requires --source vscode|copilot-cli|copilot-session|hooks');
+    if (!['vscode', 'vscode-chat', 'copilot-cli', 'copilot-session', 'hooks'].includes(source)) {
+      throw new Error('import requires --source vscode|vscode-chat|copilot-cli|copilot-session|hooks');
     }
     if (!file) throw new Error('import requires --file <path>');
     ensureDataDirs(paths);
@@ -301,12 +344,13 @@ async function main(args, io) {
       const label = rest[2];
       if (!label) throw new Error('report label requires <id>');
       const summary = await labelSummary(paths.usageDb, label);
+      const models = await labelModelBreakdown(paths.usageDb, label);
       if (flags.detail === true) {
         const details = await labelDetails(paths.usageDb, label);
-        writeOutput(io.stdout, json ? { label: summary, details, diagnostics } : appendDiagnostics(formatLabelSummary(summary, details), diagnostics), json);
+        writeOutput(io.stdout, json ? { label: summary, models, details, diagnostics } : appendDiagnostics(formatLabelReport(summary, models, details), diagnostics), json);
         return;
       }
-      writeOutput(io.stdout, json ? { label: summary, diagnostics } : appendDiagnostics(formatLabelSummary(summary), diagnostics), json);
+      writeOutput(io.stdout, json ? { label: summary, models, diagnostics } : appendDiagnostics(formatLabelReport(summary, models), diagnostics), json);
       return;
     }
     if (subcommand === 'models') {