Introduction

OpenRUM is an open-source, self-hosted frontend monitoring platform. You run an Instance on your own infrastructure, add the Browser SDK to a web application, and investigate user behavior, errors, performance and API requests in the Console. Telemetry never leaves infrastructure you operate.

It is built around one investigation path: start from a change in behavior or a failed Session, follow it to the Issue behind it, and reach the stack frame that needs a fix, without copying IDs between tools.

What it covers

Capability	What you get	Read
Errors and investigation	JavaScript errors grouped into Issues, optional Source Map frames, the Session timeline around each.	Investigate an issue
Performance and APIs	Core Web Vitals, route performance, request latency and failures.	Performance
Behavior analytics	Page Views, visitors, Custom Events, funnels, paths and retention.	Behavior analytics
Logs	Structured browser logs searchable by severity, user and Session.	Logs
Dashboards and alerts	Project dashboards and metric alerts delivered to Feishu/Lark or a Webhook.	Alerts
Privacy by default	No raw input values, headers or bodies in automatic capture; headers and bodies only for APIs a project opts in.	Privacy

Where to start

Run it locallyStart the full stack with the demo dataset, or work on OpenRUM from source.

Deploy to productionKubernetes with Helm, or one Linux host with Docker, plus the data services they need.

Instrument an applicationCreate a Project, install the Browser SDK and see the first Event arrive.

Look something upEnvironment variables, SDK options, the Event schema and the HTTP API.

Find your way around

I want to…	Go to
Try OpenRUM on my machine	Local development
Deploy for my team	Deployment preparation
Upgrade, back up or troubleshoot an Instance	Operate
Set up Google, GitHub, OIDC or LDAP sign-in	Authentication setup
Install the SDK in Next.js or Astro	Next.js · Astro
Get readable stack traces	Source Maps
Understand how the pieces fit together	Architecture
Check how a term is used	Glossary and core concepts
Change OpenRUM itself	Contributing

What runs

An Instance has five application services: the Console web server, API, Ingest, Consumer and Worker. They use four required dependencies, PostgreSQL for accounts, projects and settings, ClickHouse for events and analysis queries, Kafka as the ingestion buffer, and Redis for caching and rate limits. Object storage is optional and only needed for Source Map uploads. Architecture shows how an event moves through them.

Alpha stage

OpenRUM is Alpha. Expect schema and API changes before the first stable release, and complete the deployment guide’s capacity, backup and access checks before accepting production traffic. Local benchmark results are not production capacity guarantees.