UI for Apache Kafka is a free, open-source web UI to monitor and manage Apache Kafka clusters.
UI for Apache Kafka is a simple tool that makes your data flows observable, helps find and troubleshoot issues faster and deliver optimal performance. Its lightweight dashboard makes it easy to track key metrics of your Kafka clusters - Brokers, Topics, Partitions, Production, and Consumption.
Set up UI for Apache Kafka with just a couple of easy commands to visualize your Kafka data in a comprehensible way. You can run the tool locally or in the cloud.
- Multi-Cluster Management — monitor and manage all your clusters in one place
- Performance Monitoring with Metrics Dashboard — track key Kafka metrics with a lightweight dashboard
- View Kafka Brokers — view topic and partition assignments, controller status
- View Kafka Topics — view partition count, replication status, and custom configuration
- View Consumer Groups — view per-partition parked offsets, combined and per-partition lag
- Browse Messages — browse messages with JSON, plain text, and Avro encoding
- Dynamic Topic Configuration — create and configure new topics with dynamic configuration
- Configurable Authentification — secure your installation with optional Github/Gitlab/Google OAuth 2.0
UI for Apache Kafka wraps major functions of Apache Kafka with an intuitive user interface.
UI for Apache Kafka makes it easy for you to create topics in your browser by several clicks, pasting your own parameters, and viewing topics in the list.
It's possible to jump from connectors view to corresponding topics and from a topic to consumers (back and forth) for more convenient navigation. connectors, overview topic`s settings.
Let's say we want to produce messages for our topic. With the UI for Apache Kafka we can send or write data/messages to the Kafka topics without effort by specifying parameters, and viewing messages in the list.
There are 3 supported types of schemas: Avro®, JSON Schema, and Protobuf schemas.
Before producing avro-encoded messages, you have to add an avro schema for the topic in Schema Registry. Now all these steps are easy to do with a few clicks in a user-friendly interface.
To run UI for Apache Kafka, you can use a pre-built Docker image or build it locally.
We have plenty of docker-compose files as examples. They're built for various configuration stacks.
Example of how to configure clusters in the application-local.yml configuration file:
kafka: clusters: - name: local bootstrapServers: localhost:29091 zookeeper: localhost:2183 schemaRegistry: http://localhost:8085 schemaRegistryAuth: username: username password: password # schemaNameTemplate: "%s-value" jmxPort: 9997 -
name: cluster name
bootstrapServers: where to connect
zookeeper: zookeeper service address
schemaRegistry: schemaRegistry's address
schemaRegistryAuth.username: schemaRegistry's basic authentication username
schemaRegistryAuth.password: schemaRegistry's basic authentication password
schemaNameTemplate: how keys are saved to schemaRegistry
jmxPort: open jmxPosrts of a broker
readOnly: enable read only mode
Configure as many clusters as you need by adding their configs below separated with
Running From Docker Image
The official Docker image for UI for Apache Kafka is hosted here: hub.docker.com/r/provectuslabs/kafka-ui.
Launch Docker container in the background:
docker run -p 8080:8080 \ -e KAFKA_CLUSTERS_0_NAME=local \ -e KAFKA_CLUSTERS_0_BOOTSTRAPSERVERS=kafka:9092 \ -d provectuslabs/kafka-ui:latest
If you prefer to use
docker-compose please refer to the documentation.
Building With Docker
Steps to build UI for Apache Kafka locally with Docker:
- Install prerequisites: Java and Docker
- Clone this repository and open a terminal in the directory of the project
- Build a Docker container with UI for Apache Kafka
- Start UI for Apache Kafka with your Kafka clusters
- Navigate to UI for Apache Kafka
- Java 13 or newer
Installing Prerequisites on Mac
- Install Homebrew Cask:
> brew update
- Install JAVA 13 with Homebrew Cask:
> brew tap adoptopenjdk/openjdk > brew install adoptopenjdk13
Once you installed the prerequisites and cloned the repository, run the following commands in your project directory:
Build a Docker container with UI for Apache Kafka:
./mvnw clean install -Pprod
Start UI for Apache Kafka with your Kafka clusters:
docker-compose -f ./docker/kafka-ui.yaml up
To see UI for Apache Kafka, navigate to http://localhost:8080.
If you want to start only kafka-clusters:
docker-compose -f ./docker/kafka-clusters-only.yaml up
Then start UI for Apache Kafka with a local profile.
Running Locally Without Docker
./mvnw spring-boot:run -Pprod
Running in Kubernetes
helm repo add kafka-ui https://provectus.github.io/kafka-ui helm install kafka-ui kafka-ui/kafka-ui
To read more please follow to chart documentation
Connecting to a Secure Broker
UI for Apache Kafka supports TLS (SSL) and SASL connections for encryption and authentication. This can be configured by providing a combination of the following files (placed into the Kafka root directory):
To be continued
Alternatively, each variable of the .yml file can be set with an environment variable.
For example, if you want to use an environment variable to set the
name parameter, you can write it like this:
||Setting log level (trace, debug, info, warn, error). Default: info|
||Setting log level (trace, debug, info, warn, error). Default: debug|
||Port for the embedded server. Default:
||Kafka API timeout in ms. Default:
||Address where to connect|
||Zookeeper service address|
||KSQL DB server address|
||Security protocol to connect to the brokers. For SSL connection use "SSL", for plaintext connection don't set this environment variable|
||SchemaRegistry's basic authentication username|
||SchemaRegistry's basic authentication password|
||How keys are saved to schemaRegistry|
||Open jmxPosrts of a broker|
||Enable read-only mode. Default: false|
||Disable collecting segments information. It should be true for confluent cloud. Default: false|
||Given name for the Kafka Connect cluster|
||Address of the Kafka Connect service endpoint|
||Enable SSL for JMX?
||Username for JMX authentication|
||Password for JMX authentication|