Env var to enable Posthog session replay (disable by default) (#1998)

mitodl · Jan 28, 2025 · 407ee1b · 407ee1b
1 parent a9bd2e6
commit 407ee1b
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 3 deletions.
diff --git a/.github/workflows/production.yml b/.github/workflows/production.yml
@@ -52,6 +52,7 @@ jobs:
           POSTHOG_API_HOST: https://app.posthog.com
           POSTHOG_PROJECT_ID: ${{ secrets.POSTHOG_PROJECT_ID_PROD }}
           POSTHOG_API_KEY: ${{ secrets.POSTHOG_PROJECT_API_KEY_PROD }}
+          POSTHOG_ENABLE_SESSION_RECORDING: ${{ secrets.POSTHOG_PROJECT_ENABLE_SESSION_RECORDING_PROD }}
           SENTRY_DSN: ${{ secrets.SENTRY_DSN_PROD }}
           SENTRY_ENV: ${{ secrets.MITOL_ENVIRONMENT_PROD }}
           SENTRY_PROFILES_SAMPLE_RATE: ${{ secrets.SENTRY_PROFILES_SAMPLE_RATE_PROD }}
@@ -72,6 +73,7 @@ jobs:
           NEXT_PUBLIC_POSTHOG_API_HOST=$POSTHOG_API_HOST,\
           NEXT_PUBLIC_POSTHOG_PROJECT_ID=$POSTHOG_PROJECT_ID,\
           NEXT_PUBLIC_POSTHOG_API_KEY=$POSTHOG_API_KEY,\
+          NEXT_PUBLIC_POSTHOG_ENABLE_SESSION_RECORDING=$POSTHOG_ENABLE_SESSION_RECORDING,\
           NEXT_PUBLIC_SENTRY_DSN=$SENTRY_DSN,\
           NEXT_PUBLIC_SENTRY_ENV=$SENTRY_ENV,\
           NEXT_PUBLIC_SENTRY_PROFILES_SAMPLE_RATE=$SENTRY_PROFILES_SAMPLE_RATE,\

diff --git a/.github/workflows/release-candidate.yml b/.github/workflows/release-candidate.yml
@@ -52,6 +52,7 @@ jobs:
           POSTHOG_API_HOST: https://app.posthog.com
           POSTHOG_PROJECT_ID: ${{ secrets.POSTHOG_PROJECT_ID_RC }}
           POSTHOG_API_KEY: ${{ secrets.POSTHOG_PROJECT_API_KEY_RC }}
+          POSTHOG_ENABLE_SESSION_RECORDING: ${{ secrets.POSTHOG_PROJECT_ENABLE_SESSION_RECORDING_RC }}
           SENTRY_DSN: ${{ secrets.SENTRY_DSN_RC }}
           SENTRY_ENV: ${{ secrets.MITOL_ENVIRONMENT_RC }}
           SENTRY_PROFILES_SAMPLE_RATE: ${{ secrets.SENTRY_PROFILES_SAMPLE_RATE_RC }}
@@ -72,6 +73,7 @@ jobs:
           NEXT_PUBLIC_POSTHOG_API_HOST=$POSTHOG_API_HOST,\
           NEXT_PUBLIC_POSTHOG_PROJECT_ID=$POSTHOG_PROJECT_ID,\
           NEXT_PUBLIC_POSTHOG_API_KEY=$POSTHOG_API_KEY,\
+          NEXT_PUBLIC_POSTHOG_ENABLE_SESSION_RECORDING=$POSTHOG_ENABLE_SESSION_RECORDING,\
           NEXT_PUBLIC_SENTRY_DSN=$SENTRY_DSN,\
           NEXT_PUBLIC_SENTRY_ENV=$SENTRY_ENV,\
           NEXT_PUBLIC_SENTRY_PROFILES_SAMPLE_RATE=$SENTRY_PROFILES_SAMPLE_RATE,\

diff --git a/frontends/main/Dockerfile.web b/frontends/main/Dockerfile.web
@@ -11,6 +11,7 @@
 #   --build-arg NEXT_PUBLIC_POSTHOG_API_HOST= \
 #   --build-arg NEXT_PUBLIC_POSTHOG_PROJECT_ID= \
 #   --build-arg NEXT_PUBLIC_POSTHOG_API_KEY= \
+#   --build-arg NEXT_PUBLIC_POSTHOG_ENABLE_SESSION_RECORDING= \
 #   --build-arg NEXT_PUBLIC_SENTRY_DSN= \
 #   --build-arg NEXT_PUBLIC_SENTRY_ENV= \
 #   --build-arg NEXT_PUBLIC_SENTRY_PROFILES_SAMPLE_RATE= \
@@ -38,6 +39,7 @@
 # NEXT_PUBLIC_POSTHOG_API_HOST=$POSTHOG_API_HOST,\
 # NEXT_PUBLIC_POSTHOG_PROJECT_ID=$POSTHOG_PROJECT_ID,\
 # NEXT_PUBLIC_POSTHOG_API_KEY=$POSTHOG_API_KEY,\
+# NEXT_PUBLIC_POSTHOG_ENABLE_SESSION_RECORDING=$POSTHOG_ENABLE_SESSION_RECORDING,\
 # NEXT_PUBLIC_SENTRY_DSN=$SENTRY_DSN,\
 # NEXT_PUBLIC_SENTRY_ENV=$SENTRY_ENV,\
 # NEXT_PUBLIC_SENTRY_PROFILES_SAMPLE_RATE=$SENTRY_PROFILES_SAMPLE_RATE,\
@@ -105,9 +107,6 @@ ENV NEXT_PUBLIC_SENTRY_PROFILES_SAMPLE_RATE=$NEXT_PUBLIC_SENTRY_PROFILES_SAMPLE_
 ARG NEXT_PUBLIC_SENTRY_TRACES_SAMPLE_RATE
 ENV NEXT_PUBLIC_SENTRY_TRACES_SAMPLE_RATE=$NEXT_PUBLIC_SENTRY_TRACES_SAMPLE_RATE
 
-ARG NEXT_PUBLIC_POSTHOG_API_KEY
-ENV NEXT_PUBLIC_POSTHOG_API_KEY=$NEXT_PUBLIC_POSTHOG_API_KEY
-
 ARG NEXT_PUBLIC_MITOL_AXIOS_WITH_CREDENTIALS=true
 ENV NEXT_PUBLIC_MITOL_AXIOS_WITH_CREDENTIALS=$NEXT_PUBLIC_MITOL_AXIOS_WITH_CREDENTIALS
 
@@ -120,6 +119,8 @@ ARG NEXT_PUBLIC_POSTHOG_PROJECT_ID
 ENV NEXT_PUBLIC_POSTHOG_PROJECT_ID=$NEXT_PUBLIC_POSTHOG_PROJECT_ID
 ARG NEXT_PUBLIC_POSTHOG_API_KEY
 ENV NEXT_PUBLIC_POSTHOG_API_KEY=$NEXT_PUBLIC_POSTHOG_API_KEY
+ARG NEXT_PUBLIC_POSTHOG_API_KEY
+ENV NEXT_PUBLIC_POSTHOG_ENABLE_SESSION_RECORDING=$NEXT_PUBLIC_POSTHOG_ENABLE_SESSION_RECORDING
 
 ARG NEXT_PUBLIC_SENTRY_DSN
 ENV NEXT_PUBLIC_SENTRY_DSN=$NEXT_PUBLIC_SENTRY_DSN

diff --git a/frontends/main/src/page-components/ConfiguredPostHogProvider/ConfiguredPostHogProvider.tsx b/frontends/main/src/page-components/ConfiguredPostHogProvider/ConfiguredPostHogProvider.tsx
@@ -6,13 +6,17 @@ import { useUserMe } from "api/hooks/user"
 const POSTHOG_API_KEY = process.env.NEXT_PUBLIC_POSTHOG_API_KEY
 const POSTHOG_API_HOST = process.env.NEXT_PUBLIC_POSTHOG_API_HOST
 const FEATURE_FLAGS = process.env.FEATURE_FLAGS
+const POSTHOG_ENABLE_SESSION_RECORDING =
+  process.env.NEXT_PUBLIC_POSTHOG_ENABLE_SESSION_RECORDING
 
 if (POSTHOG_API_KEY) {
   posthog.init(POSTHOG_API_KEY, {
     api_host: POSTHOG_API_HOST,
     bootstrap: {
       featureFlags: FEATURE_FLAGS ? JSON.parse(FEATURE_FLAGS) : null,
     },
+    disable_session_recording:
+      POSTHOG_ENABLE_SESSION_RECORDING?.toLowerCase() !== "true",
   })
 }