Skip to content

Commit 9d0f0c0

Browse files
authored
docs: document telemetry collection in README (#499)
1 parent 9d0a394 commit 9d0f0c0

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,18 @@ OpenLLMetry-JS can instrument everything that [OpenTelemetry already instruments
128128
- ✅ LangChain
129129
- ✅ LlamaIndex
130130

131+
## 🔎 Telemetry
132+
133+
The SDK provided with OpenLLMetry (not the instrumentations) contains a telemetry feature that collects **anonymous** usage information.
134+
135+
You can opt out of telemetry by setting the `TRACELOOP_TELEMETRY` environment variable to `FALSE`.
136+
137+
### Why we collect telemetry
138+
139+
- The primary purpose is to detect exceptions within instrumentations. Since LLM providers frequently update their APIs, this helps us quickly identify and fix any breaking changes.
140+
- We only collect anonymous data, with no personally identifiable information. You can view exactly what data we collect in our [Privacy documentation](https://www.traceloop.com/docs/openllmetry/privacy/telemetry).
141+
- Telemetry is only collected in the SDK. If you use the instrumentations directly without the SDK, no telemetry is collected.
142+
131143
## 🌱 Contributing
132144

133145
Whether it's big or small, we love contributions ❤️ Check out our guide to see how to [get started](https://traceloop.com/docs/openllmetry/contributing/overview).

0 commit comments

Comments
 (0)