feat(api): Add Sentry Integeration

.env.example

@@ -5,6 +5,10 @@ GITHUB_CLIENT_ID=
 GITHUB_CLIENT_SECRET= 
 GITHUB_CALLBACK_URL=
 
+SENTRY_DSN=
+SENTRY_TRACES_SAMPLE_RATE=
+SENTRY_PROFILES_SAMPLE_RATE=
+
 SMTP_HOST=
 SMTP_PORT=
 SMTP_EMAIL_ADDRESS=
@@ -15,3 +19,5 @@ JWT_SECRET=secret
 
 WEB_FRONTEND_URL=https://keyshade.xyz
 WORKSPACE_FRONTEND_URL=https://app.keyshade.xyz
+
+NODE_ENV='development <prod | dev>'

.gitignore

@@ -48,4 +48,6 @@ Thumbs.db
 pnpm-lock.yaml
 
 # Database
-data/
+data/
+# Sentry Config File
+.sentryclirc

apps/api/src/main.ts

@@ -11,6 +11,8 @@ import chalk from 'chalk'
 import moment from 'moment'
 import { QueryTransformPipe } from './common/query.transform.pipe'
 import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger'
+import * as Sentry from '@sentry/node'
+import { ProfilingIntegration } from '@sentry/profiling-node'
 
 class CustomLogger implements LoggerService {
   log(message: string) {
@@ -43,30 +45,49 @@ class CustomLogger implements LoggerService {
 }
 
 async function bootstrap() {
-  const logger = new CustomLogger()
-  const app = await NestFactory.create(AppModule, {
-    logger
+  Sentry.init({
+    dsn: process.env.SENTRY_DSN,
+    environment: process.env.NODE_ENV,
+    tracesSampleRate: Number(process.env.SENTRY_TRACES_SAMPLE_RATE) || 1.0,
+    profilesSampleRate: Number(process.env.SENTRY_PROFILES_SAMPLE_RATE) || 1.0,
+    integrations: [new ProfilingIntegration()],
+    debug: process.env.NODE_ENV.startsWith('dev')
   })
-  const globalPrefix = 'api'
-  app.setGlobalPrefix(globalPrefix)
-  app.useGlobalPipes(
-    new ValidationPipe({
-      whitelist: true,
-      transform: true
-    }),
-    new QueryTransformPipe()
-  )
-  const port = 4200
-  const swaggerConfig = new DocumentBuilder()
-    .setTitle('keyshade')
-    .setDescription('The keyshade API description')
-    .setVersion('1.0')
-    .build()
-  const document = SwaggerModule.createDocument(app, swaggerConfig)
-  SwaggerModule.setup('docs', app, document)
-  await app.listen(port)
-  logger.log(
-    `🚀 Application is running on: http://localhost:${port}/${globalPrefix}`
+  await Sentry.startSpan(
+    {
+      op: 'mainSpan',
+      name: 'My Main Span'
+    },
+    async () => {
+      const logger = new CustomLogger()
+      const app = await NestFactory.create(AppModule, {
+        logger
+      })
+      app.use(Sentry.Handlers.requestHandler())
+      app.use(Sentry.Handlers.tracingHandler())
+      const globalPrefix = 'api'
+      app.setGlobalPrefix(globalPrefix)
+      app.useGlobalPipes(
+        new ValidationPipe({
+          whitelist: true,
+          transform: true
+        }),
+        new QueryTransformPipe()
+      )
+      const port = 4200
+      const swaggerConfig = new DocumentBuilder()
+        .setTitle('keyshade')
+        .setDescription('The keyshade API description')
+        .setVersion('1.0')
+        .build()
+      const document = SwaggerModule.createDocument(app, swaggerConfig)
+      SwaggerModule.setup('docs', app, document)
+      app.use(Sentry.Handlers.errorHandler())
+      await app.listen(port)
+      logger.log(
+        `🚀 Application is running on: http://localhost:${port}/${globalPrefix}`
+      )
+    }
   )
 }
 

package.json

@@ -95,7 +95,7 @@
     "prettier:fix": "nx run-many -t prettier:lint --parallel",
     "prettier:fix:api": "nx run api:prettier:fix",
     "build": "nx run-many -t build -p api web workspace --parallel --maxParallel 3",
-    "build:api": "nx run api:build --configuration=production",
+    "build:api": "nx run api:build --configuration=production && pnpm sentry:sourcemaps",
     "build:web": "nx run web:build --configuration=production",
     "build:workspace": "nx run workspace:build",
     "test": "nx run-many -t test --parallel",
@@ -114,7 +114,8 @@
     "db:validate": "nx run api:prisma:validate",
     "db:format": "nx run api:prisma:format",
     "db:reset": "nx run api:prisma:reset",
-    "prepare": "husky install"
+    "prepare": "husky install",
+    "sentry:sourcemaps": "sentry-cli sourcemaps inject --org programmingnotcoding --project node ./dist && sentry-cli sourcemaps upload --org programmingnotcoding --project node ./dist"
   },
   "devDependencies": {
     "@nestjs/schematics": "^10.0.3",
@@ -181,6 +182,9 @@
     "@semantic-release/commit-analyzer": "^11.1.0",
     "@semantic-release/git": "^10.0.1",
     "@semantic-release/release-notes-generator": "^12.1.0",
+    "@sentry/cli": "^2.28.0",
+    "@sentry/node": "^7.100.1",
+    "@sentry/profiling-node": "^7.100.1",
     "@supabase/supabase-js": "^2.39.2",
     "@types/jsonwebtoken": "^9.0.5",
     "axios": "^1.6.5",

tsconfig.base.json

@@ -14,9 +14,17 @@
     "skipLibCheck": true,
     "skipDefaultLibCheck": true,
     "baseUrl": ".",
+
     "paths": {
       "cli": ["apps/cli/src/index.ts"]
-    }
+    },
+
+    "inlineSources": true,
+
+    // Set `sourceRoot` to  "/" to strip the build path prefix
+    // from generated source code references.
+    // This improves issue grouping in Sentry.
+    "sourceRoot": "/"
   },
   "exclude": ["node_modules", "tmp"]
 }