Using the Management UI¶

This guide introduces the Management UI of EventSourcingDB. The UI provides a convenient way to monitor the system state and query events without writing code.

Overview¶

The Management UI consists of two main views:

A Dashboard that displays the current system health, including event counts, license usage, available disk space, memory usage, and other operational metrics.
An EventQL Query Editor that allows you to write and execute EventQL queries with a familiar developer experience, including syntax highlighting, auto-completion, error checking, and real-time feedback.

Additionally, the Query Editor integrates EventAI, an AI-based assistant that helps you design EventQL queries through natural language conversations.

Accessing the Management UI¶

The Management UI is available only when EventSourcingDB is started with the --with-ui CLI flag. Authentication is required to access the UI: simply provide the API token configured for the database.

Security Notice

The Management UI is intended only for development and debugging purposes. It should never be exposed to the public internet.

Using EventAI¶

To use EventAI inside the EventQL editor, you must configure an external language model. Currently, only GPT-4o from OpenAI is supported.

EventAI requires both the --ai-model and --ai-option CLI flags to be configured when starting EventSourcingDB. For example:

docker run -it -p 3000:3000 \
  thenativeweb/eventsourcingdb run \
  --api-token=secret \
  --data-directory-temporary \
  --http-enabled \
  --https-enabled=false \
  --with-ui \
  --ai-model openai-gpt-4o \
  --ai-option token=<OPENAI_API_TOKEN>

External Service and Costs

EventAI uses the OpenAI API, which is a paid service. Each query you generate will incur costs. Additionally, event schemas and prompts are sent to OpenAI's servers.

For complete configuration instructions, security considerations, privacy implications, and troubleshooting, see Configuring EventAI.

Dashboard View¶

The dashboard provides a visual overview of the database status. It aggregates information available from the health endpoint and presents it in an easy-to-read format.

Dashboard View

For additional details, see Logging and Monitoring.

EventQL and EventAI View¶

The EventQL editor enables you to write and execute queries directly against the event store. Using EventAI, you can also interactively generate or refine queries through AI-assisted conversations.

EventQL and EventAI View

For more information, see Running EventQL Queries.