Skip to content

Telemetry: FLYTE_DISABLE_SENTRY is honored by the SDK and backend, not the console - #1780

Merged
unionai-docsy-agent[bot] merged 3 commits into
mainfrom
docsy/case--1201
Nov 9, 2026
Merged

unionai-docsy-agent[bot] merged 3 commits into
mainfrom
docsy/case--1201

Conversation

@unionai-docsy-agent

@unionai-docsy-agent unionai-docsy-agent Bot commented Oct 23, 2026 •

Copy link
Copy Markdown
Contributor

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:

| FLYTE_DISABLE_SENTRY=true | Older name for FLYTE_DISABLE_TELEMETRY. Still honored. |

"Still honored" implies the variable works wherever FLYTE_DISABLE_TELEMETRY does. The SDK and the backend read it, but the web console doesn't.

Change

content/user-guide/telemetry.md, Variables reference table. The FLYTE_DISABLE_SENTRY=true row now reads: "Older name for FLYTE_DISABLE_TELEMETRY, honored by the SDK and CLI and the backend. The web console doesn't read it: set FLYTE_DISABLE_TELEMETRY or DO_NOT_TRACK there."

Evidence

  • SDK: flyteorg/flyte-sdk main, src/flyte/_sentry.py:49: _DISABLE_ENV_VARS = ("DO_NOT_TRACK", "FLYTE_DISABLE_TELEMETRY", "FLYTE_DISABLE_SENTRY").
  • Backend: flyteorg/flyte main, flytestdlib/telemetry/telemetry.go:17: disableEnvVars lists the same three.
  • Console: the Flyte charts deploy ghcr.io/unionai-oss/flyteconsole-v2. That image's org.opencontainers.image.source label is https://github.com/unionai-oss/flyte2-ui, and its latest tag matches that repo's HEAD (0df2746). In flyte2-ui, src/lib/telemetry.ts reads only DO_NOT_TRACK and FLYTE_DISABLE_TELEMETRY, and src/app/layout.tsx loads 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.

Drafted by Docsy for case -1201.

Signed-off-by: unionai-docsy-agent[bot] <336110417+unionai-docsy-agent[bot]@users.noreply.github.com>
@github-actions

github-actions Bot commented Oct 23, 2026 •

Copy link
Copy Markdown

GHA build & deploy preview

Built by .github/workflows/build-pr.yml and deployed to the docs CF Pages project by .github/workflows/deploy-pr-preview.yml.

Branch alias https://pr-1780-docsy-case-1201.docs-dog.pages.dev
This commit https://282d7a7c.docs-dog.pages.dev
Commit SHA 5ff9760a6442795c9475093d2bc16b488ab28633

Updated automatically on every push.

…kend only

Signed-off-by: unionai-docsy-agent[bot] <336110417+unionai-docsy-agent[bot]@users.noreply.github.com>
@unionai-docsy-agent

Copy link
Copy Markdown
Contributor Author

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 main (dad67dac). The console starts Grafana Faro with error, tracing, console-capture and performance instrumentation. In production builds it sends that data to a Grafana Cloud collector.

The opt-out instructions still hold. When DO_NOT_TRACK (or FLYTE_DISABLE_TELEMETRY) is set on the console, the console tells the browser that external telemetry is off. Faro then starts with no transports and sends nothing. So DO_NOT_TRACK=1 turns off both GTM and Faro.

Open question: please don't merge until it's answered. The flyteorg/flyte charts deploy ghcr.io/unionai-oss/flyteconsole-v2. I found nothing that shows that image is a production build of this console source. The Faro sentence depends on that, and so do the page's existing GTM and DO_NOT_TRACK console statements. None of the listed owners covers the console, so I haven't tagged anyone. If the image turns out to be built some other way, the Faro sentence should come out and the other console statements need rechecking.

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 FLYTE_DISABLE_SENTRY row. That row deliberately says nothing about the console until the question above is answered.

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>
@unionai-docsy-agent

unionai-docsy-agent Bot commented Nov 6, 2026 •

Copy link
Copy Markdown
Contributor Author

Docsy actions: what Docsy did on this PR, and at whose direction. Docsy adds a line for each.

  • 2026-11-06 17:16 UTC · pushed 5ff9760, an edit: Drop the Grafana Faro sentence: the OSS console image (ghcr.io/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. · at the direction of Peeter Piegaze (ppiegaze)
  • 2026-11-06 17:17 UTC · changed the title and description · at the direction of Peeter Piegaze (ppiegaze)
  • 2026-11-09 11:01 UTC · merged it (squash), after marking it ready for review, without an approving review · at the direction of Peeter Piegaze (ppiegaze)

@unionai-docsy-agent unionai-docsy-agent Bot changed the title Telemetry: FLYTE_DISABLE_SENTRY is honored by the SDK and backend only Telemetry: FLYTE_DISABLE_SENTRY is honored by the SDK and backend, not the console Nov 6, 2026
@unionai-docsy-agent
unionai-docsy-agent Bot marked this pull request as ready for review November 9, 2026 11:01
Copilot AI balanced review requested due to automatic review settings November 9, 2026 11:01
@unionai-docsy-agent
unionai-docsy-agent Bot merged commit 0488eaa into main Nov 9, 2026
17 checks passed
@unionai-docsy-agent
unionai-docsy-agent Bot deleted the docsy/case--1201 branch November 9, 2026 11:01

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 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_SENTRY is honored by the SDK, CLI, and backend, but not the web console.
  • Directs console users to FLYTE_DISABLE_TELEMETRY or DO_NOT_TRACK.
File Description
content/​user-guide/​telemetry.md Corrects one variable-reference row; no runtime behavior changes.

Review effort: Balanced

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant