feat: add anonymous Scarf usage telemetry (FB-1354)#59
Open
dig-whois wants to merge 1 commit into
Open
Conversation
Report one privacy-minimized aggregate event per day from the elected operator leader, with transparent Helm controls and documentation so public adoption is measurable and users can opt out.
Mintlify docs previewDocs were aggregated into the Firebolt documentation site.
Mintlify may take a few minutes to finish building. This comment updates on each sync while the source PR is open. |
gm42
approved these changes
Jul 14, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Privacy
The event includes operator/engine versions, Kubernetes minor, OS/architecture, and bucketed instance/engine/replica counts. It contains no names, stable identifiers, query data, schemas, secrets, or configuration. The source IP is visible to Scarf for company inference but is not stored.
Rollout dependency
Firebolt-managed deployments must land their
DO_NOT_TRACK=1follow-up PRs before this chart is released.Test plan
make testmake lintmake docs-checkmake helm-docshelm lint helm/firebolt-operatorNote
Medium Risk
Introduces outbound network calls and cluster-wide CR listing on the leader by default (opt-out available); privacy posture depends on bucketed payloads and documented opt-outs before release to managed fleets.
Overview
Adds once-daily anonymous aggregate usage reporting to Scarf from the elected operator leader, plus public docs and install paths that use Firebolt’s Scarf gateway.
A new
internal/telemetryReporter (leader-election runnable) lists Firebolt CRs and sends a privacy-minimizedoperator_daily_summary(operator/engine versions, K8s minor, OS/arch, bucketed instance/engine/replica counts) tohttps://telemetry.firebolt.io/firebolt-operatorviascarf-go. Collection/send failures are logged at low verbosity and do not affect reconciliation.Opt-out and wiring:
--telemetry/--telemetry-endpointon the manager; Helmtelemetry.enabled(default on, passes--telemetry=falsewhen off);DO_NOT_TRACK/SCARF_NO_ANALYTICShonored by the Scarf client.make local-deploydisables telemetry for local Kind installs.Distribution and disclosure: Helm install examples in docs switch from
ghcr.iotooci://oci.firebolt.io/...with bypass notes; README adds Scarf badges, a Telemetry section, flag table rows, and a README pixel beacon. Chart values, schema, and generated helm-docs documenttelemetry.enabled.Reviewed by Cursor Bugbot for commit c6b6690. Bugbot is set up for automated code reviews on this repo. Configure here.