Skip to content

DX-2204: Add telemetry information and opt-out option to README #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
CahidArda merged 1 commit into from
Oct 21, 2025
Merged

DX-2204: Add telemetry information and opt-out option to README #50

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -537,6 +537,21 @@ The default namespaces cannot be deleted.
index.delete_namespace(namespace="ns")
```

## Telemetry

This library sends anonymous telemetry data to help us improve your experience.
We collect the following:

- SDK version
- Platform (Vercel, AWS)
- Python Runtime version

You can opt out by passing `allow_telemetry=False` when initializing the Redis client:

```py
idx = Index("INDEX_URL", "INDEX_TOKEN", allow_telemetry=False)
```

# Contributing

## Preparing the environment
Expand Down
Loading