OpenRUM documentation

OpenRUM is open-source, self-hosted frontend monitoring. Choose local development or production deployment, follow the steps to start an Instance and sign in, then connect your applications.

Where to start

Local developmentPrepare your computer, start services, change code and verify with the example app and test data generator.

Production deploymentPrepare data services, an image and HTTPS, deploy with Helm, create an administrator and connect a real Project.

Unsure which path to choose? Read the introduction. If an Instance is already running, create your first project.

By task

Deploy to productionTopology, dependencies and the decisions that are hard to reverse later.

Instrument a server-rendered appNext.js and Astro, where initializing in the wrong place drops Events with no error.

Investigate a production issueFollow one error from a Session to its Issue, affected users and the failed Request.

Read the performance dataWhat each Core Web Vital is measured against, and when a percentile has too few samples to trust.

Get readable stack tracesUpload Source Maps per Release, and understand why mapped frames are optional.

Look up a settingEvery environment variable, the Event schema and the HTTP API.

Back up and restoreTreat the control plane, the Event store and optional Artifacts as one recovery set.

Check what is collectedCollection boundaries, retention and the fields OpenRUM refuses to accept.

Before you expose an Instance

OpenRUM is Alpha. Read the threat model and capacity planning, and verify capacity with your actual workload. Published local single-host benchmarks are not production capacity guarantees.

Documentation is available in English and Chinese. Use the language selector in the header to switch.