perf: Configure `shouldCreateSpanForRequest` option for Sentry `browserTracingIntegration`

[MajorLift]

Motivation

The Sentry browser tracing integration intercepts all outgoing fetch requests, and measures their duration in automatically-generated http.client spans.

Currently, our Sentry configuration does not exclude POST requests to Sentry DSN endpoints from this process. Unfortunately, these requests appear to have been taking up not just a non-negligible, but an outright dominating footprint in our Sentry performance quota and budget.

Based on usage data over the past 90 days in our metamask Sentry project, we can make the following observations (the following data only covers requests sent to sentry.io, and doesn't include requests sent to hostnames under that domain e.g. *.ingest.us.sentry.io):

• In both the /home.html and /popup.html traces, the auto-generated spans for sentry POST requests collectively rank in 3rd place by the "Time Spent" metric, only coming in behind the ui.long-task and pageload spans, and actually being ahead of navigation as well as all other legitimate requests to resource API endpoints.

https://metamask.sentry.io/performance/summary/spans/?project=273505&query=&statsPeriod=90d&transaction=%2Fpopup.html

https://metamask.sentry.io/performance/summary/spans/?project=273505&query=&statsPeriod=90d&transaction=%2Fhome.html

• While the average duration of the Sentry spans is around 0.5s, there are instances where they last for much longer (30s - 1m).
  • An argument could be made that we should leave the Sentry spans to measure these edge cases. However, I think it would be a safe assumption that drastic delays like these will be accompanied by and captured through similar delays in other outgoing network requests. Unless we have reason to target delayed communications that only affect Sentry, filtering out these spans wouldn't result in meaningful information being lost.

https://metamask.sentry.io/performance/summary/spans/http.client:8ee04019c21406cc/?project=273505&query=&sort=-span.duration&statsPeriod=90d&transaction=%2Fpopup.html

https://metamask.sentry.io/performance/summary/spans/http.client:8ee04019c21406cc/?project=273505&query=&sort=-span.duration&statsPeriod=90d&transaction=%2Fhome.html

Description

To fix this, we need to filter out communications with Sentry itself from the monitoring data that is logged to the Sentry dashboard.

This commit achieves this by configuring Sentry's browser tracing integration with its shouldCreateSpanForRequest option.

Related issues

• Closes https://github.com/MetaMask/MetaMask-planning/issues/3636

Manual testing steps

1. Initialize the MetaMask extension with Sentry enabled.
2. [Optional] Take actions that are measured by custom spans (e.g. toggle between account overview tabs, load the account list). This isn't necessary, as communications with Sentry will already have taken place in the first step.
3. Verify in the Sentry dashboard that no recent http.client spans for 'sentry.io' have been logged.

Screenshots/Recordings

Before

Note the three http.client spans for 'sentry.io':

After

No auto-generated http.client spans show up in the Sentry dashboard for POST requests to the Sentry DSN endpoint, even though the requests are still going out.

http.client spans for other URLs are still being created and measured.

Pre-merge author checklist

• [x] I've followed MetaMask Contributor Docs and MetaMask Extension Coding Standards.
• [x] I've completed the PR template to the best of my ability
• [x] I’ve included tests if applicable
• [x] I’ve documented my code using JSDoc format if applicable
• [x] I’ve applied the right labels on the PR (see labeling guidelines). Not required for external contributors.

Pre-merge reviewer checklist

• [ ] I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed).
• [ ] I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.

[github-actions[bot]]

CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes.

[metamaskbot]

Builds ready [9142f93]

• builds: chrome, firefox
• builds (beta): chrome
• builds (flask): chrome, firefox
• builds (MMI): chrome, firefox
• builds (test): chrome, firefox
• builds (test-flask): chrome, firefox
• build viz: Build System
• mv3: Background Module Init Stats
• mv3: UI Init Stats
• mv3: Module Load Stats
• mv3: Bundle Size Stats
• mv2: E2e Actions Stats
• code coverage: Report
• storybook: Storybook
• typescript migration: Dashboard
• all artifacts
• bundle viz:

  • background: 0, 1, 2, 3, 4, 5, 6, 7
  • common: 0, 1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9
  • content-script: 0
  • offscreen: 0
  • ui: 0, 1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (1967 ± 79 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1762	2305	1966	161	77
		domContentLoaded	1743	2293	1933	151	72
		load	1754	2309	1967	165	79
		domInteractive	17	82	40	17	8
		backgroundConnect	11	89	34	27	13
		firstReactRender	78	392	146	75	36
		getState	5	60	17	18	8
		initialActions	0	1	0	0	0
		loadScripts	1261	1769	1431	138	66
		setupStore	6	86	14	19	9
		uiStartup	1950	2781	2234	243	117

Bundle size diffs [🚨 Warning! Bundle size has increased!]

• background: 0 Bytes (0.00%)
• ui: 0 Bytes (0.00%)
• common: 59 Bytes (0.00%)

[metamaskbot]

Builds ready [0552f10]

• builds: chrome, firefox
• builds (beta): chrome
• builds (flask): chrome, firefox
• builds (MMI): chrome, firefox
• builds (test): chrome, firefox
• builds (test-flask): chrome, firefox
• build viz: Build System
• mv3: Background Module Init Stats
• mv3: UI Init Stats
• mv3: Module Load Stats
• mv3: Bundle Size Stats
• mv2: E2e Actions Stats
• code coverage: Report
• storybook: Storybook
• typescript migration: Dashboard
• all artifacts
• bundle viz:

  • background: 0, 1, 2, 3, 4, 5, 6, 7
  • common: 0, 1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9
  • content-script: 0
  • offscreen: 0
  • ui: 0, 1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (2053 ± 102 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	303	2798	1780	626	301
		domContentLoaded	1766	2700	2024	189	91
		load	1772	2846	2053	212	102
		domInteractive	16	217	60	43	21
		backgroundConnect	8	112	35	32	15
		firstReactRender	98	163	123	21	10
		getState	5	61	19	19	9
		initialActions	0	0	0	0	0
		loadScripts	1295	2135	1500	169	81
		setupStore	6	58	13	15	7
		uiStartup	1980	3196	2298	251	121

Bundle size diffs [🚨 Warning! Bundle size has increased!]

• background: 0 Bytes (0.00%)
• ui: 0 Bytes (0.00%)
• common: 88 Bytes (0.00%)