fix(tracing): automatically instrument server-side requests (#514)

Author: rchl

lib/core/hooks.js

@@ -168,6 +168,9 @@ export async function initializeServerSentry (moduleContainer, moduleOptions, se
     Sentry.init(config)
     sentryHandlerProxy.errorHandler = Sentry.Handlers.errorHandler()
     sentryHandlerProxy.requestHandler = Sentry.Handlers.requestHandler(moduleOptions.requestHandlerConfig)
+    if (serverOptions.tracing) {
+      sentryHandlerProxy.tracingHandler = Sentry.Handlers.tracingHandler()
+    }
   }
 
   process.sentry = Sentry

lib/core/options.js

@@ -116,6 +116,8 @@ function resolveTracingOptions (options, config) {
     config.tracesSampleRate = tracingOptions.tracesSampleRate
   }
   options.tracing = tracingOptions
+  // Enable tracing for `Http` integration.
+  options.serverIntegrations = merge({ Http: { tracing: true } }, options.serverIntegrations || {})
 }
 
 /**

lib/module.js

@@ -109,9 +109,14 @@ export default async function SentryModule (moduleOptions) {
     const sentryHandlerProxy = {
       errorHandler: (error, req, res, next) => { next(error) },
       requestHandler: (req, res, next) => { next() },
+      tracingHandler: (req, res, next) => { next() },
     }
     // @ts-ignore
     this.nuxt.hook('render:setupMiddleware', app => app.use((req, res, next) => { sentryHandlerProxy.requestHandler(req, res, next) }))
+    if (options.tracing) {
+      // @ts-ignore
+      this.nuxt.hook('render:setupMiddleware', app => app.use((req, res, next) => { sentryHandlerProxy.tracingHandler(req, res, next) }))
+    }
     // @ts-ignore
     this.nuxt.hook('render:errorMiddleware', app => app.use((error, req, res, next) => { sentryHandlerProxy.errorHandler(error, req, res, next) }))
     // @ts-ignore

types/sentry.d.ts

@@ -10,6 +10,7 @@ import { NodeOptions, Handlers } from '@sentry/node'
 export interface SentryHandlerProxy {
     errorHandler: (error: any, req: IncomingMessage, res: ServerResponse, next: (error: any) => void) => void
     requestHandler: (req: IncomingMessage, res: ServerResponse, next: (error?: any) => void) => void
+    tracingHandler: (req: IncomingMessage, res: ServerResponse, next: (error?: any) => void) => void
 }
 
 export type IntegrationsConfiguration = Record<string, unknown>