feat: setup sentry for the controlplane

Author: miklosbarabas

controlplane/src/core/env.schema.ts

@@ -178,6 +178,31 @@ export const envVariables = z
      * Admission Webhook
      */
     AUTH_ADMISSION_JWT_SECRET: z.string(),
+
+    /**
+     * Sentry
+     */
+    SENTRY_ENABLED: z
+      .string()
+      .optional()
+      .transform((val) => val === 'true')
+      .default('false'),
+    SENTRY_DSN: z.string().optional(),
+    SENTRY_SEND_DEFAULT_PII: z
+      .string()
+      .optional()
+      .transform((val) => val === 'true'),
+    SENTRY_TRACES_SAMPLE_RATE: z
+      .string()
+      .transform((val) => Number.parseInt(val))
+      .optional()
+      .default('0.0'),
+    SENTRY_PROFILE_SESSION_SAMPLE_RATE: z
+      .string()
+      .transform((val) => Number.parseInt(val))
+      .optional()
+      .default('0.0'),
+    SENTRY_EVENT_LOOP_BLOCK_THRESHOLD_MS: z.coerce.number().optional(),
   })
   .refine((input) => {
     if (input.STRIPE_WEBHOOK_SECRET && !input.STRIPE_SECRET_KEY) {

controlplane/src/core/sentry.config.ts

@@ -4,17 +4,28 @@ import * as Sentry from '@sentry/node';
 import { nodeProfilingIntegration } from '@sentry/profiling-node';
 import { eventLoopBlockIntegration } from '@sentry/node-native';
 
-if (process.env.SENTRY_ENABLED) {
-  Sentry.init({
-    dsn: process.env.SENTRY_DSN,
-    integrations: [
-      eventLoopBlockIntegration({ threshold: Number(process.env.SENTRY_EVENT_LOOP_BLOCK_THRESHOLD_MS) }),
-      nodeProfilingIntegration(),
-    ],
-    profileSessionSampleRate: Number(process.env.SENTRY_PROFILE_SESSION_SAMPLE_RATE),
-    sendDefaultPii: Boolean(process.env.SENTRY_SEND_DEFAULT_PII),
-    tracesSampleRate: Number(process.env.SENTRY_TRACES_SAMPLE_RATE),
-  });
+export interface SentryConfig {
+  sentry: {
+    enabled: boolean;
+    dsn: string;
+    eventLoopBlockIntegrationThresholdMs?: number;
+    profileSessionSampleRate?: number;
+    sendDefaultPii?: boolean;
+    tracesSampleRate?: number;
+  };
 }
 
-export * as Sentry from '@sentry/node';
+export function init(opts: SentryConfig) {
+  if (process.env.SENTRY_ENABLED) {
+    Sentry.init({
+      dsn: opts.sentry.dsn,
+      integrations: [
+        eventLoopBlockIntegration({ threshold: opts.sentry.eventLoopBlockIntegrationThresholdMs }),
+        nodeProfilingIntegration(),
+      ],
+      profileSessionSampleRate: opts.sentry.profileSessionSampleRate,
+      sendDefaultPii: opts.sentry.sendDefaultPii,
+      tracesSampleRate: opts.sentry.tracesSampleRate,
+    });
+  }
+}

controlplane/src/index.ts

@@ -5,6 +5,7 @@ import 'dotenv/config';
 
 import build, { BuildConfig } from './core/build-server.js';
 import { envVariables } from './core/env.schema.js';
+import { SentryConfig } from './core/sentry.config.js';
 
 const {
   LOG_LEVEL,
@@ -66,6 +67,12 @@ const {
   REDIS_PASSWORD,
   AUTH_ADMISSION_JWT_SECRET,
   CDN_BASE_URL,
+  SENTRY_ENABLED,
+  SENTRY_DSN,
+  SENTRY_SEND_DEFAULT_PII,
+  SENTRY_TRACES_SAMPLE_RATE,
+  SENTRY_PROFILE_SESSION_SAMPLE_RATE,
+  SENTRY_EVENT_LOOP_BLOCK_THRESHOLD_MS,
 } = envVariables.parse(process.env);
 
 const options: BuildConfig = {
@@ -170,9 +177,19 @@ if (STRIPE_SECRET_KEY) {
   };
 }
 
-if (process.env.SENTRY_ENABLED === 'true') {
-  if (process.env.SENTRY_DSN) {
-    await import('./core/sentry.config.js');
+if (SENTRY_ENABLED) {
+  if (SENTRY_DSN) {
+    const sentryConfig: SentryConfig = {
+      sentry: {
+        enabled: SENTRY_ENABLED,
+        dsn: SENTRY_DSN,
+        eventLoopBlockIntegrationThresholdMs: SENTRY_EVENT_LOOP_BLOCK_THRESHOLD_MS,
+        profileSessionSampleRate: SENTRY_PROFILE_SESSION_SAMPLE_RATE,
+        sendDefaultPii: SENTRY_SEND_DEFAULT_PII,
+        tracesSampleRate: SENTRY_TRACES_SAMPLE_RATE,
+      },
+    };
+    await import('./core/sentry.config.js').then((sentry) => sentry.init(sentryConfig));
   } else {
     throw new Error('SENTRY_ENABLED is set but SENTRY_DSN is not');
   }