kafka-ui README

The project's README from github.com/provectus/kafka-ui. As one markdown file: README.md.

UI for Apache Kafka logo UI for Apache Kafka 

Versatile, fast and lightweight web UI for managing Apache Kafka® clusters. Built by developers, for developers.


License UI for Apache Kafka Price Free Release version Chat with us Docker pulls

DOCS • QUICK START • COMMUNITY DISCORD
AWS Marketplace • ProductHunt

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.

DISCLAIMER

UI for Apache Kafka is a free tool built and supported by the open-source community. Curated by Provectus, it will remain free and open-source, without any paid features or subscription plans to be added in the future. Looking for the help of Kafka experts? Provectus can help you design, build, deploy, and manage Apache Kafka clusters and streaming applications. Discover Professional Services for Apache Kafka, to unlock the full potential of Kafka in your enterprise!

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.

Interface

Features

The Interface

UI for Apache Kafka wraps major functions of Apache Kafka with an intuitive user interface.

Interface

Topics

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.

Create Topic

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 settings.

Connector_Topic_Consumer

Messages

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.

Produce Message

Schema registry

There are 3 supported types of schemas: Avro®, JSON Schema, and Protobuf schemas.

Create Schema Registry

Before producing avro/protobuf encoded messages, you have to add a schema for the topic in Schema Registry. Now all these steps are easy to do with a few clicks in a user-friendly interface.

Avro Schema Topic

Getting Started

To run UI for Apache Kafka, you can use either a pre-built Docker image or build it (or a jar file) yourself.

Quick start (Demo run)

docker run -it -p 8080:8080 -e DYNAMIC_CONFIG_ENABLED=true provectuslabs/kafka-ui

Then access the web UI at http://localhost:8080

The command is sufficient to try things out. When you're done trying things out, you can proceed with a persistent installation

Persistent installation

services:
  kafka-ui:
    container_name: kafka-ui
    image: provectuslabs/kafka-ui:latest
    ports:
      - 8080:8080
    environment:
      DYNAMIC_CONFIG_ENABLED: 'true'
    volumes:
      - ~/kui/config.yml:/etc/kafkaui/dynamic_config.yaml

Please refer to our configuration page to proceed with further app configuration.

Web UI Cluster Configuration Wizard

Configuration file explanation

Docker Compose examples

Misc configuration properties

Helm charts

Quick start

Building from sources

Quick start with building

Liveliness and readiness probes

Liveliness and readiness endpoint is at /actuator/health.
Info endpoint (build info) is located at /actuator/info.

Configuration options

All of the environment variables/config properties could be found here.

Contributing

Please refer to contributing guide, we'll guide you from there.

kafka-ui (provectus/kafka-ui)

Searching Database…

12.3K ·GitHub
What is this?A free, open-source web UI for monitoring and managing Apache Kafka clusters — a lightweight dashboard that makes your data flows observable and helps find and troubleshoot issues faster. Built by developers, for developers.
Is it a hosted service I sign up for, or something I run myself?Something you run yourself: it's a web application you deploy locally or in the cloud with a couple of commands, then manage your Kafka clusters from a browser.
How do I get it running?Use the pre-built Docker image for a quick demo run, or build it (or a jar) from sources yourself. For a persistent installation there's a configuration page, plus Docker Compose examples and Helm charts.
Do I need Kafka clusters already running, or does it set them up for me?You connect it to your existing clusters — it's a monitoring and management layer on top of Kafka, not a Kafka distribution itself. Several clusters can be handled from one place.
Can I produce Avro or Protobuf messages right away?Not until a schema is registered: before producing Avro or Protobuf encoded messages you have to add a schema for the topic in Schema Registry first. Avro, JSON Schema, and Protobuf schema types are supported.
Can I lock it down, or is it open to anyone who has the URL?You can secure it: optional OAuth 2.0 sign-in via GitHub, GitLab or Google, role-based access control with granular permissions, and data masking that obfuscates sensitive data in topic messages.
Is any of this going to end up behind a paywall?No — it's Apache-2.0 licensed, and the maintainers promise it will remain free and open-source with no paid features or subscription plans ever being added. Provectus sells separate Kafka professional services around it.
What can I actually do with topics and messages from the UI?Create topics with a few clicks and dynamic configuration, browse messages encoded as JSON, plain text or Avro, inspect per-partition consumer group lag, and jump back and forth between connectors, topics and consumers while navigating.
What does the metrics dashboard track?Key Kafka metrics — brokers, topics, partitions, production and consumption — in a lightweight dashboard meant to keep clusters observable and speed up troubleshooting.
My messages use a custom format — is that supported?Yes, through custom serialization/deserialization plugins: there are ready-to-go serdes like AWS Glue and Smile, or you can code your own.
Is there a Kubernetes-friendly way to deploy it?Yes — the project ships Helm charts alongside Docker Compose examples, and exposes liveness/readiness probes at /actuator/health for orchestrators.
What are similar projects?debezium, kafka, CMAK, emqx, rocketmq, doris, automq, zipkin
Creator
provectus
Size
29.7 MB
Stars
12.3K
Age
6y
Commits · 90 Days