Document collection of usage data and how to opt out

[jan-mue]

Description

Document that Cognee collects usage data in the readme and add instructions how users can opt out.

[pull-checklist]

Please make sure all the checkboxes are checked:

• I have tested these changes locally.
• I have reviewed the code changes.
• I have added end-to-end and unit tests (if applicable).
• I have updated the documentation and README.md file (if necessary).
• I have removed unnecessary code and debug statements.
• PR title is clear and follows the convention.
• I have tagged reviewers or team members for feedback.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

A commented-out environment variable TELEMETRY_DISABLED=1 was added to the .env.template file to provide an option to disable telemetry data collection. Additionally, a trailing newline was added after the "Star History" section in the README.md file. No changes were made to code, exported entities, or other documentation content.

Changes

File(s)	Change Summary
.env.template	Added a commented-out TELEMETRY_DISABLED=1 variable to disable telemetry.
README.md	Added a trailing newline after the "Star History" section (whitespace only).

Poem

In fields of code where data flows,
A rabbit hops and gently shows:
"If you wish your tracks concealed,
Set TELEMETRY_DISABLED—your choice revealed!
With privacy clear and options bright,
Your journey’s yours, by day or night.
🐇✨"

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9c1dddf and f161663.

📒 Files selected for processing (1)

• README.md (1 hunks)

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

.env.template (1)

68-71: Group Telemetry Settings for Clarity
The new telemetry opt-out variable is helpful, but consider grouping it under its own header for discoverability. For example:

# Telemetry Configuration
# By default, telemetry is enabled. Set TELEMETRY_DISABLED=1 to disable.
# TELEMETRY_DISABLED=1

This matches the formatting of other sections and makes it easier for users to find.

README.md (1)

163-169: Link to Configuration Template for Convenience
To help users quickly locate where to set TELEMETRY_DISABLED, consider adding a link to the configuration template. For example:

See [`.env.template`](./.env.template) for disabling telemetry.

This small addition improves usability.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f1364fb and 9c1dddf.

📒 Files selected for processing (2)

• .env.template (1 hunks)
• README.md (1 hunks)

🔇 Additional comments (1)

README.md (1)

163-169: Approve: Telemetry Section Adds Transparency
The "Telemetry" section clearly explains that anonymized usage data is collected by default and shows how to opt out via TELEMETRY_DISABLED=1. This aligns perfectly with the .env.template update.