ENV for enabling tracing in Sentry

configs/app/features/sentry.ts

@@ -21,6 +21,7 @@ const config: Feature<{
   instance: string;
   release: string | undefined;
   environment: string;
+  enableTracing: boolean;
 }> = (() => {
   if (dsn && instance && environment) {
     return Object.freeze({
@@ -30,6 +31,7 @@ const config: Feature<{
       instance,
       release,
       environment,
+      enableTracing: getEnvValue('NEXT_PUBLIC_SENTRY_ENABLE_TRACING') === 'true',
     });
   }
 

deploy/tools/envs-validator/schema.ts

@@ -160,6 +160,12 @@ const sentrySchema = yup
         then: (schema) => schema.test(urlTest),
         otherwise: (schema) => schema.max(-1, 'SENTRY_CSP_REPORT_URI cannot not be used without NEXT_PUBLIC_SENTRY_DSN'),
       }),
+    NEXT_PUBLIC_SENTRY_ENABLE_TRACING: yup
+      .boolean()
+      .when('NEXT_PUBLIC_SENTRY_DSN', {
+        is: (value: string) => Boolean(value),
+        then: (schema) => schema,
+      }),
     NEXT_PUBLIC_APP_INSTANCE: yup
       .string()
       .when('NEXT_PUBLIC_SENTRY_DSN', {

deploy/tools/envs-validator/test/.env.sentry

+NEXT_PUBLIC_SENTRY_DSN=https://sentry.io
+SENTRY_CSP_REPORT_URI=https://sentry.io
+NEXT_PUBLIC_SENTRY_ENABLE_TRACING=true
+NEXT_PUBLIC_APP_ENV=production
+NEXT_PUBLIC_APP_INSTANCE=duck
\ No newline at end of file

docs/ENVS.md

@@ -530,6 +530,7 @@ For blockchains that implementing SUAVE architecture additional fields will be s
 | --- | --- | --- | --- | --- | --- |
 | NEXT_PUBLIC_SENTRY_DSN | `string` | Client key for your Sentry.io app | Required | - | `<your-secret>` |
 | SENTRY_CSP_REPORT_URI | `string` | URL for sending CSP-reports to your Sentry.io app | - | - | `<your-secret>` |
+| NEXT_PUBLIC_SENTRY_ENABLE_TRACING | `boolean` | Enables tracing and performance monitoring in Sentry.io | - | `false` | `true` |
 | NEXT_PUBLIC_APP_ENV | `string` | App env (e.g development, review or production). Passed as `environment` property to Sentry config | - | `production` | `production` |
 | NEXT_PUBLIC_APP_INSTANCE | `string` | Name of app instance. Used as custom tag `app_instance` value in the main Sentry scope. If not provided, it will be constructed from `NEXT_PUBLIC_APP_HOST` | - | - | `wonderful_kepler` |
 

lib/sentry/config.ts

@@ -9,11 +9,22 @@ export const config: Sentry.BrowserOptions | undefined = (() => {
     return;
   }
 
+  const tracesSampleRate: number | undefined = (() => {
+    if (feature.environment === 'staging') {
+      return 1;
+    }
+
+    if (feature.environment === 'production' && feature.instance === 'eth') {
+      return 0.2;
+    }
+  })();
+
   return {
     environment: feature.environment,
     dsn: feature.dsn,
     release: feature.release,
-    enableTracing: false,
+    enableTracing: feature.enableTracing,
+    tracesSampleRate,
 
     // error filtering settings
     // were taken from here - https://docs.sentry.io/platforms/node/guides/azure-functions/configuration/filtering/#decluttering-sentry