Add additional telemetry (#63)

Author: brendan-kellam

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Added additional telemetry events. ([#63](https://github.com/sourcebot-dev/sourcebot/pull/63))
+
 ## [2.4.0] - 2024-11-06
 
 ### Added

Dockerfile

@@ -55,13 +55,14 @@ RUN echo "Sourcebot Version: $SOURCEBOT_VERSION"
 ENV SOURCEBOT_LOG_LEVEL=info
 
 # @note: This is also set in .env
-ENV NEXT_PUBLIC_POSTHOG_KEY=phc_VFn4CkEGHRdlVyOOw8mfkoj1DKVoG6y1007EClvzAnS
+ENV POSTHOG_KEY=phc_VFn4CkEGHRdlVyOOw8mfkoj1DKVoG6y1007EClvzAnS
+ENV NEXT_PUBLIC_POSTHOG_KEY=$POSTHOG_KEY
 
 # Sourcebot collects anonymous usage data using [PostHog](https://posthog.com/). Uncomment this line to disable.
 # ENV SOURCEBOT_TELEMETRY_DISABLED=1
 
 # Configure dependencies
-RUN apk add --no-cache git ca-certificates bind-tools tini jansson wget supervisor uuidgen curl perl
+RUN apk add --no-cache git ca-certificates bind-tools tini jansson wget supervisor uuidgen curl perl jq
 
 # Configure zoekt
 COPY vendor/zoekt/install-ctags-alpine.sh .

entrypoint.sh

@@ -15,24 +15,48 @@ fi
 
 # In order to detect if this is the first run, we create a `.installed` file in
 # the cache directory.
-FIRST_RUN_FILE="$DATA_CACHE_DIR/.installed"
+FIRST_RUN_FILE="$DATA_CACHE_DIR/.installedv2"
+
 if [ ! -f "$FIRST_RUN_FILE" ]; then
     touch "$FIRST_RUN_FILE"
-
+    export SOURCEBOT_INSTALL_ID=$(uuidgen)
+    
     # If this is our first run, send a `install` event to PostHog
     # (if telemetry is enabled)
     if [ -z "$SOURCEBOT_TELEMETRY_DISABLED" ]; then
         curl -L -s --header "Content-Type: application/json" -d '{
-            "api_key": "'"$NEXT_PUBLIC_POSTHOG_KEY"'",
+            "api_key": "'"$POSTHOG_KEY"'",
             "event": "install",
-            "distinct_id": "'"$(uuidgen)"'",
+            "distinct_id": "'"$SOURCEBOT_INSTALL_ID"'",
             "properties": {
                 "sourcebot_version": "'"$SOURCEBOT_VERSION"'"
             }
         }' https://us.i.posthog.com/capture/ > /dev/null
     fi
+else
+    export SOURCEBOT_INSTALL_ID=$(cat "$FIRST_RUN_FILE" | jq -r '.install_id')
+    PREVIOUS_VERSION=$(cat "$FIRST_RUN_FILE" | jq -r '.version')
+
+    # If the version has changed, we assume an upgrade has occurred.
+    if [ "$PREVIOUS_VERSION" != "$SOURCEBOT_VERSION" ]; then
+        echo -e "\e[34m[Info] Upgraded from version $PREVIOUS_VERSION to $SOURCEBOT_VERSION\e[0m"
+
+        if [ -z "$SOURCEBOT_TELEMETRY_DISABLED" ]; then
+            curl -L -s --header "Content-Type: application/json" -d '{
+                "api_key": "'"$POSTHOG_KEY"'",
+                "event": "upgrade",
+                "distinct_id": "'"$SOURCEBOT_INSTALL_ID"'",
+                "properties": {
+                    "from_version": "'"$PREVIOUS_VERSION"'",
+                    "to_version": "'"$SOURCEBOT_VERSION"'"
+                }
+            }' https://us.i.posthog.com/capture/ > /dev/null
+        fi
+    fi
 fi
 
+echo "{\"version\": \"$SOURCEBOT_VERSION\", \"install_id\": \"$SOURCEBOT_INSTALL_ID\"}" > "$FIRST_RUN_FILE"
+
 # Fallback to sample config if a config does not exist
 if echo "$CONFIG_PATH" | grep -qE '^https?://'; then
     if ! curl --output /dev/null --silent --head --fail "$CONFIG_PATH"; then

packages/backend/.env

@@ -0,0 +1,4 @@
+POSTHOG_HOST=https://us.i.posthog.com
+
+# @note: This is also set in the Dockerfile
+POSTHOG_KEY=phc_VFn4CkEGHRdlVyOOw8mfkoj1DKVoG6y1007EClvzAnS

packages/backend/.gitignore

@@ -1 +1,2 @@
-dist/
+dist/
+!.env

packages/backend/package.json

@@ -24,9 +24,11 @@
         "@octokit/rest": "^21.0.2",
         "argparse": "^2.0.1",
         "cross-fetch": "^4.0.0",
+        "dotenv": "^16.4.5",
         "gitea-js": "^1.22.0",
         "lowdb": "^7.0.1",
         "micromatch": "^4.0.8",
+        "posthog-node": "^4.2.1",
         "simple-git": "^3.27.0",
         "strip-json-comments": "^5.0.1",
         "winston": "^3.15.0"

packages/backend/src/environment.ts

@@ -1,6 +1,23 @@
+import dotenv from 'dotenv';
 
 export const getEnv = (env: string | undefined, defaultValue = '') => {
 	return env ?? defaultValue;
 }
 
+export const getEnvBoolean = (env: string | undefined, defaultValue: boolean) => {
+	if (!env) {
+		return defaultValue;
+	}
+	return env === 'true' || env === '1';
+}
+
+dotenv.config({
+	path: './.env',
+});
+
 export const SOURCEBOT_LOG_LEVEL = getEnv(process.env.SOURCEBOT_LOG_LEVEL, 'info');
+export const SOURCEBOT_TELEMETRY_DISABLED = getEnvBoolean(process.env.SOURCEBOT_TELEMETRY_DISABLED, false);
+export const SOURCEBOT_INSTALL_ID = getEnv(process.env.SOURCEBOT_INSTALL_ID, 'unknown');
+export const SOURCEBOT_VERSION = getEnv(process.env.SOURCEBOT_VERSION, 'unknown');
+export const POSTHOG_KEY = getEnv(process.env.POSTHOG_KEY);
+export const POSTHOG_HOST = getEnv(process.env.POSTHOG_HOST);

packages/backend/src/gitea.ts

@@ -47,6 +47,7 @@ export const getGiteaReposFromConfig = async (config: GiteaConfig, ctx: AppConte
 
             return {
                 vcs: 'git',
+                codeHost: 'gitea',
                 name: repo.full_name!,
                 id: repoId,
                 cloneUrl: cloneUrl.toString(),

packages/backend/src/github.ts

@@ -72,6 +72,7 @@ export const getGitHubReposFromConfig = async (config: GitHubConfig, signal: Abo
 
             return {
                 vcs: 'git',
+                codeHost: 'github',
                 name: repo.full_name,
                 id: repoId,
                 cloneUrl: cloneUrl.toString(),

packages/backend/src/gitlab.ts

@@ -75,6 +75,7 @@ export const getGitLabReposFromConfig = async (config: GitLabConfig, ctx: AppCon
 
             return {
                 vcs: 'git',
+                codeHost: 'gitlab',
                 name: project.path_with_namespace,
                 id: repoId,
                 cloneUrl: cloneUrl.toString(),