Sentry tracing breaking the tracing of my Open Telemetry instrumentation in NextJs app

[elnatantorres]

Hi, guys! How are you?

I have instrumented a NextJs app with Open Telemetry to export traces to Grafana Tempo. I am basically using the default instrumentation provided by the package @vercel/otel with the PrismaInstrumentation provided by @prisma/instrumentation. This app also uses the Sentry SDKs: @sentry/nextjs e @sentry/profiling-node.

When I test it without Sentry instrumentation, the trace is generated with all prisma spans. But when I test with Sentry SDK, two traces are generated and the prisma spans are attached to the trace with instrumentationLibrary:@sentry/node. Additionally, the other trace, generated by my Open Telemetry intsrumentation, gets the attribute 'sentry.drop_transaction': true.

I already tried to disable Sentry tracing in many ways, but with no success:

• Setting the variable __SENTRY_TRACING__=false,
• Enabling the option excludeTracing of bundleSizeOptimizations in withSentryConfig
• Setting tracesSampleRate and tracesSampler of sentry.server.config.ts to undefined

The traces stopped being sent to Sentry, but the SDK keeps breaking my Open Telemetry traces.

Is there a way that I can use the Sentry SDK in my NextJs app and still instrument my app with Open Telemtry?

I will leave here the code that shows how my app is configured.

sentry.server.config.ts

import * as Sentry from '@sentry/nextjs';
import { nodeProfilingIntegration } from '@sentry/profiling-node';

Sentry.init({
  dsn: process.env.NEXT_PUBLIC_SENTRY_DSN,
  debug: false,
  integrations: [nodeProfilingIntegration()],
  sendDefaultPii: true,
  profilesSampleRate: 0.1,
  skipOpenTelemetrySetup: true,
});

sentry.edge.config.ts

import * as Sentry from '@sentry/nextjs';

Sentry.init({
  dsn: process.env.NEXT_PUBLIC_SENTRY_DSN,
  debug: false,
  sendDefaultPii: true,
  profilesSampleRate: 0.1,
  skipOpenTelemetrySetup: true, 
});

sentry/client.config.ts

import * as Sentry from '@sentry/nextjs';

Sentry.init({
  dsn: process.env.NEXT_PUBLIC_SENTRY_DSN,
  debug: false,
  replaysSessionSampleRate: 0.1,
  replaysOnErrorSampleRate: 0.1,
  sendDefaultPii: true,
  ignoreErrors: [
    '_AutofillCallbackHandler',
    'Non-Error promise rejection captured',
    /^Unexpected token.*/,
    /^Cannot read properties of undefined (reading 'call')/,
    /attempted to hard navigate to the same URL/,
  ],
  integrations: [
    Sentry.replayIntegration({
      maskAllText: true,
      blockAllMedia: true,
    }),
  ],
  skipOpenTelemetrySetup: true,
});

config in next.config.js

const { withSentryConfig } = require('@sentry/nextjs');

return withSentryConfig(config, {
  org: 'org',
  project: 'test-app',
  authToken: 'token',
  silent: true,
  tunnelRoute: '/monitoring',
  widenClientFileUpload: true,
  transpileClientSDK: false,
  hideSourceMaps: true,
  telemetry: false,
  automaticVercelMonitors: true,
  sourcemaps: {
    deleteSourcemapsAfterUpload: true,
  },
  bundleSizeOptimizations: {
    excludeTracing: true,
  }
});

instrumentation.ts

import { PrismaInstrumentation } from '@prisma/instrumentation';
import { registerOTel } from '@vercel/otel';

export async function register() {
  const instrumentations = [];
    instrumentations.push(
      new PrismaInstrumentation({
        middleware: true,
      })
    );

    registerOTel({
      serviceName: 'test-app',
      instrumentationConfig: {
        fetch: {
          ignoreUrls: [/^https:\/\/telemetry.nextjs.org/],
        },
      },
      instrumentations,
    });

  if (
    process.env.NEXT_RUNTIME === 'nodejs'
  ) {
    await import('../sentry.server.config');
  }

  if (
    (process.env.NEXT_RUNTIME === 'browser' || process.env.NEXT_RUNTIME === undefined)
  ) {
    await import('../sentry.client.config');
  }

  if (process.env.NEXT_RUNTIME === 'edge`) {
    await import('../sentry.edge.config');
  }
}

package.json

{
  "name": "test-app",
  "license": "MIT",
  "private": true,
  "engines": {
    "npm": "please-use-yarn",
    "node": "18.x || 20.x"
  },
  "packageManager": "yarn@4.6.0",
  "scripts": {
    "dev": "next dev"
  },
  "dependencies": {
    "@opentelemetry/api": "^1.8.0",
    "@opentelemetry/instrumentation": "^0.53.0",
    "@opentelemetry/sdk-logs": "^0.53.0",
    "@opentelemetry/sdk-trace-base": "^1.22.0",
    "@prisma/client": "5.22.0",
    "@prisma/instrumentation": "5.22.0",
    "@sentry/nextjs": "9.17.0",
    "@sentry/profiling-node": "9.17.0",
    "@vercel/edge-config": "^1.4.0",
    "@vercel/kv": "^1.0.1",
    "@vercel/otel": "1.14.0",
    "next": "14.2.25",
    "react": "18.2.0"
  },
  "devDependencies": {
    "@types/react": "18.2.0",
    "@types/react-dom": "18.2.0",
    "prisma": "5.22.0",
    "tailwindcss": "^3.4.1",
    "typescript": "^5.9.2"
  }
}