React Router Framework on Netlify

[cjoecker]

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?

Sentry Saas (sentry.io)

Which SDK are you using?

@sentry/react-router

SDK Version

9.15.0

Framework Version

No response

Link to Sentry event

7.5.0

Reproduction Example/SDK Setup

No response

Steps to Reproduce

1. Add Sentry to React Router as described in the documentation on the netlify app example
2. Deploy to Netlify
3. Throw a server error

Expected Result

1. Error is shown on Sentry

Actual Result

1. Error is not shown in Sentry

I guess the instrument.server.mjs cannot be started on Netlify functions

[chargome]

Hey @cjoecker, thanks for reporting!

Will have a look at this.

ref #15198

[cjoecker]

@chargome thanks for checking it!

As a workaround, I added this to the netlify.toml

[functions]
  included_files = ["instrument.server.mjs"]

And also needed to add this environment variable to Netlify: NODE_OPTIONS="--import ./instrument.server.mjs"

If you find a way to add Sentry to the server without the instrument.server.mjs, it will be great since I can imagine that will create issues with other hosting providers.

[chargome]

@cjoecker thanks for the hint!

If you find a way to add Sentry to the server without the instrument.server.mjs, it will be great since I can imagine that will create issues with other hosting providers.

Yes this is generally a pain point with ESM frameworks, if for example you just import the instrumentation file first you will get incomplete instrumentation – which is why we need to rely on the --import flag for now (check out https://github.com/getsentry/esm-observability-guide if you're insterested in details!).

[cjoecker]

@chargome, the workaround I thought would work on Netlify, is not working after it is deployed on production.

I opened this support ticket on Netlify, but with the current Sentry setup for React Router, it cannot be deployed there.

[chargome]

@cjoecker you can still import the instrument file on the top of your entry.server.ts file – but as mentioned you will have incomplete instrumentation this way.