feat(web): make Sentry tracing and profiling opt-in

.env.development

@@ -30,6 +30,8 @@ CONFIG_PATH=${PWD}/config.json # Path to the sourcebot config file (if one exist
 # NEXT_PUBLIC_SENTRY_WEBAPP_DSN=""
 # SENTRY_ENVIRONMENT="dev"
 # NEXT_PUBLIC_SENTRY_ENVIRONMENT="dev"
+# SENTRY_TRACING_ENABLED="false" # Set to "true" to enable server and edge tracing.
+# SENTRY_PROFILING_ENABLED="false" # Set to "true" to enable server-side profiling. Requires tracing.
 # SENTRY_AUTH_TOKEN=
 
 # Logtail

packages/web/src/sentry.edge.config.ts

@@ -5,12 +5,16 @@
 
 import * as Sentry from "@sentry/nextjs";
 
+const isTracingEnabled = process.env.SENTRY_TRACING_ENABLED === 'true';
+
 if (!!process.env.NEXT_PUBLIC_SENTRY_WEBAPP_DSN && !!process.env.NEXT_PUBLIC_SENTRY_ENVIRONMENT) {
     Sentry.init({
         dsn: process.env.NEXT_PUBLIC_SENTRY_WEBAPP_DSN,
         environment: process.env.NEXT_PUBLIC_SENTRY_ENVIRONMENT,
 
-        tracesSampleRate: process.env.NEXT_PUBLIC_SENTRY_ENVIRONMENT === 'development' ? 1.0 : 0.1,
+        ...(isTracingEnabled ? {
+            tracesSampleRate: process.env.NEXT_PUBLIC_SENTRY_ENVIRONMENT === 'development' ? 1.0 : 0.1,
+        } : {}),
 
         // Setting this option to true will print useful information to the console while you're setting up Sentry.
         debug: false,

packages/web/src/sentry.server.config.ts

@@ -7,19 +7,25 @@ import { nodeProfilingIntegration } from "@sentry/profiling-node";
 import { createLogger } from "@sourcebot/shared";
 
 const logger = createLogger('sentry-server-config');
+const isTracingEnabled = process.env.SENTRY_TRACING_ENABLED === 'true';
+const isProfilingEnabled = isTracingEnabled && process.env.SENTRY_PROFILING_ENABLED === 'true';
 
 if (!!process.env.NEXT_PUBLIC_SENTRY_WEBAPP_DSN && !!process.env.NEXT_PUBLIC_SENTRY_ENVIRONMENT) {
     Sentry.init({
         dsn: process.env.NEXT_PUBLIC_SENTRY_WEBAPP_DSN,
         environment: process.env.NEXT_PUBLIC_SENTRY_ENVIRONMENT,
-        integrations: [
-            nodeProfilingIntegration(),
-        ],
-        tracesSampleRate: process.env.NEXT_PUBLIC_SENTRY_ENVIRONMENT === 'development' ? 1.0 : 0.1,
-        // Evaluated once per `Sentry.init()`, i.e. once per server process.
-        profileSessionSampleRate: 1.0,
-        // Profile only while a sampled root span is active, rather than continuously.
-        profileLifecycle: 'trace',
+        ...(isTracingEnabled ? {
+            tracesSampleRate: process.env.NEXT_PUBLIC_SENTRY_ENVIRONMENT === 'development' ? 1.0 : 0.1,
+        } : {}),
+        ...(isProfilingEnabled ? {
+            integrations: [
+                nodeProfilingIntegration(),
+            ],
+            // Evaluated once per `Sentry.init()`, i.e. once per server process.
+            profileSessionSampleRate: 1.0,
+            // Profile only while a sampled root span is active, rather than continuously.
+            profileLifecycle: 'trace' as const,
+        } : {}),
     });
 } else {
     logger.debug("[server] Sentry was not initialized");