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:
co-authored by
Claude Opus 4.8
parent
7db4c1d2f8
commit
848fde9f59
@@ -0,0 +1,30 @@
|
||||
// codegraph telemetry ingest — see README.md and docs/design/telemetry.md.
|
||||
// Secrets are NOT configured here: POSTHOG_KEY is set via `wrangler secret put POSTHOG_KEY`.
|
||||
{
|
||||
"$schema": "node_modules/wrangler/config-schema.json",
|
||||
"name": "codegraph-telemetry",
|
||||
"main": "src/index.ts",
|
||||
"compatibility_date": "2026-06-12",
|
||||
"compatibility_flags": ["nodejs_compat"],
|
||||
|
||||
// First-party endpoint. The custom domain auto-provisions DNS + cert when the
|
||||
// getcodegraph.com zone is on the deploying account. workers.dev stays off so
|
||||
// the only public surface is the documented one.
|
||||
"routes": [{ "pattern": "telemetry.getcodegraph.com", "custom_domain": true }],
|
||||
"workers_dev": false,
|
||||
|
||||
"observability": { "enabled": true, "head_sampling_rate": 1 },
|
||||
|
||||
// Non-secret config. Swap host here if the backend ever moves (EU, self-hosted…).
|
||||
"vars": { "POSTHOG_HOST": "https://us.i.posthog.com" },
|
||||
|
||||
// Per-machine_id rate limit. Legit clients flush a handful of times per day;
|
||||
// 6/min absorbs install+index bursts while capping abuse.
|
||||
"ratelimits": [
|
||||
{
|
||||
"name": "MACHINE_RATE_LIMITER",
|
||||
"namespace_id": "1001",
|
||||
"simple": { "limit": 6, "period": 60 }
|
||||
}
|
||||
]
|
||||
}
|
||||
Reference in New Issue
Block a user