mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-09-01 19:42:03 +00:00
docs(canary): connect canary rollouts to the telemetry docs
Second half of a review comment I had only half-addressed: the opt-out
behaviour shipped in 4f464dc4, but "should we add this into/connected to
the existing telemetry doc?" did not.
There is no standalone telemetry page — the canonical disclosure is the
`telemetry` command section in packages/cli. Links now run both ways so
neither page describes canaries as a separate system:
- packages/cli #telemetry: telemetry state also controls canary
enrolment, with every opt-out route named.
- contributing/canary-rollouts: a Note at the top, before any of the
how-to, saying canaries sit behind the telemetry switch and why (a
canary is a measured rollout; an install that reports nothing cannot be
compared, so enrolling it buys no signal).
- guides/feedback "Opting Out": disabling telemetry also ends canary
enrolment, alongside the feedback prompt and usage tracking.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This commit is contained in:
co-authored by
Claude Opus 5
parent
31361b8e5b
commit
54534d53c2
@@ -8,6 +8,18 @@ exercised on real traffic) or on for everyone (and therefore a fleet-wide
|
||||
bet). A canary is the rung in between — the same change, enabled for a stable
|
||||
slice of installs, ramped as the signal holds.
|
||||
|
||||
<Note>
|
||||
**Canaries are part of telemetry, not a separate system.** A canary is a
|
||||
*measured* rollout: a slice is enrolled specifically so it can be compared
|
||||
against everyone else, and the comparison is what makes ramping safe. An
|
||||
install that reports nothing cannot be compared, so **opting out of telemetry
|
||||
opts you out of canaries** — via `hyperframes telemetry disable`,
|
||||
`HYPERFRAMES_NO_TELEMETRY=1`, `DO_NOT_TRACK=1`, a dev build, or Studio's
|
||||
`hyperframes-studio:telemetryDisabled`. See the
|
||||
[`telemetry` command](/packages/cli#telemetry) for what is collected and how
|
||||
to turn it off; everything on this page sits behind that switch.
|
||||
</Note>
|
||||
|
||||
## Add one
|
||||
|
||||
**1. Register it at 0%.** In `packages/core/src/canaryRegistry.ts`:
|
||||
|
||||
@@ -199,7 +199,7 @@ Studio stores the equivalent state in `localStorage` under the `hyperframes-stud
|
||||
|
||||
### CLI — disable telemetry entirely
|
||||
|
||||
Disabling telemetry suppresses the CLI feedback prompt and all other CLI usage tracking:
|
||||
Disabling telemetry suppresses the CLI feedback prompt, all other CLI usage tracking, and enrolment in any [canary rollout](/contributing/canary-rollouts) — an install that reports nothing is never picked for a staged rollout:
|
||||
|
||||
```bash
|
||||
# Via CLI command (persisted to ~/.hyperframes/config.json)
|
||||
|
||||
@@ -992,6 +992,13 @@ Word-level transcripts (whisper output) are grouped into readable caption cues o
|
||||
|
||||
Telemetry collects command names, render performance, render checkpoint/error names, aggregate browser diagnostic counts, browser initialization duration and tween count, aggregate video extraction workload counts (such as extracted frame count and VFR preflight count), example choices, and system info — including a coarse environment fingerprint (OS, kernel string, CPU/memory shape, sandbox runtime such as gVisor or Docker, and the *name* of a coding agent driving the CLI when one is detected, e.g. `claude_code` / `codex` / `cursor`). The agent name is derived from the existence of well-known environment variables; their values are never read. Telemetry redacts local paths and URL query strings from render error/checkpoint messages and does **not** collect project names, video content, or environment variable values. It collects no personally identifiable information until you sign in: when you authenticate with `hyperframes auth login`, your HeyGen account email (or your username, if your account has no email) is linked to your usage so CLI activity can be associated with your account (and your prior anonymous usage is stitched to it). Nothing else personal is collected, and this only happens after you choose to sign in. Disable all telemetry with `HYPERFRAMES_NO_TELEMETRY=1` or the command above.
|
||||
|
||||
Telemetry state also controls **canary enrolment**: staged rollouts pick a
|
||||
stable slice of installs to enable a change for, and an install that reports
|
||||
nothing cannot be compared against anyone, so opting out of telemetry opts you
|
||||
out of canaries too. Every route counts — `hyperframes telemetry disable`,
|
||||
`HYPERFRAMES_NO_TELEMETRY=1`, `DO_NOT_TRACK=1`, and dev builds. See
|
||||
[Canary rollouts](/contributing/canary-rollouts).
|
||||
|
||||
See [Feedback Collection](/guides/feedback) for how the periodic post-render prompt and Studio feedback bar work, what data they collect, and how to opt out.
|
||||
|
||||
### `skills`
|
||||
|
||||
Reference in New Issue
Block a user