@mixpanel/rrweb

Try rrweb

rrweb

This is a simpler version of the original rrweb README within this rrweb subpackage

中文文档

rrweb refers to 'record and replay the web', which is a tool for recording and replaying users' interactions on the web.

Guide

📚 Read the rrweb guide here. 📚

🍳 Recipes 🍳

Project Structure

rrweb mainly includes two funtions:

• Record: The record function is used to record all the mutations in the DOM
• Replay: The replay function is to replay the recorded mutations one by one according to the corresponding timestamp.

Roadmap

• storage engine: do deduplication on a large number of rrweb sessions
• compact mutation data in common patterns
• provide plugins via the new plugin API, including:
  • XHR plugin
  • fetch plugin
  • GraphQL plugin
  • ...

Internal Design

• serialization
• incremental snapshot
• replay
• sandbox

Contribute Guide

Since we want the record and replay sides to share a strongly typed data structure, rrweb is developed with typescript which provides stronger type support.

Typescript handbook

• Fork this repository.
• Run yarn install in the root to install required dependencies for all sub-packages (note: npm install is not recommended).
• Run yarn dev in the root to get auto-building for all the sub-packages whenever you modify anything.
• Navigate to one of the sub-packages (in the packages folder) where you'd like to make a change.
• Patch the code and run yarn test to run the tests, make sure they pass before you commit anything.
• Push the code and create a pull request.

Protip: You can run yarn test in the root folder to run all the tests.

In addition to adding integration tests and unit tests, rrweb also provides a REPL testing tool.

Using the REPL tool

Sponsors

Become a sponsor and get your logo on our README on Github with a link to your site.

Gold Sponsors 🥇

Silver Sponsors 🥈

Bronze Sponsors 🥉

Backers

Core Team Members

Yuyz0112

Yun Feng

eoghanmurray

Juice10 open for rrweb consulting

Who's using rrweb?

Similar packages

Other packages similar to @mixpanel/rrweb

rrweb

The upstream open-source session recording and replay library. It provides similar snapshot, event-recording, and replay capabilities; this package is a Mixpanel-maintained fork, so APIs and changes may differ.

@rrweb/record

The rrweb recording package, focused on capturing snapshots and interaction events. It offers similar recording functionality, while replay is provided separately in the rrweb package family.

@rrweb/replay

The rrweb replay package, focused on rendering recorded events. It is comparable for playback, but is the replay-focused part of the rrweb package family rather than the Mixpanel fork.

@sentry/replay

Sentry's browser session-replay SDK, designed to capture and send replay data as part of Sentry monitoring. It overlaps in session replay but is integrated with Sentry's product and ingestion workflow.

posthog-js

PostHog's JavaScript SDK includes session recording alongside analytics and other product features. It provides a broader product-analytics workflow rather than just a session recording and replay library.