fix: sentry controlplane auto-instrumentation

Author: miklosbarabas

controlplane/src/core/env.schema.ts

@@ -186,6 +186,30 @@ 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')
+      .default('false'),
+    SENTRY_TRACES_SAMPLE_RATE: z.coerce.number().optional().default(1),
+    SENTRY_PROFILE_SESSION_SAMPLE_RATE: z.coerce.number().optional().default(1),
+    SENTRY_PROFILE_LIFECYCLE: z.enum(['manual', 'trace']).optional().default('manual'),
+    SENTRY_EVENT_LOOP_BLOCK_THRESHOLD_MS: z.coerce.number().optional().default(100),
+    SENTRY_ENABLE_LOGS: z
+      .string()
+      .optional()
+      .transform((val) => val === 'true')
+      .default('false'),
   })
   .refine((input) => {
     if (input.STRIPE_WEBHOOK_SECRET && !input.STRIPE_SECRET_KEY) {

controlplane/src/core/sentry.config.ts

@@ -2,21 +2,33 @@ import * as Sentry from '@sentry/node';
 import { nodeProfilingIntegration } from '@sentry/profiling-node';
 import { eventLoopBlockIntegration } from '@sentry/node-native';
 import { fastifyIntegration, pinoIntegration } from '@sentry/node';
+import { envVariables } from "./env.schema.js";
 
-if (process.env.SENTRY_ENABLED === 'true' && process.env.SENTRY_DSN) {
+const {
+  SENTRY_ENABLED,
+  SENTRY_DSN,
+  SENTRY_SEND_DEFAULT_PII,
+  SENTRY_TRACES_SAMPLE_RATE,
+  SENTRY_PROFILE_SESSION_SAMPLE_RATE,
+  SENTRY_PROFILE_LIFECYCLE,
+  SENTRY_EVENT_LOOP_BLOCK_THRESHOLD_MS,
+  SENTRY_ENABLE_LOGS
+} = envVariables.parse(process.env);
+
+if (SENTRY_ENABLED && SENTRY_DSN) {
   Sentry.init({
-    dsn: process.env.SENTRY_DSN,
+    dsn: SENTRY_DSN,
     integrations: [
       fastifyIntegration(),
-      eventLoopBlockIntegration({ threshold: Number(process.env.SENTRY_EVENT_LOOP_BLOCK_THRESHOLD_MS ?? 100) }),
+      eventLoopBlockIntegration({ threshold: SENTRY_EVENT_LOOP_BLOCK_THRESHOLD_MS }),
       nodeProfilingIntegration(),
       pinoIntegration({ log: { levels: ['info', 'warn', 'error'] } }),
     ],
-    profileSessionSampleRate: Number(process.env.SENTRY_PROFILE_SESSION_SAMPLE_RATE ?? 1),
-    sendDefaultPii: (process.env.SENTRY_SEND_DEFAULT_PII ?? 'true') === 'true',
-    tracesSampleRate: Number(process.env.SENTRY_TRACES_SAMPLE_RATE ?? 1),
-    profileLifecycle: (process.env.SENTRY_PROFILE_LIFECYCLE as 'trace' | 'manual') ?? 'trace',
-    enableLogs: (process.env.SENTRY_ENABLE_LOGS ?? 'false') === 'true',
+    profileSessionSampleRate: SENTRY_PROFILE_SESSION_SAMPLE_RATE,
+    sendDefaultPii: SENTRY_SEND_DEFAULT_PII,
+    tracesSampleRate: SENTRY_TRACES_SAMPLE_RATE,
+    profileLifecycle: SENTRY_PROFILE_LIFECYCLE,
+    enableLogs: SENTRY_ENABLE_LOGS,
   });
   console.log('Sentry is initialized.');
 }

controlplane/src/index.ts

@@ -1,4 +1,3 @@
-// eslint-disable-next-line import/order
 import './core/sentry.config.js';
 import * as Sentry from '@sentry/node';
 // eslint-disable-next-line import/order
@@ -71,6 +70,8 @@ const {
   REDIS_PASSWORD,
   AUTH_ADMISSION_JWT_SECRET,
   CDN_BASE_URL,
+  SENTRY_ENABLED,
+  SENTRY_DSN,
 } = envVariables.parse(process.env);
 
 const options: BuildConfig = {
@@ -176,9 +177,8 @@ if (STRIPE_SECRET_KEY) {
   };
 }
 
-
 const app = await build(options);
-if (process.env.SENTRY_ENABLED === 'true' && process.env.SENTRY_DSN) {
+if (SENTRY_ENABLED && SENTRY_DSN) {
   Sentry.setupFastifyErrorHandler(app);
 }
 await app.listen({