Skip to content

Commit 4e3a254

Browse files
authored
DX-2204: add telemetry data collection and opt-out option (#67)
* feat: add telemetry data collection and opt-out option * fix: correct syntax for opt-out telemetry option in README
1 parent 38d27f6 commit 4e3a254

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,25 @@ print(result)
168168
# prints [True, 2, '2']
169169
```
170170

171+
# Telemetry
172+
173+
This library sends anonymous telemetry data to help us improve your experience.
174+
We collect the following:
175+
176+
- SDK version
177+
- Platform (Vercel, AWS)
178+
- Python Runtime version
179+
180+
You can opt out by passing `allow_telemetry=False` when initializing the Redis client:
181+
182+
```py
183+
redis = Redis(
184+
# ...,
185+
allow_telemetry=False,
186+
)
187+
```
188+
189+
171190
# Encoding
172191
Although Redis can store invalid JSON data, there might be problems with the deserialization.
173192
To avoid this, the Upstash REST proxy is capable of encoding the data as base64 on the server and then sending it to the client to be

0 commit comments

Comments
 (0)