Skip to content

feat(telemetry): add telemetry.enabled toggle with GHCR fallback and engine opt-out - #53

Open
dig-whois wants to merge 4 commits into
mainfrom
fb-1354-telemetry-toggle
Open

feat(telemetry): add telemetry.enabled toggle with GHCR fallback and engine opt-out#53
dig-whois wants to merge 4 commits into
mainfrom
fb-1354-telemetry-toggle

Conversation

@dig-whois

@dig-whois dig-whois commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Adds a top-level telemetry.enabled value (default true), mirroring the firebolt-operator chart's single-toggle opt-out.
  • When set to false, the chart stamps DO_NOT_TRACK=1 on every engine container — disabling the engine's once-daily anonymous usage event (firebolt-analytics/packdb#24471) — and, when engineSpec.image.repository is still the default Scarf gateway, switches engine pulls to ghcr.io/firebolt-db/engine. A user-supplied repository is used verbatim, and a DO_NOT_TRACK entry in engineSpec.extraEnv still wins (it renders after the chart-managed env).
  • Documents the toggle in the README Telemetry section, quickstart, and image-overrides docs; chart README regenerated with helm-docs.
  • Chart validation now asserts all three render states: default (Scarf gateway, no DO_NOT_TRACK), opt-out (GHCR + DO_NOT_TRACK=1), and opt-out with a custom repository (repository preserved).

Test plan

  • ./helm/scripts/validate-chart.sh green, including the new toggle assertions
  • CI

Note

Low Risk
Chart-only behavior behind an opt-in default; changes engine env and image URL only when users set telemetry.enabled=false, with validation guarding regressions.

Overview
Introduces a top-level telemetry.enabled chart value (default true) so installs can opt out of anonymous engine usage telemetry in one place.

When telemetry.enabled: false, the chart sets DO_NOT_TRACK=1 on engine containers (before engineSpec.extraEnv, so a user override still wins) and routes default engine image pulls from the Scarf gateway to ghcr.io/firebolt-db/engine via a new fbinstance.engineImage helper—only when the repository is still the default; custom mirrors are unchanged. values.schema.json, helm-docs, README, quickstart, and image-overrides docs describe the toggle and related opt-out paths.

validate-chart.sh gains Step 4: default render (Scarf image, no DO_NOT_TRACK), full opt-out (GHCR + DO_NOT_TRACK), and opt-out with a custom repository preserved. .legitignore adds an entry for the validation dummy PostgreSQL password.

Reviewed by Cursor Bugbot for commit 2e10bc9. Bugbot is set up for automated code reviews on this repo. Configure here.

@cursor

cursor Bot commented Jul 28, 2026

Copy link
Copy Markdown

Current version of PR was reviewed by /review-bugbot on Jul 28, 13:23 GMT+2. It flagged 0 findings.

Bugbot on commit 17402ca is skipped.

@cursor
cursor Bot requested review from fstr and gm42 July 28, 2026 11:28

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Stale comment

Risk: medium. Left a non-blocking comment — Cursor Bugbot completed as skipped, so the required automated-review signal is incomplete and this cannot be auto-approved. Assigned gm42 and fstr for human review of the telemetry toggle and image-fallback behavior.

Open in Web View Automation 

Sent by Cursor Approval Agent: Infra Reviewer

@fireboltdb-docs-integration

fireboltdb-docs-integration Bot commented Jul 28, 2026

Copy link
Copy Markdown

Mintlify docs preview

Docs were aggregated into the Firebolt documentation site.

Status Preview Updated (UTC)
🟢 Ready View Preview Jul 29, 2026, 12:08 PM

Mintlify may take a few minutes to finish building. This comment updates on each sync while the source PR is open.

cursor[bot]
cursor Bot previously approved these changes Jul 28, 2026

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit ba298c1. Configure here.

Comment thread .legitignore Outdated

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Stale comment

Risk: medium. Left a non-blocking comment — Cursor Bugbot completed as skipped/neutral with 1 unresolved finding, so this cannot be auto-approved. Reviewers were already assigned; no additional reviewers requested.

Open in Web View Automation 

Sent by Cursor Approval Agent: Infra Reviewer

cursor[bot]
cursor Bot approved these changes Jul 28, 2026
…engine opt-out

Add a top-level `telemetry.enabled` value (default true). Setting it to
false stamps DO_NOT_TRACK=1 on every engine container — disabling the
engine's once-daily anonymous usage event — and, when
engineSpec.image.repository is still the default Scarf gateway, switches
engine pulls to ghcr.io/firebolt-db/engine. A user-supplied repository
and a user-supplied DO_NOT_TRACK in engineSpec.extraEnv are preserved.

Mirrors the firebolt-operator chart's single-toggle opt-out. Render
assertions for both toggle states are part of chart validation.
@dig-whois
dig-whois force-pushed the fb-1354-telemetry-toggle branch from d89571f to 2e10bc9 Compare July 29, 2026 12:04

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Risk: medium. Approved — Cursor Bugbot passed with no unresolved findings requiring human review; Cursor Security Agent was not present. Reviewers were already assigned; no additional reviewers requested.

Open in Web View Automation 

Sent by Cursor Approval Agent: Infra Reviewer

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants