feat(telemetry): anonymous usage telemetry — documented schema, opt-out, public ingest worker (#834)

Adds anonymous usage statistics (commands/tools used, languages indexed,
connecting agents) with a strict, auditable allowlist. Never code, paths,
file/symbol names, queries, or IPs.

- src/telemetry/: zero-dep client — consent resolution (DO_NOT_TRACK >
  CODEGRAPH_TELEMETRY > stored choice > default-on), random machine UUID,
  in-memory counters → capped JSONL buffer → completed-day rollups; sync
  exit-append (survives process.exit) + opportunistic bounded sends; the
  first-run notice gates the first SEND, never local buffering, so the
  installer's consent toggle always precedes it. Off is off: no recording,
  no socket, buffered data deleted.
- codegraph telemetry status|on|off; per-command counting via preAction hook.
- MCP: tool counting after the reply is on the wire (session + proxy
  in-process fallback), agent attribution from initialize clientInfo,
  unref'd daemon flush interval. Zero hot-path cost, zero stdout.
- Installer: visible default-on consent toggle (asked once, never re-asked),
  install/index/uninstall lifecycle events.
- telemetry-worker/: public Cloudflare Worker behind telemetry.getcodegraph.com
  — allowlist validation, IP stripping, per-machine rate limit, forwards to
  PostHog as anonymous events. Ships nowhere with the npm package.
- TELEMETRY.md (field-by-field contract) + README section + design doc.
- 20 unit tests; suite-wide CODEGRAPH_TELEMETRY=0 guard so tests never
  pollute real telemetry. Full suite: 1448 passing.

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
Colby Mchenry
2026-06-12 10:37:19 -05:00
committed by GitHub
co-authored by Claude Opus 4.8
parent 7db4c1d2f8
commit 848fde9f59
20 changed files with 3234 additions and 1 deletions
+13
View File
@@ -19,6 +19,7 @@ import { tools } from './tools';
import { SERVER_INSTRUCTIONS, SERVER_INSTRUCTIONS_UNINDEXED } from './server-instructions';
import { CodeGraphPackageVersion } from './version';
import { findNearestCodeGraphRoot } from '../directory';
import { getTelemetry, ClientInfo } from '../telemetry';
/**
* MCP Server Info — kept on the session because some clients log it. The
@@ -82,6 +83,8 @@ export interface MCPSessionOptions {
*/
export class MCPSession {
private clientSupportsRoots = false;
/** From the initialize handshake — attributes usage rollups to the agent host. */
private clientInfo: ClientInfo | undefined;
private rootsAttempted = false;
private resolvePromise: Promise<void> | null = null;
private explicitProjectPath: string | null;
@@ -162,9 +165,16 @@ export class MCPSession {
rootUri?: string;
workspaceFolders?: Array<{ uri: string; name: string }>;
capabilities?: { roots?: unknown };
clientInfo?: { name?: unknown; version?: unknown };
} | undefined;
this.clientSupportsRoots = !!params?.capabilities?.roots;
if (params?.clientInfo) {
this.clientInfo = {
name: typeof params.clientInfo.name === 'string' ? params.clientInfo.name : undefined,
version: typeof params.clientInfo.version === 'string' ? params.clientInfo.version : undefined,
};
}
// Explicit project signal, strongest first: client-provided rootUri /
// workspaceFolders (LSP-style), else the --path the server was launched
@@ -249,6 +259,9 @@ export class MCPSession {
const result = await this.engine.getToolHandler().execute(toolName, toolArgs);
this.transport.sendResult(request.id, result);
// After the reply is on the wire — telemetry must never delay a tool
// response (in-memory increment only; see src/telemetry).
getTelemetry().recordUsage('mcp_tool', toolName, !result.isError, this.clientInfo);
}
/**