docs(analytics): document --include-external and refresh the report doc - #529
Merged
yanaSelin merged 1 commit intoSep 4, 2026
Merged
Conversation
gokhanozdemir
marked this pull request as ready for review
September 3, 2026 12:49
yanaSelin
approved these changes
Sep 4, 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.
What
Refreshes
docs/ANALYTICS-REPORT.mdso it reflects the currentcodemie analyticssurface. The centrepiece is--include-external, which was shipped in #410 and never documented anywhere.Why
The flag is the "show me all of my local agent usage" switch, and people keep asking for that capability even though it already exists — a discoverability defect, not a missing feature.
The consequence of the silence: a user who ran
claude,codex,gemini,pi, orcopilotdirectly, then rancodemie analytics --report, saw none of that spend and got no hint it had been withheld. The exclusion is deliberate (the ownership gate keeps unmanaged runs out of CodeMie's adoption numbers) but it reads as missing data when it is undocumented.Changes
providertags (native,native-external,native-unmanaged), why external sessions are excluded by default, and the trade-off of the wider view: external sessions have no CodeMie run to attribute to, and their cost depends on a native log that may have rotated away.--include-externalsurfaced in Quick Start and given its own "Source flags" block in the CLI Reference.--no-scan-native --include-externaladds nothing (the first flag suppresses what the second asks for), and--include-externalis unavailable onanalytics otel.Stale claims corrected against source:
--no-analytics-reporton 3 agents.json, shared base name.report.json, so it can't collide with--export jsoncodemie-analytics-YYYY-MM-DD.htmlVerified as still accurate and left alone: the "nine interactive views" count.
Follow-up worth a decision
No agent sets
analyticsOnly: truetoday —copilot-cli.registry.test.ts:27asserts it explicitly is not. Sonative-unmanagedis a code path with no members, and Copilot CLI sessions are hidden from the default report like any other external run. This PR documents that as-is. If the intent was for Copilot CLI to be always-visible, that is a separate code change, and the provenance table here would need updating with it.Verification
Docs-only; no code touched. Claims were read from
analytics/index.ts,native-loader.ts,sessions-source.ts,report-generator.ts, andreport/template.htmlrather than from live CLI output —--helpcould not be run in the authoring environment.tsc --noEmitpassed at commit time. The Gitleaks pre-commit gate was skipped: no container engine on the machine (validate-secrets.jsrequires one). Worth re-running in CI.