Skip to content
Docs

External dependencies

OpenRUM separates control-plane state from high-volume telemetry. Production deployments should use managed or HA versions of these dependencies; Compose is for local evaluation only.

Dependency Role Required
PostgreSQL Users, Organizations, Projects, keys, Releases, Issue workflow and audit state Yes
ClickHouse Immutable Events and query aggregates Yes
Kafka Durable ingestion buffer between accept and store Yes
Redis Quotas, short-lived state and rate limits Yes
Object storage Source Map Artifacts and future large objects (OSS or S3-compatible) Optional

Holds the control plane. Login, Project configuration, write keys and Issue State depend on it. Back up with PITR or equivalent and restore as part of a single recovery set with ClickHouse and optional object storage. See PostgreSQL operations.

Stores Events and aggregates used by Analysis, Sessions, Issues, performance and API views. Consumer lag and insert health determine query freshness. See ClickHouse operations.

Accepts envelopes only after durable acknowledgement. Consumer failure delays visibility but must not delete committed data. Never reset offsets without an approved replay plan. See Kafka operations.

Supports limits and ephemeral coordination. Treat Redis loss as degraded rate limiting and state, not as the only durable telemetry store. API and Ingest report not ready while it is unreachable. The Helm Chart can run a single Redis for you or use your own; see Redis: bundled or external and Redis operations.

Optional. Core monitoring works without a Bucket. Source Map upload and mapped frames require Alibaba OSS or an S3-compatible provider. See Object storage.

Before production, review Capacity planning, run the documented benchmark with measured traffic inputs, and establish backup/restore and upgrade runbooks.

Release Alpha · commit local