Embedded Web UI
Embedded Web UI
The KurrentDB embedded UI is available at SERVER_IP:2113 and helps you interact with and visually manage a cluster. This guide explains the interface's tabs and their functions.
Tips
The legacy KurrentDB web interface (/web) is reaching its end of life. In the future, the legacy UI functionality will be split between the new embedded UI (available since V25.0) and Kurrent Navigator. You can try using the Preview version of Kurrent Navigator app today. It doesn't have full feature parity with the legacy web UI, but it already has usability improvements compared to it.
Embedded UI
The new embedded UI shows the cluster status and resources utilization, as well as some useful metrics about throughput of data being put to and read from the database. In addition, it shows some useful information about the cluster node like its configuration, license status, and more.
Dashboard
The dashboard is the embedded UI entry point. There, you find the following information:
- Cluster status: Shows the cluster status and the number of nodes in the cluster.
- Cluster nodes: Shows the list of nodes in the cluster and their status.
- Node resources: Shows the node resources utilization, including CPU, memory, and disk usage.
- Node metrics: Shows the node metrics, including the number of events written, read, and the number of open connections.
Logs
License Required
The Logs section shows the recent log messages of the cluster node. It's possible to filter log messages by log level and message content. The logs are streamed to the UI in real-time, so you can see the latest log messages as they are generated. The log stream starts at the moment you open the page, and there's no option to find olg logs on that page.
Use the Logs page to observe the cluster node's activity and troubleshoot any issues that may arise.
Configuration
License Required
On the Configuration page, you can view the current configuration of the cluster node. The configuration is displayed in a tabular format, and you can filter options by name, value, and source. The page shows description for each option, its current value, and the source from which it was set (e.g., default, environment variable, or configuration file).
The configuration is read-only, and you cannot modify it from the UI.
Other Pages
Other pages of the embedded UI are:
- License: Shows the license status of the cluster node. You can view the license type, expiration date, and other details.
- Navigator: Has a link to the Kurrent Navigator app download page, where you can also find supported features table in comparison with the legacy admin UI.
- Legacy UI: Has a link to the legacy web UI, which is still available for now. The legacy UI will be deprecated in the future, and you should use the new embedded UI or Kurrent Navigator instead.
Legacy UI
The legacy web UI is available at SERVER_IP:2113/web and helps you interact with and visually manage a cluster, as well as browse the data. This guide explains the interface's tabs and their functions.
You can also open the legacy UI by clicking the Legacy UI link of the new embedded UI sidebar.
Dashboard
In the legacy webUI, the Dashboard tab shows an overview of active queues with associated statistics in the top half. The + icon indicates a queue group; click it to reveal the queues in that group.
The second half of the tab shows active connections to KurrentDB and information about them.
Click the Snapshot button in the top right to output a snapshot of all queue statistics at the time you clicked the button.
Stream browser
The Stream Browser tab gives an overview of recently created and changed streams, clicking on an individual stream shows details about the individual stream.
Event stream
Each stream shows pages of the events in a stream with an overview of the event. Click the Name to see the EventId, and JSON to see the event data. The buttons above change depending on what you are viewing in the interface. The Back button takes you to the parent screen.
The buttons on the top right when you are viewing an event stream are:
- Pause: Stop showing events arriving into this stream.
- Resume: Resume showing events arriving into this stream.
- Edit ACL: Edit the access control lists for a stream.
- Add Event: Add a new event to the stream.
- Delete: Delete a stream to the stream.
- Query:
The buttons on the left above the events when you are viewing an event stream are:
- self: Takes you to the overview of the stream.
- first: Takes you to the first page of events in a stream.
- previous: Takes you to the previous page of events in a stream.
- metadata: Shows the metadata of a stream.
- On the metadata screen, click Add New Like This to add a new event to the stream.
Projections
The Projections tab shows system and user-created projections defined in KurrentDB. The buttons above the list do the following:
- Disable All: Disable all running projections.
- Enable All: Enable all stopped projections.
- Include Queries: Toggle displaying queries in the Projections table.
- New Projection: Create a user-defined projection with the Admin UI.
Clicking an individual projection shows further details.
On the left is the projection definition. On the right are the stats, results, and projection state. The buttons above the details do the following:
- Start: Start a stopped projection.
- Stop: Stop a running projection.
- Edit: Edit the projection definition.
- Config: Set configuration options for a projection.
- Debug: Opens the debugging interface to debug what effect a projection has on events.
- Delete: Delete a projection.
- Reset: Reset a projection.
- Back: Returns you to the parent screen.
Query
The Query tab has a code editor field where you can create transient and short-lived projections to analyze your event streams quickly.
Persistent subscriptions
The Persistent Subscriptions tab shows an overview of persistent subscriptions configured on streams. The button above the list does the following:
- New Subscription: Create a new subscription.
Clicking the + icon next to a stream name reveals the subscription name and more buttons. The Back button takes you to the parent screen.
- Edit: Edit the subscription.
- Delete: Delete the subscription.
- Detail: Shows the subscription configuration options.
- Replay Parked Messages: Replay events in subscription to return state.
Admin
The Admin tab shows subsystems enabled (currently only projections) on KurrentDB and scavenges run. You can start a new scavenge operation by clicking the Scavenge button, and shut KurrentDB down by clicking the Shutdown Server button.
Users
The Users tab shows the users defined in KurrentDB. Clicking an individual user displays a JSON representation of that user's details.
Log out
Logs you out of the Admin UI interface.