Skip to content

Commit f403c92

Browse files
Add embedded UI details (#5080)
Co-authored-by: Alexey Zimarev <[email protected]>
1 parent b99a2bd commit f403c92

File tree

4 files changed

+60
-13
lines changed

4 files changed

+60
-13
lines changed

docs/server/features/admin-ui.md

Lines changed: 60 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,78 @@
22
order: 1
33
---
44

5-
# Admin UI
5+
# Embedded Web UI
66

7-
The KurrentDB Admin 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.
7+
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.
88

99
::: tip
10-
The embedded KurrentDB web interface is reaching its end of life. We are working on a replacement, and you can try using the Early Preview of [Kurrent Navigator](https://navigator.kurrent.io/) app instead. It doesn't have full feature parity with the embedded web UI, but it already has usability improvements compared to it.
10+
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](https://navigator.kurrent.io/) app today. It doesn't have full feature parity with the legacy web UI, but it already has usability improvements compared to it.
1111
:::
1212

13-
## Dashboard
13+
## Embedded UI
14+
15+
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.
16+
17+
### Dashboard
18+
19+
![Embedded UI dashboard](images/ui/dashboard.png)
20+
21+
The dashboard is the embedded UI entry point. There, you find the following information:
22+
- **Cluster status**: Shows the cluster status and the number of nodes in the cluster.
23+
- **Cluster nodes**: Shows the list of nodes in the cluster and their status.
24+
- **Node resources**: Shows the node resources utilization, including CPU, memory, and disk usage.
25+
- **Node metrics**: Shows the node metrics, including the number of events written, read, and the number of open connections.
26+
27+
### Logs
28+
29+
<Badge type="info" vertical="middle" text="License Required"/>
30+
31+
![Embedded UI Logs page](images/ui/logs.png)
32+
33+
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.
34+
35+
Use the _Logs_ page to observe the cluster node's activity and troubleshoot any issues that may arise.
36+
37+
### Configuration
38+
39+
<Badge type="info" vertical="middle" text="License Required"/>
40+
41+
![Embedded UI configuration page](images/ui/config.png)
42+
43+
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).
44+
45+
The configuration is read-only, and you cannot modify it from the UI.
46+
47+
### Other Pages
48+
49+
Other pages of the embedded UI are:
50+
- **License**: Shows the license status of the cluster node. You can view the license type, expiration date, and other details.
51+
- **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.
52+
- **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.
53+
54+
## Legacy UI
55+
56+
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.
57+
58+
You can also open the legacy UI by clicking the _Legacy UI_ link of the new embedded UI sidebar.
59+
60+
### Dashboard
1461

1562
![Web admin interface dashboard](images/wai-dashboard.png)
1663

17-
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.
64+
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.
1865

1966
The second half of the tab shows active connections to KurrentDB and information about them.
2067

2168
Click the _Snapshot_ button in the top right to output a snapshot of all queue statistics at the time you clicked the button.
2269

23-
## Stream browser
70+
### Stream browser
2471

2572
![Web admin interface stream browser tab](images/wai-stream-browser.png)
2673

2774
The _Stream Browser_ tab gives an overview of recently created and changed streams, clicking on an individual stream shows details about the individual stream.
2875

29-
### Event stream
76+
#### Event stream
3077

3178
![Web admin interface stream details](images/wai-stream-details.png)
3279

@@ -49,7 +96,7 @@ The buttons on the left above the events when you are viewing an event stream ar
4996
- _metadata_: Shows the metadata of a stream.
5097
- On the metadata screen, click _Add New Like This_ to add a new event to the stream.
5198

52-
## Projections
99+
### Projections
53100

54101
![Web admin interface projections tab](images/wai-projections.png)
55102

@@ -75,13 +122,13 @@ On the left is the projection definition. On the right are the stats, results, a
75122
- _Reset_: Reset a projection.
76123
- _Back_: Returns you to the parent screen.
77124

78-
## Query
125+
### Query
79126

80127
The _Query_ tab has a code editor field where you can create transient and short-lived projections to analyze your event streams quickly.
81128

82129
![Web admin interface query details](images/wai-query-details.png)
83130

84-
## Persistent subscriptions
131+
### Persistent subscriptions
85132

86133
The _Persistent Subscriptions_ tab shows an overview of [persistent subscriptions](persistent-subscriptions.md) configured on streams. The button above the list does the following:
87134

@@ -94,18 +141,18 @@ Clicking the _+_ icon next to a stream name reveals the subscription name and mo
94141
- _Detail_: Shows the subscription configuration options.
95142
- _Replay Parked Messages_: Replay events in subscription to return state.
96143

97-
## Admin
144+
### Admin
98145

99146
![Web admin interface admin](images/wai-admin.png)
100147

101148
The _Admin_ tab shows subsystems enabled (currently only [projections](projections/README.md)) on KurrentDB and [scavenges](../operations/scavenge.md) run. You can start a new scavenge operation by clicking the _Scavenge_ button, and shut KurrentDB down by clicking the _Shutdown Server_ button.
102149

103-
## Users
150+
### Users
104151

105152
![Web admin interface projections tab](images/wai-users.png)
106153

107154
The _Users_ tab shows [the users defined in KurrentDB](../security/user-authentication.md). Clicking an individual user displays a JSON representation of that user's details.
108155

109-
## Log out
156+
### Log out
110157

111158
Logs you out of the Admin UI interface.
154 KB
Loading
309 KB
Loading
228 KB
Loading

0 commit comments

Comments
 (0)