Skip to content

feat: add anonymous Scarf usage telemetry (FB-1354)#59

Open
dig-whois wants to merge 1 commit into
mainfrom
fb-1354-scarf-telemetry-v2
Open

feat: add anonymous Scarf usage telemetry (FB-1354)#59
dig-whois wants to merge 1 commit into
mainfrom
fb-1354-scarf-telemetry-v2

Conversation

@dig-whois

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

Copy link
Copy Markdown
Contributor

Summary

  • send one privacy-minimized aggregate Scarf event per day from the elected operator leader
  • add Helm, CLI, and environment opt-outs plus current user-facing disclosure
  • route public chart install documentation through the Firebolt-owned Scarf gateway

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=1 follow-up PRs before this chart is released.

Test plan

  • make test
  • make lint
  • make docs-check
  • make helm-docs
  • helm lint helm/firebolt-operator
  • render the chart with telemetry enabled and disabled
  • local Cursor Bugbot: no findings

Note

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/telemetry Reporter (leader-election runnable) lists Firebolt CRs and sends a privacy-minimized operator_daily_summary (operator/engine versions, K8s minor, OS/arch, bucketed instance/engine/replica counts) to https://telemetry.firebolt.io/firebolt-operator via scarf-go. Collection/send failures are logged at low verbosity and do not affect reconciliation.

Opt-out and wiring: --telemetry / --telemetry-endpoint on the manager; Helm telemetry.enabled (default on, passes --telemetry=false when off); DO_NOT_TRACK / SCARF_NO_ANALYTICS honored by the Scarf client. make local-deploy disables telemetry for local Kind installs.

Distribution and disclosure: Helm install examples in docs switch from ghcr.io to oci://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 document telemetry.enabled.

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

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.
@dig-whois
dig-whois requested a review from a team as a code owner July 14, 2026 11:02
@fireboltdb-docs-integration

fireboltdb-docs-integration Bot commented Jul 14, 2026

Copy link
Copy Markdown

Mintlify docs preview

Docs were aggregated into the Firebolt documentation site.

Status Preview Updated (UTC)
🟢 Ready View Preview Jul 14, 2026, 11:07 AM

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

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