feat(core): Add default ignoreTransactions for Healthchecks

[HazAT]

Default ignore health check Transactions.

Ref: getsentry/team-webplatform-meta#70

[github-actions]

size-limit report 📦

Path	Size
@sentry/browser - ES5 CDN Bundle (gzipped + minified)	21.12 KB (+0.46% 🔺)
@sentry/browser - ES5 CDN Bundle (minified)	65.86 KB (+0.37% 🔺)
@sentry/browser - ES6 CDN Bundle (gzipped + minified)	19.65 KB (+0.45% 🔺)
@sentry/browser - ES6 CDN Bundle (minified)	58.34 KB (+0.44% 🔺)
@sentry/browser - Webpack (gzipped + minified)	21.28 KB (+0.53% 🔺)
@sentry/browser - Webpack (minified)	69.26 KB (+0.33% 🔺)
@sentry/react - Webpack (gzipped + minified)	21.31 KB (+0.54% 🔺)
@sentry/nextjs Client - Webpack (gzipped + minified)	49.23 KB (+0.24% 🔺)
@sentry/browser + @sentry/tracing - ES5 CDN Bundle (gzipped + minified)	28.74 KB (+0.35% 🔺)
@sentry/browser + @sentry/tracing - ES6 CDN Bundle (gzipped + minified)	26.98 KB (+0.38% 🔺)
@sentry/replay ES6 CDN Bundle (gzipped + minified)	48.5 KB (+1.85% 🔺)
@sentry/replay - Webpack (gzipped + minified)	42.17 KB (+1.71% 🔺)
@sentry/browser + @sentry/tracing + @sentry/replay - ES6 CDN Bundle (gzipped + minified)	67.53 KB (+1.55% 🔺)
@sentry/browser + @sentry/replay - ES6 CDN Bundle (gzipped + minified)	60.45 KB (+1.8% 🔺)

[Lms24]

NextJS integration tests need adjustments as we're actually using URLS that match the health check regexes there 😅

sentry-javascript/packages/nextjs/test/integration/test/client/tracingPageLoad.test.ts

Lines 6 to 10 in ce8fc32

	const transaction = await getMultipleSentryEnvelopeRequests<Transaction>(page, 1, {
	url: '/healthy',
	envelopeType: 'transaction',
	});

[Lms24]

If we add them like this, we don't give users the possibility to opt-out of ignoring health checks.
Which makes this obsolete, right?

I see two options:

• only add the defaults if clientOptions.ignoreTransactions is undefined
• add another option (e.g. allowHealthCheckSpans #namingishard) to the SDK which defaults to false and we add the defaults here only as long as this option is false.

wdyt?

Although it's probably worth mentioning that even if we allow opt-in, users would need to enable this in two places - the SDK and the UI. Is this good UX?

[lforst]

NextJS integration tests need adjustments as we're actually using URLS that match the health check regexes there 😅

sentry-javascript/packages/nextjs/test/integration/test/client/tracingPageLoad.test.ts

Lines 6 to 10 in ce8fc32

	const transaction = await getMultipleSentryEnvelopeRequests<Transaction>(page, 1, {
	url: '/healthy',
	envelopeType: 'transaction',
	});

For reasons like this I don't really like this change. Super intransparent magic.

[k-fish]

fwiw, I've also seen ping

[HazAT]

we decided to keep consistency with https://docs.sentry.io/product/performance/performance-at-scale/#health-checks

but we can also change it there

[thinkocapo]

had a customer email me today that ping was 13 TPM while the rest were all .01 TPM and below. said it ate up their quota.

[thinkocapo]

it was python

[Lms24]

m: Can we split this into disableErrorDefaults and disableTransactionDefaults? I can already see folks wanting to disable the one but not the other.

[Lms24]

further m:
Are we okay with this being sort of hidden away for users?

To enable Health checks, they'd need to go from

Sentry.init({
  dsn: '...'
})

to

Sentry.init({
  dsn: '...',
  integrations: [new InboundFilters({disableTransactionDefaults: true})]
})

[Lms24]

I guess the alternative would be something like this:

Sentry.init({
  dsn: '...',
  ignoreHealthCheckTransactions: false
})

[Lms24]

Thinking about this again, we can go with the integration options for now and add the top level option if peole want it, I think that's okay for now.

[Lms24]

I'm still not in favour of this change but we discussed this thoroughly offline and general consensus across the org is that SDKs implement this, despite our raised concerns around increases in

• Difficulty for users
• API surface
• SDK maintainability efforts
• Bundle size

Therefore, we can merge anyway.

Let's please make sure to highlight this change though in the changelog of the next release.