Skip to content

feat(bridge): add quote and operation performance telemetry - #9899

Open
bfullam wants to merge 10 commits into
mainfrom
swaps-4935-sentry-dashboard-traces
Open

feat(bridge): add quote and operation performance telemetry#9899
bfullam wants to merge 10 commits into
mainfrom
swaps-4935-sentry-dashboard-traces

Conversation

@bfullam

@bfullam bfullam commented Aug 17, 2026

Copy link
Copy Markdown
Contributor

Explanation

The existing Swaps and Bridge controller traces do not provide a complete, reliable performance picture: quote traces conflate expected cancellations with failures, provider latency is not attributable to individual routers, and transaction traces end at submission rather than operation completion.

This PR adds the Core instrumentation required for SWAPS-4935:

  • Adds explicit success, cancelled, no_quotes, and error outcomes to non-Batch Sell quote traces.
  • Adds backdated Quote Provider First Result traces, deduplicated by normalized provider and correlated to the parent request.
  • Uses one canonical quote-trace boundary—controller request dispatch through quote-operation completion—for the aggregate quote traces, including the existing Batch Sell trace.
  • Adds the unified Swap Operation Completed trace for single-chain and cross-chain operations, with swap_type, terminal_stage, result, route, provider, identifiers, and submission-to-terminal duration.
  • Emits operation completion for same-chain transaction outcomes and cross-chain Bridge API terminal outcomes using the existing controller lifecycle.
  • Batch Sell remains outside the new provider-level and explicit-result attribute schema; failure categorization remains out of scope.

Mobile package consumption and the remaining Mobile-owned trace hardening are follow-up work in SWAPS-4935.

References

Checklist

  • I've updated the test suite for new or updated code as appropriate
  • I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
  • I've communicated my changes to consumers by updating changelogs for packages I've changed
  • I've introduced breaking changes in this PR and have prepared draft pull requests for clients and consumer packages to resolve them

Test plan

  • yarn exec oxfmt on changed Core files
  • ESLint on changed Core files
  • Focused BridgeController Jest tests: 86 passed
  • Focused BridgeStatusController Jest tests: 152 passed
  • yarn workspace @metamask/bridge-controller run build
  • yarn workspace @metamask/bridge-status-controller run build
  • yarn workspace @metamask/bridge-status-controller run changelog:validate

Note

Low Risk
Observability-only changes with guarded trace callbacks; quote and status business logic paths are largely unchanged aside from classification of aborts and new telemetry hooks.

Overview
Adds Sentry-oriented performance telemetry for swap/bridge quote fetching and end-to-end operations (SWAPS-4935).

Bridge controller: Quote fetch tracing is reworked so aggregate traces (Bridge Quotes Fetched / Swap Quotes Fetched) run in a finally block with explicit result values (success, cancelled, no_quotes, error), correlated request_id (UUID), and feature_id. Expected aborts are classified via isExpectedQuoteAbort instead of being treated like failures. New backdated Quote Provider First Result traces fire once per normalized provider on the first quote (SSE and non-SSE), linked to the parent request. Trace emission is wrapped so telemetry errors cannot break quote fetching.

Bridge status controller: Introduces Swap Operation Completed backdated traces when operations reach a terminal state—same-chain on source tx success/failure, cross-chain on Bridge API status completion—with swap_type, terminal_stage, provider, ids, hashes, and duration_ms from startTime to completion.

Changelogs and focused Jest coverage document the new trace shapes and scenarios.

Reviewed by Cursor Bugbot for commit 27f1175. Bugbot is set up for automated code reviews on this repo. Configure here.

Add explicit quote outcomes and provider first-result traces so Swaps and Bridge quote latency and reliability can be measured in Sentry.
@bfullam
bfullam requested a review from a team as a code owner August 17, 2026 15:00
Add backdated success and error telemetry for single-chain and cross-chain swap operations, including route, provider, result, and terminal-stage dimensions. Guard terminal state transitions to keep completion state and traces idempotent.
@bfullam
bfullam requested a review from a team as a code owner August 17, 2026 18:03
@bfullam bfullam changed the title feat(bridge-controller): instrument quote fetch performance feat(bridge): add quote and operation performance telemetry Aug 17, 2026

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 2 potential issues.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 019ac53. Configure here.

Comment thread packages/bridge-controller/src/bridge-controller.ts
Comment thread packages/bridge-controller/src/bridge-controller.ts Outdated
Keep provider and aggregate quote traces best effort so rejected telemetry callbacks cannot clear fetched quotes or interrupt quote refresh state.
Restore existing terminal-event handling and make abort coverage await the asynchronous rejection while retaining the Sentry instrumentation.
@bfullam

bfullam commented Aug 18, 2026

Copy link
Copy Markdown
Contributor Author

@metamaskbot publish-preview

@github-actions

Copy link
Copy Markdown
Contributor

Preview builds have been published. Learn how to use preview builds in other projects.

Expand for full list of packages and versions.
@metamask-previews/account-tree-controller@8.0.0-preview-c2ef75d18
@metamask-previews/accounts-controller@39.1.0-preview-c2ef75d18
@metamask-previews/address-book-controller@7.1.2-preview-c2ef75d18
@metamask-previews/ai-controllers@0.8.0-preview-c2ef75d18
@metamask-previews/analytics-controller@2.0.0-preview-c2ef75d18
@metamask-previews/analytics-data-regulation-controller@0.0.0-preview-c2ef75d18
@metamask-previews/announcement-controller@8.1.0-preview-c2ef75d18
@metamask-previews/app-metadata-controller@2.0.1-preview-c2ef75d18
@metamask-previews/approval-controller@9.0.2-preview-c2ef75d18
@metamask-previews/assets-controller@13.1.4-preview-c2ef75d18
@metamask-previews/assets-controllers@111.1.1-preview-c2ef75d18
@metamask-previews/authenticated-user-storage@3.0.1-preview-c2ef75d18
@metamask-previews/base-controller@9.1.0-preview-c2ef75d18
@metamask-previews/base-data-service@0.1.3-preview-c2ef75d18
@metamask-previews/bitcoin-regtest-up@1.0.0-preview-c2ef75d18
@metamask-previews/bridge-controller@79.2.0-preview-c2ef75d18
@metamask-previews/bridge-status-controller@75.1.0-preview-c2ef75d18
@metamask-previews/build-utils@3.0.4-preview-c2ef75d18
@metamask-previews/chain-agnostic-permission@1.7.0-preview-c2ef75d18
@metamask-previews/chomp-api-service@4.0.0-preview-c2ef75d18
@metamask-previews/claims-controller@0.6.0-preview-c2ef75d18
@metamask-previews/client-controller@1.0.1-preview-c2ef75d18
@metamask-previews/client-utils@2.0.2-preview-c2ef75d18
@metamask-previews/compliance-controller@2.1.0-preview-c2ef75d18
@metamask-previews/composable-controller@12.0.1-preview-c2ef75d18
@metamask-previews/config-registry-controller@2.0.1-preview-c2ef75d18
@metamask-previews/connectivity-controller@0.3.0-preview-c2ef75d18
@metamask-previews/controller-utils@12.3.0-preview-c2ef75d18
@metamask-previews/core-backend@8.1.2-preview-c2ef75d18
@metamask-previews/delegation-controller@3.0.2-preview-c2ef75d18
@metamask-previews/earn-controller@12.2.5-preview-c2ef75d18
@metamask-previews/eip-5792-middleware@3.0.5-preview-c2ef75d18
@metamask-previews/eip-7702-internal-rpc-middleware@0.1.1-preview-c2ef75d18
@metamask-previews/eip1193-permission-middleware@2.0.1-preview-c2ef75d18
@metamask-previews/ens-controller@19.1.6-preview-c2ef75d18
@metamask-previews/eth-block-tracker@15.0.1-preview-c2ef75d18
@metamask-previews/eth-json-rpc-middleware@24.0.0-preview-c2ef75d18
@metamask-previews/eth-json-rpc-provider@6.0.1-preview-c2ef75d18
@metamask-previews/foundryup@1.0.1-preview-c2ef75d18
@metamask-previews/gas-fee-controller@26.3.1-preview-c2ef75d18
@metamask-previews/gator-permissions-controller@5.0.1-preview-c2ef75d18
@metamask-previews/geolocation-controller@1.0.0-preview-c2ef75d18
@metamask-previews/java-tron-up@1.0.0-preview-c2ef75d18
@metamask-previews/json-rpc-engine@10.5.0-preview-c2ef75d18
@metamask-previews/json-rpc-middleware-stream@8.0.8-preview-c2ef75d18
@metamask-previews/keyring-controller@27.1.1-preview-c2ef75d18
@metamask-previews/kyc-controller@0.0.0-preview-c2ef75d18
@metamask-previews/local-node-utils@1.0.0-preview-c2ef75d18
@metamask-previews/logging-controller@9.0.0-preview-c2ef75d18
@metamask-previews/message-manager@14.1.2-preview-c2ef75d18
@metamask-previews/messenger@2.0.0-preview-c2ef75d18
@metamask-previews/messenger-cli@0.2.0-preview-c2ef75d18
@metamask-previews/money-account-api-data-service@0.4.0-preview-c2ef75d18
@metamask-previews/money-account-balance-service@2.4.1-preview-c2ef75d18
@metamask-previews/money-account-controller@1.0.0-preview-c2ef75d18
@metamask-previews/money-account-upgrade-controller@3.0.1-preview-c2ef75d18
@metamask-previews/money-account-utils@1.1.0-preview-c2ef75d18
@metamask-previews/multichain-account-service@13.0.2-preview-c2ef75d18
@metamask-previews/multichain-api-middleware@4.0.2-preview-c2ef75d18
@metamask-previews/multichain-network-controller@3.2.3-preview-c2ef75d18
@metamask-previews/multichain-transactions-controller@7.1.2-preview-c2ef75d18
@metamask-previews/name-controller@9.1.2-preview-c2ef75d18
@metamask-previews/network-connection-banner-controller@0.2.0-preview-c2ef75d18
@metamask-previews/network-controller@35.0.1-preview-c2ef75d18
@metamask-previews/network-enablement-controller@6.0.3-preview-c2ef75d18
@metamask-previews/notification-services-controller@26.0.1-preview-c2ef75d18
@metamask-previews/passkey-controller@3.0.0-preview-c2ef75d18
@metamask-previews/permission-controller@13.1.1-preview-c2ef75d18
@metamask-previews/permission-log-controller@5.1.0-preview-c2ef75d18
@metamask-previews/perps-controller@12.0.0-preview-c2ef75d18
@metamask-previews/phishing-controller@17.3.1-preview-c2ef75d18
@metamask-previews/platform-api-docs@0.0.0-preview-c2ef75d18
@metamask-previews/polling-controller@16.0.9-preview-c2ef75d18
@metamask-previews/preferences-controller@23.1.0-preview-c2ef75d18
@metamask-previews/profile-metrics-controller@4.0.3-preview-c2ef75d18
@metamask-previews/profile-sync-controller@29.0.0-preview-c2ef75d18
@metamask-previews/ramps-controller@20.0.0-preview-c2ef75d18
@metamask-previews/rate-limit-controller@7.0.1-preview-c2ef75d18
@metamask-previews/react-data-query@0.2.2-preview-c2ef75d18
@metamask-previews/remote-feature-flag-controller@5.0.0-preview-c2ef75d18
@metamask-previews/sample-controllers@5.0.4-preview-c2ef75d18
@metamask-previews/seedless-onboarding-controller@10.1.1-preview-c2ef75d18
@metamask-previews/selected-network-controller@26.1.6-preview-c2ef75d18
@metamask-previews/sentinel-api-service@1.0.0-preview-c2ef75d18
@metamask-previews/shield-controller@6.0.0-preview-c2ef75d18
@metamask-previews/signature-controller@39.2.9-preview-c2ef75d18
@metamask-previews/smart-transactions-controller@25.1.0-preview-c2ef75d18
@metamask-previews/snap-account-service@2.1.2-preview-c2ef75d18
@metamask-previews/social-controllers@2.7.1-preview-c2ef75d18
@metamask-previews/solana-test-validator-up@1.0.0-preview-c2ef75d18
@metamask-previews/stellar-quickstart-up@0.0.0-preview-c2ef75d18
@metamask-previews/storage-service@1.0.2-preview-c2ef75d18
@metamask-previews/subscription-controller@7.0.0-preview-c2ef75d18
@metamask-previews/transaction-controller@69.5.2-preview-c2ef75d18
@metamask-previews/transaction-pay-controller@26.3.0-preview-c2ef75d18
@metamask-previews/user-operation-controller@41.2.8-preview-c2ef75d18
@metamask-previews/wallet@10.0.0-preview-c2ef75d18
@metamask-previews/wallet-cli@0.0.0-preview-c2ef75d18

Keep swap_type on provider and unified operation traces, where it adds flow context, but omit it from aggregate traces whose names already identify the flow.
…aces

Use the backdated trace start time as the single duration boundary instead of duplicating the measurement as a custom attribute.
Comment thread packages/bridge-status-controller/src/utils/trace.ts
Include feature-flow context on provider, approval, submission, and operation spans so Sentry dashboard panels can be segmented consistently.
Comment thread packages/bridge-controller/src/bridge-controller.ts
Comment thread packages/bridge-controller/src/bridge-controller.ts Outdated
Prevent provider performance telemetry from delaying quote processing or state updates.
Keep provider tracing non-blocking without adding an uncovered promise handler.
infiniteflower
infiniteflower previously approved these changes Aug 19, 2026
Align streaming provider traces with the end-to-end first usable quote timing.
@bfullam

bfullam commented Aug 19, 2026

Copy link
Copy Markdown
Contributor Author

@metamaskbot publish-preview

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants