Repository navigation
@sentry/nextjs bundle size and tree shaking #7680
Description
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? If you use the CDN bundles, please specify the exact bundle (e.g. bundle.tracing.min.js) in your SDK setup.
@sentry/nextjs
SDK Version
7.46.0
Framework Version
7.46.0
Link to Sentry event
No response
SDK Setup
import * as Sentry from '@sentry/nextjs';
const SENTRY_DSN = process.env.SENTRY_DSN || process.env.NEXT_PUBLIC_SENTRY_DSN;
Sentry.init({
dsn: SENTRY_DSN,
environment: process.env.STAGE
});Steps to Reproduce
Using @sentry/nextjs": "^7.15.0, the bundle analyzer reports
Stat: 84.93KB
Parsed Size: 20.52KB
Gzipped: 6.41KB
Using @sentry/nextjs": "^7.46.0, the bundle analyzer reports
Stat: 305.32KB
Parsed Size: 50.19KB
Gzipped: 15.56KB
Attempting to follow the tree shaking guide and the following setup produces roughly the same result
import {
defaultStackParser,
getCurrentHub,
Breadcrumbs,
BrowserClient,
makeFetchTransport,
Dedupe,
FunctionToString,
GlobalHandlers,
HttpContext,
InboundFilters,
LinkedErrors,
TryCatch,
} from '@sentry/nextjs';
const SENTRY_DSN = process.env.SENTRY_DSN || process.env.NEXT_PUBLIC_SENTRY_DSN;
getCurrentHub().bindClient(
new BrowserClient({
dsn: SENTRY_DSN,
transport: makeFetchTransport,
stackParser: defaultStackParser,
environment: process.env.STAGE,
integrations: [
new Breadcrumbs(),
new Dedupe(),
new FunctionToString(),
new GlobalHandlers(),
new HttpContext(),
new InboundFilters(),
new LinkedErrors(),
new TryCatch(),
],
})
);
Expected Result
The bundle size should not constitute a significant portion of the overall application bundle, or at least be tree shakeable.
Actual Result
The bundle size has grown significantly over past releases
The following related issue does not seem to have a resolution
Activity
lforst commentedon Mar 31, 2023
We do have a continuous effort to keep bundle size low. Unfortunately for the amount of features we provide (and users want to see and use) there is a trade-off to be had. Trust me when I say, that the term "bundle size" is a term that is mentioned almost daily in the team ^^
I am gonna close this issue because it is not actionable at the moment. Feel free to reopen if you have a suspicion that this is a) a regression or b) if you have an idea of how to resolve this.
In case of a) please also provide a link to a website where we can check if unwanted code is included.
davidfurlong commentedon Apr 1, 2023
this is kinda unusable for a bunch of kinds of apps; production build - standard @sentry/next-js setup on
"@sentry/nextjs": "^7.46.0",rchl commentedon Apr 2, 2023
Inclusion of
@sentry/replayis probably the biggest offender as it's probably not used by most people anyway.I would think that NOT doing
import * as Sentryshould tree shake it out but I don't have experience with Next SDK, only with Vue SDK, where it does indeed help to notimport *.lforst commentedon Apr 3, 2023
I couldn't reproduce this exact issue in a test app but something caught my eye and I have a feeling it is gonna fix this: #7710
philwolstenholme commentedon Apr 3, 2023
Do you know when that change might make it into a release @lforst ? I'm evaluating Sentry with Next at the moment at work, but adding it has taken us over our performance budget.
lforst commentedon Apr 3, 2023
@philwolstenholme probably sometime in the next few days. Just to confirm what you mean by performance budget: It's bundle size right and not Sentry Transaction quota, right?
philwolstenholme commentedon Apr 3, 2023
@lforst ah yes sorry, it's nothing to do with Sentry, it's Lighthouse in CI running against a deployment preview URL.
luukdv commentedon Apr 3, 2023
Another option is not bundling Sentry in your main bundle (if you can accept the tradeoff of not having Sentry available from the very first millisecond):
carbonrobot commentedon Apr 3, 2023
@luukdv absolutely. I've been looking at ways of removing our dependency on the sentry/nextjs package and just pulling everything in manually to avoid the bundling. Nextjs packages are already fairly large and as much as we love sentry we can't take the size it imposes for many apps
lforst commentedon Apr 3, 2023
I have a feeling this won't work due to how we bundle Sentry in Next.js app but I will happily be proven otherwise! Also I think this will mess up performance measurements and request instrumentation as these usually require Sentry to be initialized asap.
3 remaining items
sanex3339 commentedon Apr 5, 2023
The problem with this approach is that Sentry is extracted to the separate chunk, but this chunk is loaded at the same time as the
next.jschunk.You can see that the chunk contains also some
next.jsmodulesWe're trying to conditionally disable sentry (including loading its code) on the client side based on a query parameter (for debug purposes), so we want to load it lazily only if the query parameter is missing.
But right now because this behavior with lazy chunks we can't properly disable sentry in some cases.
For example, just for
clientbundle i tried to replace@sentry/nextjsby@sentry/reactand it's extracted to the lazy chunk properly.okonet commentedon Apr 5, 2023
Similar issue here with the latest
@sentry/nexttaking ~50% of my_appbundle.Is there any way of reducing it?
Update:
Updated to
7.47.0and the bundle size went from 56KB to 53KB which is a bit better but still huge compared to the rest of my app:lforst commentedon Apr 6, 2023
@okonet you can follow our tree shaking guide if you aren't already: https://docs.sentry.io/platforms/javascript/guides/nextjs/configuration/tree-shaking/
Note that you will miss out on features though!
okonet commentedon Apr 6, 2023
I actually already did this so I was expecting a bigger savings. Right now I see that the replay is about 50% of the bundle but it still leaves me with about 30KB if I disable it completely. If this the minimum bundle size possible?
lforst commentedon Apr 6, 2023
@okonet I am not sure where we're at with the minimum size right now but it seems about right. I am sorry that the bundle is quite large. If you have suggestions on how to improve it, let us know.
okonet commentedon Apr 6, 2023
Okay thanks for the info. I'll play around with the custom client setup to shrink it a bit further.
stevez86 commentedon Jun 5, 2023
Due to the attitude of the team around bundle size, we are removing sentry from our business.
lforst commentedon Jun 6, 2023
Respectable decision
mtariqsajid commentedon Aug 12, 2023
can we use sentry in party town so it should load lazy ?
lforst commentedon Aug 14, 2023
We have a loader script that will load the SDK lazily but comes with a few drawbacks - like for instance no special Next.js performance instrumentation.
ailadson commentedon Sep 15, 2024
I hate to say it, but my company is dropping Sentry. The bundle size of sentry/nextjs is not reasonable at all. It adds 200 MB to our bundled slug, which is insane.
lforst commentedon Sep 16, 2024
@ailadson I can confidently say that there is no way the SDK adds 200 MB to your build unless there is something going horribly wrong. Feel free to share details.
ailadson commentedon Sep 16, 2024
@lforst Will do! Hopefully this was a mistake on my end, because I reall do like Sentry
This is an screenshoot of the build log when I had Sentry. Note line 4419
This is a my package.json when I had Sentry.
Now here is a screenshot of the build log after I removed Sentry. Note line 1589. This is over a 200M difference.
All I did was remove Sentry. Here is my current package.json
Ah, for the record, we were using @sentry/nextjs. The logs are from github actions. We are deploying to heroku. I followed the steps given by
npx @sentry/wizard@latest -i nextjsto setup sentry on my project. What other information can I give you that would be useful?ailadson commentedon Sep 16, 2024
@lforst my guess is that it's related to the @sentry/cli linking that happens (see the first build logs)
lforst commentedon Sep 17, 2024
@ailadson oh ok, you're referring to install size (amount of data downloaded on installation) which is something completely different than bundle size (amount of data served to your users).
We generally don't optimize for install size (unless it is becoming an issue). In your case 200MB seems a bit much though. We do ship a binary with the
@sentry/clipackage, however, it comes as part ofoptionalDependencieswhere it should not download and install binaries that are not supported by your platform. I recommend you check your package manager settings to see whether you turned offoptionalDependenciesresolving.Also, please evaluate whether you want to open another issue, since this one is specifically about bundle size and not install size.