[Feature]: Add posthog anonymous telemetry and update docs (#867)

embedchain/telemetry/posthog.py

@@ -0,0 +1,67 @@
+import json
+import logging
+import os
+import uuid
+from pathlib import Path
+
+from posthog import Posthog
+
+import embedchain
+
+HOME_DIR = str(Path.home())
+CONFIG_DIR = os.path.join(HOME_DIR, ".embedchain")
+CONFIG_FILE = os.path.join(CONFIG_DIR, "config.json")
+
+logger = logging.getLogger(__name__)
+
+
+class AnonymousTelemetry:
+    def __init__(self, host="https://app.posthog.com", enabled=True):
+        self.project_api_key = "phc_XnMmNHzwxE7PVHX4mD2r8K6nfxVM48a2sq2U3N1p2lO"
+        self.host = host
+        self.posthog = Posthog(project_api_key=self.project_api_key, host=self.host)
+        self.user_id = self.get_user_id()
+        self.enabled = enabled
+
+        # Check if telemetry tracking is disabled via environment variable
+        if "EC_TELEMETRY" in os.environ and os.environ["EC_TELEMETRY"].lower() not in [
+            "1",
+            "true",
+            "yes",
+        ]:
+            self.enabled = False
+
+        if not self.enabled:
+            self.posthog.disabled = True
+
+        # Silence posthog logging
+        posthog_logger = logging.getLogger("posthog")
+        posthog_logger.disabled = True
+
+    def get_user_id(self):
+        if not os.path.exists(CONFIG_DIR):
+            os.makedirs(CONFIG_DIR)
+
+        if os.path.exists(CONFIG_FILE):
+            with open(CONFIG_FILE, "r") as f:
+                data = json.load(f)
+                if "user_id" in data:
+                    return data["user_id"]
+
+        user_id = str(uuid.uuid4())
+        with open(CONFIG_FILE, "w") as f:
+            json.dump({"user_id": user_id}, f)
+        return user_id
+
+    def capture(self, event_name, properties=None):
+        default_properties = {
+            "version": embedchain.__version__,
+            "language": "python",
+            "pid": os.getpid(),
+        }
+        properties.update(default_properties)
+
+        try:
+            self.posthog.capture(self.user_id, event_name, properties)
+        except Exception:
+            logger.exception(f"Failed to send telemetry {event_name=}")