Skip to content

add doc page for telemetry info and opt-out#6548

Merged
masenf merged 2 commits into
mainfrom
masenf/telemetry-doc
May 21, 2026
Merged

add doc page for telemetry info and opt-out#6548
masenf merged 2 commits into
mainfrom
masenf/telemetry-doc

Conversation

@masenf
Copy link
Copy Markdown
Collaborator

@masenf masenf commented May 20, 2026

No description provided.

@masenf masenf requested review from a team and Alek99 as code owners May 20, 2026 23:22
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 20, 2026

Greptile Summary

Adds a new API reference documentation page (docs/api-reference/telemetry.md) describing what anonymized usage data Reflex collects, how it's handled in Reflex Cloud, and how to opt out via rxconfig.py or environment variable. The page is wired into the existing API Reference sidebar section.

  • The new doc page explains the telemetry data model (component/feature counts, version info, no source or runtime data) with links to the Privacy Policy and Terms of Service.
  • Two opt-out methods are documented: the telemetry_enabled=False config option and the REFLEX_TELEMETRY_ENABLED environment variable (for commands run outside an app directory).

Confidence Score: 5/5

Docs-only change with no runtime logic; safe to merge

Both changed files are documentation and sidebar configuration. The new markdown page is factually accurate, the sidebar registration follows the same pattern as all other entries, and the only minor observation is a cosmetic inconsistency in the env-var example value (0 vs false).

No files require special attention

Important Files Changed

Filename Overview
docs/api-reference/telemetry.md New doc page describing telemetry data collection and opt-out methods; uses REFLEX_TELEMETRY_ENABLED=0 which differs from false used elsewhere in the codebase
docs/app/reflex_docs/templates/docpage/sidebar/sidebar_items/reference.py Adds api_reference.telemetry to the API reference sidebar, consistent with how all other doc pages are registered

Reviews (1): Last reviewed commit: "add doc page for telemetry info and opt-..." | Re-trigger Greptile

Comment thread docs/api-reference/telemetry.md Outdated
@codspeed-hq
Copy link
Copy Markdown

codspeed-hq Bot commented May 20, 2026

Merging this PR will not alter performance

✅ 24 untouched benchmarks


Comparing masenf/telemetry-doc (68c1f76) with main (bf2deed)

Open in CodSpeed

Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

@picklelo picklelo left a comment

Choose a reason for hiding this comment

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

lgtm

@masenf masenf merged commit 6bb44d5 into main May 21, 2026
75 of 76 checks passed
@masenf masenf deleted the masenf/telemetry-doc branch May 21, 2026 00:22
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.

3 participants