Skip to content

Same agent Smaller bill. The tools and infrastructure to get more work from your AI. Fewer tokens. Less compute. Lower cost.

[Feat]: Add docs for anonymous usage stats reporting (#498)

Patcher63f422ae2163
diff --git a/docs/latest/anonymous-telemetry.mdx b/docs/latest/anonymous-telemetry.mdx
new file mode 100644
index 00000000..8371c924
--- /dev/null
+++ b/docs/latest/anonymous-telemetry.mdx
@@ -0,0 +1,28 @@
+---
+title: 'Anonymous Usage Metrics'
+description: 'Details about OpenLIT anonymous usage metrics reporting'
+---
+
+## Why?
+To enhance and improve the OpenLIT experience, we have introduced a telemetry feature that collects anonymous usage data. This data helps us understand how users interact with OpenLIT and identify areas for improvement. We assure you that all collected data is completely anonymous and is used solely for the purpose of enhancing our services.
+
+## What Do We Track?
+
+OpenLIT collects anonymous events from both the OpenLIT and the OpenLIT SDK to analyze usage. Events include:
+
+- **User Interactions**: Counts of login attempts, registrations, and page visits.
+- **Database Configurations**: Counts of additions, updates, and action changes.
+- **Profile Management**: Counts of profile updates, whether successful or failed.
+- **API Key Management**: Counts of added API keys and any failures.
+- **Prompt Operations**: Success/failure count on prompt additions and versioning.
+- **Vault Actions**: Counts of secret additions and updates.
+- **Openground Evaluations**: Counts of the success and failure of evaluations.
+- **SDK Operations**: Success/failure count in fetching prompts and vault secrets.
+
+## How to Disable the Collection of Usage Metrics
+
+Usage metrics collection in OpenLIT is enabled by default, but you can opt-out at any time. To disable usage metrics collection, set the `TELEMETRY_ENABLED=false` environment variable when starting OpenLIT.
+
+## Where Are Usage Metrics Stored?
+
+We use Posthog to securely store and visualize usage metrics, providing essential insights into how OpenLIT is used.
diff --git a/docs/mint.json b/docs/mint.json
index 3a90fbbc..41b8ee38 100644
--- a/docs/mint.json
+++ b/docs/mint.json
@@ -178,6 +178,13 @@
}
],
"version": "latest"
+ },
+ {
+ "group": "Privacy",
+ "pages": [
+ "latest/anonymous-telemetry"
+ ],
+ "version": "latest"
}
],
"analytics": {