How datadog/browser-sdk works
Project Type and Purpose
• This is a multi‐package monorepo (managed by Lerna & Yarn) that implements the Datadog Browser SDK: a set of JavaScript libraries for collecting logs, RUM (Real User Monitoring), session replay, and telemetry from a web application and shipping that data to Datadog.
• In addition to core SDK packages, it includes a developer browser extension (Chrome/Firefox), a web‐worker for payload compression, and a suite of E2E/unit tests plus CI/CD scripts.
File Structure Highlights
• Top‐level: monorepo config (lerna.json, package.json), CI/CD (.github/, .gitlab/), build & deploy scripts (scripts/), tsc/webpack configs.
• packages/: each subfolder is an independent npm package:
• core: foundational event/context/transport logic
• logs: browser log collection APIs
• rum-core & rum/rum-slim: Real User Monitoring event tracking
• rum-react: React integration plugin
• worker: web‐worker for deflate/compression
• flagging, performances, etc.
• developer-extension/: a browser extension with content scripts, background, devtools panel UI (React/TypeScript).
• test/: integration & E2E tests (Playwright, mock intake servers).
a. Main Runtime Components
1. Web Application (your SPA)
2. Datadog SDK Layer
• Bundled packages: browser-core, browser-logs, browser-rum (or rum-slim), browser-worker
• Boot modules: init/startRum(), startLogs(), spawn Worker
• Domain modules: event listeners, context managers, session management, telemetry, rate limiting
• Transport modules: batching, HTTP (fetch/XHR), send-with-retry, worker‐bridge
3. Web Worker
• Receives raw payloads via postMessage for compression/deflate
• Sends compressed payloads back to SDK transport
4. Datadog Intake Endpoint
• REST API (multiple sites: US1, EU1, etc.)
5. Developer Extension (optional)
• Content script bridges SDK events to background
• Background <–> DevTools panel via messaging
b. Relationships & Data Flow
• App code → SDK boot → domain event collectors → batch controller →
either direct HTTP or Worker-driven deflate → HTTP request → Datadog endpoint
• Developer Extension path: SDK pipes events through eventBridge → content script → background → panel
• Test harness: E2E tests spin up mock intake servers and validate request flows
c. Key Architectural Patterns
• Modular monorepo: each feature (core, logs, rum, react integration) isolated in its package
• Plugin architecture: rum-react plugs into rum-core lifecycle hooks
• Event pipeline: observable streams → debouncing/rate‐limiting → batch → transport
• Worker offload: CPU‐heavy tasks (deflate) delegated to Web Worker
• Developer Extension: “extension as a thin client” with content scripts + background + React panel
d. Technologies & Frameworks
• TypeScript + Jest for code + specs
• Webpack for bundling per‐package (CJS & ESM targets)
• Playwright for E2E tests
• Lerna/Yarn workspaces for monorepo management
• Chrome Extension APIs + React for the developer panel