Quick Start

5-Minute Quick Start

1. Prerequisites

• Docker (for PostgreSQL + Kafka via docker-compose)
• Git and Gradle wrapper (./gradlew) are included in the repository.
• (Development Only) JDK 21+ and Node.js 18+ if building from source.

2. Typical Docker Flow

The simplest way to run EventLens in a project is via Docker Compose alongside your existing services.

1. Expose your events via a Postgres view called eventlens_events.
2. Create an EventLens config (eventlens.yaml).
3. Run the EventLens container, mounting the config file.
4. Open the UI at http://localhost:9090 and start exploring!

See Installation and Docker Deployment for concrete container examples.

Return Home