mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-11-19 11:26:02 +00:00
feat(cli,studio): telemetry opt-out is canary opt-out
Both reviewers flagged the same gap: seed injection was gated on telemetryShouldTrack(), but canary EVALUATION was not. An install with DO_NOT_TRACK=1 was still bucketed and still had real code paths flipped (e.g. HF_DE_PARALLEL_ROUTER), silently and unmeasurably. A canary is a measured rollout — we enrol a slice precisely so it can be compared against everyone else. An install that sends nothing can't be compared, so enrolling it buys no signal and only changes that user's code path, on an experimental feature, without their knowledge. That is the wrong side of an opt-out. Resolves to a new `telemetry_opt_out` reason BEFORE bucketing, so no cohort is assigned at all. Distinct from `excluded` because "why is my canary off" has a very different answer for CI than for opted-out, and the reason never reaches telemetry by construction. Covers every opt-out route: persisted preference, the runtime env vars and dev/telemetry-disabled builds via policy.ts, and Studio's hyperframes-studio:telemetryDisabled. An explicit HF_CANARY_* / ?hf_canary_*= override still wins — a deliberate local choice, not silent enrolment, and the documented way to exercise a canary with telemetry off. The CLI check mirrors shouldTrack() rather than importing it: client.ts already imports canary.ts for canaryEventProperties, so depending on it would be a cycle. Both read the same two inputs, so they cannot disagree. Tests: 9 new across CLI and Studio (preference off, each runtime override, no bucket assigned, override still honoured, flag properties all-false). Fault injection: removing the CLI gate fails 6, removing the Studio gate fails 3. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This commit is contained in:
co-authored by
Claude Opus 5
parent
9f2b892a71
commit
4f464dc424
@@ -220,6 +220,20 @@ rm -rf ~/.hyperframes # clears telemetry id, canary cohorts, and breaker stat
|
||||
`hyperframes telemetry status` prints both paths if you want to inspect or
|
||||
delete them individually. Nothing canary-related is stored anywhere else.
|
||||
|
||||
**Opting out of telemetry opts you out of canaries.** A canary is a *measured*
|
||||
rollout — we enrol a slice precisely so it can be compared against everyone
|
||||
else. An install that sends nothing can't be compared, so enrolling it buys no
|
||||
signal and only changes that user's code path, on an experimental feature,
|
||||
without their knowledge. Every opt-out route counts: the persisted preference
|
||||
(`hyperframes telemetry disable`), the runtime env vars
|
||||
(`HYPERFRAMES_NO_TELEMETRY`, `DO_NOT_TRACK`), dev/telemetry-disabled builds,
|
||||
and Studio's `hyperframes-studio:telemetryDisabled`. The decision resolves to
|
||||
`telemetry_opt_out` *before* bucketing, so no cohort is assigned at all.
|
||||
|
||||
An explicit `HF_CANARY_<FEATURE>` (or `?hf_canary_<feature>=` in Studio)
|
||||
override still wins — that is a deliberate local choice, and it stays the way
|
||||
to exercise a canary with telemetry off.
|
||||
|
||||
**It fails closed.** No install id, an unregistered name, or a CI machine all
|
||||
resolve to *not enrolled*. A canary exists to bound blast radius, so "we
|
||||
don't know who this is" must never mean "enrol everyone". CI is excluded
|
||||
|
||||
Reference in New Issue
Block a user