Adding anonymous telemetry to builds

Author: amikofalvy

.env.sample

@@ -9,4 +9,4 @@ AI_PROCESSING_ENDPOINT=https://<your-endpoint>/api/webhook
 
 # the following are only used for the nextjs app
 # AUTO_RESPONDER_INKEEP_API_KEY=
-INTERNAL_ONLY=true
+INTERNAL_ONLY=true

README.md

@@ -46,3 +46,12 @@ To run the AI Autoresponder in debug mode:
 2. Redeploy the application
 
 In debug mode, the AI Auto Responder will only create internal notes (not visible to end-users) when responding to tickets.
+
+## Telemetry
+
+This template includes anonymous telemetry to help us understand usage patterns and improve the product. We only collect anonymous deployment events with no personal or sensitive information.
+
+To disable telemetry, set the environment variable:
+```bash
+INKEEP_TELEMETRY_DISABLED=true
+```

next.config.ts

@@ -7,6 +7,9 @@ const nextConfig: NextConfig = {
   experimental: {
     after: true,
   },
+  env: {
+    INKEEP_TELEMETRY_DISABLED: process.env.INKEEP_TELEMETRY_DISABLED
+  }
 };
 
 export default nextConfig;

package.json

@@ -4,27 +4,32 @@
   "private": true,
   "scripts": {
     "dev": "next dev --turbopack",
-    "build": "next build",
-    "zis": "bash ./scripts/setup-zis.sh",
+    "build": "pnpm run telemetry && next build",
+    "telemetry": "npx tsx scripts/telemetry.ts",
     "start": "next start",
     "lint": "next lint"
   },
   "dependencies": {
     "@ai-sdk/openai": "^0.0.70",
     "@t3-oss/env-nextjs": "^0.11.1",
     "ai": "^3.4.33",
+    "dotenv": "^16.4.5",
     "next": "15.0.1",
+    "node-fetch": "^3.3.2",
     "node-zendesk": "^5.0.13",
     "react": "19.0.0-rc-69d4b800-20241021",
     "react-dom": "19.0.0-rc-69d4b800-20241021",
+    "undici": "^6.6.2",
     "zod": "^3.23.8"
   },
   "devDependencies": {
     "@types/node": "^20",
+    "@types/node-fetch": "^2.6.11",
     "@types/react": "^18",
     "@types/react-dom": "^18",
     "eslint": "^8",
     "eslint-config-next": "15.0.1",
+    "tsx": "^4.7.1",
     "typescript": "^5"
   }
 }