Skip to content

Commit

Permalink
docs: document telemetry collection in README (#499)
Browse files Browse the repository at this point in the history
  • Loading branch information
nirga authored Jan 2, 2025
1 parent 9d0a394 commit 9d0f0c0
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,18 @@ OpenLLMetry-JS can instrument everything that [OpenTelemetry already instruments
- ✅ LangChain
- ✅ LlamaIndex

## 🔎 Telemetry

The SDK provided with OpenLLMetry (not the instrumentations) contains a telemetry feature that collects **anonymous** usage information.

You can opt out of telemetry by setting the `TRACELOOP_TELEMETRY` environment variable to `FALSE`.

### Why we collect telemetry

- 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.
- 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).
- Telemetry is only collected in the SDK. If you use the instrumentations directly without the SDK, no telemetry is collected.

## 🌱 Contributing

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).
Expand Down

0 comments on commit 9d0f0c0

Please sign in to comment.