Repository navigation
Telemetry: FLYTE_DISABLE_SENTRY is honored by the SDK and backend, not the console - #1780
Conversation
Drafted by Docsy for case -1201. Signed-off-by: unionai-docsy-agent[bot] <336110417+unionai-docsy-agent[bot]@users.noreply.github.com>
GHA build & deploy previewBuilt by
Updated automatically on every push. |
…kend only Signed-off-by: unionai-docsy-agent[bot] <336110417+unionai-docsy-agent[bot]@users.noreply.github.com>
|
Signal 2873 holds, so I changed the Web console row in the "What is collected" table. It now reads: "Product analytics through Google Tag Manager. It also sends errors, browser console messages, traces of its network requests, and page performance data through Grafana Faro." Evidence. I checked the console source in unionai/cloud at The opt-out instructions still hold. When Open question: please don't merge until it's answered. The flyteorg/flyte charts deploy Title: it doesn't cover the console change yet. I suggest "Telemetry: FLYTE_DISABLE_SENTRY scope, and the console's Grafana Faro telemetry". Not taken: the optional pre-flight suggestion to say what to set on the console in the Docsy revised this in 1e27377. Reviewed before pushing: 2 to fix; revised twice in response, and 2 remain. |
…unionai-oss/flyteconsole-v2) is built from unionai-oss/flyte2-ui, which has no Faro; and say what to set on the console, which reads only DO_NOT_TRACK and FLYTE_DISABLE_TELEMETRY. Pushed by Docsy at the direction of Peeter Piegaze (ppiegaze). Signed-off-by: unionai-docsy-agent[bot] <336110417+unionai-docsy-agent[bot]@users.noreply.github.com>
|
Docsy actions: what Docsy did on this PR, and at whose direction. Docsy adds a line for each.
|
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues remain for the documentation clarification of telemetry opt-out variable scope.
No open issues 🎉
What changed in this PR
Clarifies the legacy telemetry opt-out variable’s scope in the Flyte documentation.
Changes:
- States that
FLYTE_DISABLE_SENTRYis honored by the SDK, CLI, and backend, but not the web console. - Directs console users to
FLYTE_DISABLE_TELEMETRYorDO_NOT_TRACK.
| File | Description |
|---|---|
content/user-guide/telemetry.md |
Corrects one variable-reference row; no runtime behavior changes. |
Review effort: Balanced
This PR changes one row on one page.
Why
A page audit of
user-guide/telemetry(signal 1201, flyte-sdk v2.11.4) found this row false:"Still honored" implies the variable works wherever
FLYTE_DISABLE_TELEMETRYdoes. The SDK and the backend read it, but the web console doesn't.Change
content/user-guide/telemetry.md, Variables reference table. TheFLYTE_DISABLE_SENTRY=truerow now reads: "Older name forFLYTE_DISABLE_TELEMETRY, honored by the SDK and CLI and the backend. The web console doesn't read it: setFLYTE_DISABLE_TELEMETRYorDO_NOT_TRACKthere."Evidence
main,src/flyte/_sentry.py:49:_DISABLE_ENV_VARS = ("DO_NOT_TRACK", "FLYTE_DISABLE_TELEMETRY", "FLYTE_DISABLE_SENTRY").main,flytestdlib/telemetry/telemetry.go:17:disableEnvVarslists the same three.ghcr.io/unionai-oss/flyteconsole-v2. That image'sorg.opencontainers.image.sourcelabel ishttps://github.com/unionai-oss/flyte2-ui, and its latest tag matches that repo's HEAD (0df2746). In flyte2-ui,src/lib/telemetry.tsreads onlyDO_NOT_TRACKandFLYTE_DISABLE_TELEMETRY, andsrc/app/layout.tsxloads Google Tag Manager only when neither is set.Dropped from an earlier revision
An earlier revision also added Grafana Faro to the Web console row, based on Union's own console source. The OSS console is built from flyte2-ui, which has no Faro dependency or code, so that sentence is gone and the row is unchanged from
main. This also answers the earlier open question: the OSS console image is not a build of Union's console.Revised in session by Peeter Piegaze, at 5ff9760.
Docsy case -1201: https://docsy.apps.demo.hosted.unionai.cloud/cases/-1201
Drafted by Docsy, Union.ai's documentation agent, from a false statement its page audit found. Review it like any PR; close it if it's not wanted.