kafka-topics
Browse Kafka topics and understand what's happening on your cluster. Find topics / view topic metadata / browse topic data (kafka messages) / view topic configuration / download data. This is a web tool for the confluentinc/kafka-rest proxy.
Live Demo
kafka-topics-ui.demo.lenses.io
Running it
docker pull landoop/kafka-topics-ui
docker run --rm -it -p 8000:8000 \
-e "KAFKA_REST_PROXY_URL=https://kafka-rest-proxy-host:port" \
-e "PROXY=true" \
landoop/kafka-topics-ui
Config: If you don't use our docker image, keep in mind that Kafka-REST-Proxy
CORS support can be a bit buggy, so if you have trouble setting it up, you may need
to provide CORS headers through a proxy (i.e. nginx).
Note: The schema-registry is optional and topics are attempted to be read using Avro, then fall back to JSON, and finally fall back to Binary.
Build from source
git clone https://github.com/lensesio/kafka-topics-ui.git
cd kafka-topics-ui
npm install -g bower
npm install -g http-server
npm install
bower install
http-server -p 8080 .
Web UI will be available at http://localhost:8080
Nginx config
If you use nginx
to serve this ui, let angular manage routing with
location / {
add_header 'Access-Control-Allow-Origin' "$http_origin" always;
add_header 'Access-Control-Allow-Credentials' 'true' always;
add_header 'Access-Control-Allow-Methods' 'GET, POST, PUT, DELETE, OPTIONS' always;
add_header 'Access-Control-Allow-Headers' 'Accept,Authorization,Cache-Control,Content-Type,DNT,If-Modified-Since,Keep-Alive,Origin,User-Agent,X-Mx-ReqToken,X-Requested-With' always;
proxy_pass https://kafka-rest-server-url:8082;
proxy_redirect off;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header Host $http_host;
}
Setup Kafka Rest clusters
Use multiple Kafka Rest clusters in env.js
:
var clusters = [
{
NAME: "prod",
KAFKA_REST: "https://kafka-rest-ip:8082",
MAX_BYTES: "50000",
RECORD_POLL_TIMEOUT: "5000",
DEBUG_LOGS_ENABLED: true,
LAZY_LOAD_TOPIC_META: false
},
{
NAME: "dev",
KAFKA_REST: "localhost",
MAX_BYTES: "50000",
COLOR: "#141414", // Optional
RECORD_POLL_TIMEOUT: "5000",
DEBUG_LOGS_ENABLED: true,
LAZY_LOAD_TOPIC_META: false
}
];
Alternatively, you can pass multiple proxies within KAFKA_REST_PROXY_URL
env. variable by separating them with a comma.
KAFKA_REST_PROXY_URL="http://kafka-rest-ip:8082,http://other-kafka-rest-ip:8082"
Config
- Use
MAX_BYTES
to set the default maximum amount of bytes to fetch from each topic. - Use
RECORD_POLL_TIMEOUT
to set the timeout in ms. - Use
COLOR
to set different header colors for each set up cluster. - Set
DEBUG_LOGS_ENABLED
to true to enable the debug logs. - Set
LAZY_LOAD_TOPIC_META
to true to lazy load topic meta information.
CP Version support
Latest release is for CP 3.2.0 and above.
For versions older than CP 3.2.0 you will need kafka topics ui version 0.8.3. You can also build it from source by running:
git clone https://github.com/lensesio/kafka-topics-ui.git
cd kafka-topics-ui
git checkout tags/v0.8.3 -b v0.8.3
npm install -g bower
npm install
http-server .
Important: For Kafka REST Proxy 3.2.x you should set
consumer.request.timeout.ms=30000
. Without this option, Kafka REST Proxy will
fail to return messages for large topics. Although the default value is 1000
,
a bug in the Kafka REST code prevents you from manually setting (depending on
some other consumer options) a value lower than 30000
.
Changelog
Common Issues
If having "CONNECTIVITY ERROR" problems
make sure the file kafka-rest.properties
has CORS enabled.
To enable CORS add the following configuration to that file, and restart the backend Kafka-Rest
access.control.allow.methods=GET,POST,PUT,DELETE,OPTIONS
access.control.allow.origin=*
If using a recent version of the Kafka-Topics-UI and Kafka-REST, make sure that you have properly configured Kafka-REST with the new consumer API. That requires setting up in the configuration of Kafka REST
bootstrap.servers=PLAINTEXT://ip-address-of-kafka-broker:9092
Make sure you restart Kafka REST after changing it's configuration files
License
The project is licensed under the BSL license.
Relevant Projects
- schema-registry-ui, View, create, evolve and manage your Avro Schemas for multiple Kafka clusters
- kafka-connect-ui, Set up and manage connectors for multiple connect clusters
- fast-data-dev, Docker for Kafka developers (schema-registry,kafka-rest,zoo,brokers,landoop)
- Landoop-On-Cloudera, Install and manage your kafka streaming-platform on your Cloudera CDH cluster