Skip to content

📝 Document the WebSocket resource event generated from WebSocket vitals - #5294

Merged
bdibon merged 1 commit into
mainfrom
boris.dibon/websocket-resource-doc
Nov 17, 2026
Merged

bdibon merged 1 commit into
mainfrom
boris.dibon/websocket-resource-doc

Conversation

@bdibon

@bdibon bdibon commented Nov 17, 2026 •

Copy link
Copy Markdown
Contributor

Motivation

When betaTrackWebSockets is enabled, the Datadog backend uses the WebSocket vitals to generate a RUM resource event (resource.type: 'websocket') for each connection. The option's TSDoc doesn't say so, and it doesn't say that this event never reaches beforeSend.

Changes

betaTrackWebSockets-docs

Update the TSDoc comment of the betaTrackWebSockets option (packages/browser-rum-core/src/domain/configuration/configuration.ts) to:

  • say that the backend generates a websocket resource event from the WebSocket vitals
  • say that the SDK does not send this event, so it does not go through the beforeSend hook
  • link to the WebSocket attributes documentation

This PR only changes a comment.

Test instructions

Nothing to test. Check the comment wording and that the link works.

Rendered with yarn build:docs:html (RumInitConfiguration page of @datadog/browser-rum):

Checklist

  • Tested locally
  • Tested on staging
  • Added unit tests for this change.
  • Added e2e/integration tests for this change.
  • Updated documentation and/or relevant AGENTS.md file

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@bdibon
bdibon marked this pull request as ready for review November 17, 2026 12:51
@bdibon
bdibon requested a review from a team as a code owner November 17, 2026 12:51
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 17, 2026 •

Copy link
Copy Markdown
Codex Review Summary: ✅ Completed

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-17T12:52:10.799091Z 16fdd38 Draft marked ready
🔒 Security Review ✅ Completed 2026-11-17T12:53:40.413921Z 16fdd38 Draft marked ready
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@cit-pr-commenter-54b7da

Copy link
Copy Markdown

Bundles Sizes Evolution

📦 Bundle Name Base Size Local Size 𝚫 𝚫% Status
Rum Salesforce 192.62 KiB 192.62 KiB 0 B 0.00% ✅
Rum 192.60 KiB 192.60 KiB 0 B 0.00% ✅
Rum Salesforce Profiler 8.01 KiB 8.01 KiB 0 B 0.00% ✅
Rum Profiler 8.01 KiB 8.01 KiB 0 B 0.00% ✅
Rum Salesforce Recorder 32.62 KiB 32.62 KiB 0 B 0.00% ✅
Rum Recorder 32.62 KiB 32.62 KiB 0 B 0.00% ✅
Logs 60.22 KiB 60.22 KiB 0 B 0.00% ✅
Rum Slim 148.53 KiB 148.53 KiB 0 B 0.00% ✅
Worker 24.23 KiB 24.23 KiB 0 B 0.00% ✅
Rum Shopify 223.66 KiB 223.66 KiB 0 B 0.00% ✅
Rum Shopify Profiler 8.00 KiB 8.00 KiB 0 B 0.00% ✅
Rum Shopify Recorder 4.85 KiB 4.85 KiB 0 B 0.00% ✅

@datadog-datadog-us1-prod

datadog-datadog-us1-prod Bot commented Nov 17, 2026 •

Copy link
Copy Markdown

Pipelines  Tests

🎉 All green!

🧪 All tests passed
❄️ No new flaky tests detected

🎯 Code Coverage (details)
• Patch Coverage: 100.00%
• Overall Coverage: 78.09% (-0.05%)

This comment will be updated automatically if new data arrives.
🔗 Commit SHA: 16fdd38 | Docs | View more details | Give us feedback!

@datadog-datadog-us1-prod datadog-datadog-us1-prod 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.

Bits Code Review: PASS

More details

The documentation is consistent with the WebSocket implementation and existing tests: WebSocket vitals reach beforeSend, while backend-generated resource events bypass it.

Was this helpful? React 👍 or 👎

Open Bits AI session

🤖 Bits Code Review · Commit 16fdd38

@bdibon
bdibon merged commit 49345fc into main Nov 17, 2026
33 checks passed
@bdibon
bdibon deleted the boris.dibon/websocket-resource-doc branch November 17, 2026 13:27
@github-actions github-actions Bot locked and limited conversation to collaborators Nov 17, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants