Sentry is not initialized on server-side for SSR Astro project

[aldy505]

Is there an existing issue for this?

• I have checked for existing issues https://github.com/getsentry/sentry-javascript/issues
• I have reviewed the documentation https://docs.sentry.io/
• I am using the latest SDK release https://github.com/getsentry/sentry-javascript/releases

How do you use Sentry?

Self-hosted/on-premise

Which SDK are you using?

@sentry/astro

SDK Version

7.77.0

Framework Version

3.4.2

Link to Sentry event

No response

SDK Setup

See repro below

Steps to Reproduce

See repro on https://github.com/aldy505/sentry-astro-endpoints-reproduction

Try for development build:

Run npm run dev, then curl http://localhost:4321/sentry-endpoints/hello. Check terminal/console, expect to see:

Tracing extension 'startTransaction' is missing. You should 'init' the SDK before calling 'startTransaction'

Then try for production build:

Run npm run build, execute NODE_ENV=production node ./dist/server/entry.mjs, then curl http://localhost:4321/sentry-endpoints/hello. Check terminal/console, expect to see:

Tracing extension 'startTransaction' is missing. You should 'init' the SDK before calling 'startTransaction'

Expected Result

Sentry is initialized and event is sent.

Actual Result

Tracing extension 'startTransaction' is missing. You should 'init' the SDK before calling 'startTransaction'

[Lms24]

Hi @aldy505 thanks for opening this issue ad

I was able to reproduce this issue but only when the curl request is the first request that hits the Astro server. Seems like the SDK is only initialized when the first page load request is sent to the server (for instance, when you open the page in your browser). After this first request, the curl request also creates a transaction. I think that this happens because we inject the SDK code on the server side into the page-ssr bundle:

sentry-javascript/packages/astro/src/integration/index.ts

Lines 64 to 70 in cb49f96

	if (pathToServerInit) {
	options.debug && console.log(`[sentry-astro] Using ${pathToServerInit} for server init.`);
	injectScript('page-ssr', buildSdkInitFileImportSnippet(pathToServerInit));
	} else {
	options.debug && console.log('[sentry-astro] Using default server init.');
	injectScript('page-ssr', buildServerSnippet(options || {}));
	}

This probably only is executed one a pageload request comes in.

I think, overall, this is not ideal so we should investigate if we can use another hook to initialize the SDK. However, given that Astro isn't primarily used as a general web service/API, I think initializing the SDK on the first page load request is somewhat acceptable.

Related: I just merged #9445 which adds a Sentry middleware you can register in src/middleware.ts. This will ship in the next release which will probably happen today. The middleware will automatically create a server-side transaction for each incoming request. However, it doesn't change anything in regards to the initialization problem.

[Lms24]

Oh furthermore, the reason why world.ts doesn't log the warning is because in the trace function we check for the SDK initialization (indirectly). However, this only removes the warning and it doesn't change the behaviour w.r.t creating a transaction.

[Zellerich]

We have a similar problem since we upgraded to next 14.
Once starting the local dev enviroment the console is spammed with
"Tracing extension 'startTransaction' is missing. You should 'init' the SDK before calling 'startTransaction'"

There is nothing special in either the sentry.client.config.ts or the sentry.server.config.ts (they are the same)

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

Sentry.init({
  environment: process.env.NEXT_PUBLIC_SENTRY_ENVIRONMENT || "unknown",
  dsn: "*****",
});

EDIT: It seems that the latest next canary version seems to fix it (14.0.2-canary.20)

[Lms24]

@Zellerich thanks for letting us know! If this turns out not to be fixed with the next canary version, please open a separate issue as our instrumentation for NextJS differs from the one in Astro. Thank you!