rrweb

What is rrweb?

rrweb is a library for recording and replaying user interactions on web applications. It captures user events such as clicks, scrolls, and form inputs, and allows you to replay these events to understand user behavior or debug issues.

What are rrweb's main functionalities?

Recording User Interactions

This feature allows you to record user interactions on a web page. The `record` function starts recording and emits events that can be sent to a server or saved locally.

const rrweb = require('rrweb');
const stopFn = rrweb.record({
  emit(event) {
    // send event to your server or save it locally
    console.log(event);
  },
});
// To stop recording
stopFn();

Replaying Recorded Sessions

This feature allows you to replay recorded sessions. The `rrwebPlayer` takes the recorded events and replays them in a specified container element.

const rrwebPlayer = require('rrweb-player');
new rrwebPlayer({
  target: document.body, // the container element
  data: {
    events: [], // the array of recorded events
  },
});

Custom Event Handling

This feature allows you to handle custom events during the recording. You can filter and process specific types of events as needed.

const rrweb = require('rrweb');
const stopFn = rrweb.record({
  emit(event) {
    if (event.type === 'custom') {
      // handle custom event
      console.log('Custom event:', event);
    }
  },
});
// To stop recording
stopFn();

Other packages similar to rrweb

fullstory

FullStory is a digital experience analytics platform that captures and analyzes user interactions on web and mobile applications. It provides similar functionalities to rrweb but includes advanced analytics and insights.

mouseflow

Mouseflow is a session replay and heatmap tool that tracks user interactions on your website. It provides functionalities similar to rrweb, including session recordings and heatmaps, but also offers funnel analysis and form analytics.

README

Try rrweb

rrweb

This is a simpler version of the original rrewb 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

• rrdom: an ad-hoc DOM for rrweb session data #419
• storage engine: do deduplication on a large number of rrweb sessions
• more end-to-end tests
• 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

1. Fork this repository.
2. Run yarn install in the root to install required dependencies for all sub-packages (note: npm install is not recommended).
3. Run yarn dev in the root to get auto-building for all the sub-packages whenever you modify anything.
4. Navigate to one of the sub-packages (in the packages folder) where you'd like to make a change.
5. Patch the code and run yarn test to run the tests, make sure they pass before you commit anything.
6. 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

Core Team Members

Yuyz0112

Mark-Fenng

eoghanmurray

Juice10

Who's using rrweb