This section gives a short introduction about the user interface of KaDeck and how to connect to a server and monitor the records of one topic.
Fig.1 KaDeck's record browser with visible data attribute bar ("Payment_Method_Code").
KaDeck has four main screens:
- Cluster Overview
- Record browser
- Settings screen
- Info screen
The cluster overview page is the first screen that you see when starting KaDeck. The cluster overview page shows your available cluster connections and the embedded cluster card.
Fig. 2 A server card with configured SASL and Schema Registry security settings.
Start adding your first cluster connection data by clicking on the "Add new cluster" icon.
Name your cluster configuration and enter your bootstrap servers (<host>:<port>) in the corresponding input field. Enter multiple servers by separating the servers by a comma. A name of a server configuration does not need to be unique.
You can add additional connection details like the Schema Registry address and security configurations.
After you are finished, click on "Connect" to connect to the Kafka broker.
The topic browser is where you can view topics, views, analyze records and create new records.
The topic browser page can be divided into three sections. These are from left to right: the topic list, the detail view (that is hidden if no record is selected), and the record list.
After you have connected to a cluster on the cluster overview page, you will see the list of available topics on the left. If your cluster contains no topics, this list will be empty. By default, no system topics are displayed. You can view system topics by clicking on the triangle next to Topics and select "Show internal topics".
Once you have selected a topic in the topic browser, the last 100 records of this topic are being displayed in the record list. You can choose to see more records by using the "limit menu bar" at the bottom of the record list.
Note that records from all partitions are being displayed. If you want to view records from only one specific partition, click the partition toggle switch in the filter/partition section below the main menu bar to switch all partitions off and toggle the partition of interest back on by clicking on it. This is a convenient way of activating just one partition if your topic contains multiple partitions.
KaDeck's auto-detection feature has tried to choose the right codec for your topic automatically. If you want to change the codec that is being used to decode the keys and values, click on the "Decoder" button in the main menu bar.
You can sort records by clicking on the column header: ascending, descending and no sorting.
Click on the record to open the detail view.
The detail view displays detailed information about your record, the partition, topic, timestamp, header information, as well as key and value.
If your record contains structured data such as JSON or Avro, you can click on a data attribute to open the data attribute bar (fig. 1) which lets you create a new filter for the attribute (lense symbol) or adding the attribute as a column to the record list (eye symbol, only on Professional/Enterprise Edition).
In the settings view, you can configure the internal settings and behavior of KaDeck.