The Ultimate Kafka UI Tool.

Plugins

Introduction

Kafka Tool supports custom plugins written in Java. Plugins allow you to view messages that are not natively understood by Kafka Tool, in a format that you see fit. For example, one can write a decorator for Avro (or Thrift) messages that will show the actual contents of the Avro objects in a suitable format.

There is an example of how to write a plugin in the plugins/example folder in your Kafka Tool installation directory.

Developing

You need to create a class that implements the com.kafkatool.external.ICustomMessageDecorator interface. The interface is located in the 'src' directory of the provided example plugin and it has two methods that you need to implement

Compiling

You must compile your source code using Java 8 compatible compiler.

Packaging

You must put your own compiled classes and any dependencies you might have (e.g. Avro libraries) into a SINGLE jar. Do not include any jars that are already in the 'lib' directory of Kafka Tool, especially any Apache Kafka jars.

Usage

Once you have compiled and packaged your jar, copy it to the 'plugins' folder in the Kafka Tool installation folder. Restart Kafka Tool and navigate to the topic that you want to use the decorator with. In the 'Content Types' drop-downs you should see the name of your decorator. Select it and click on 'Update'. After that, the messages/keys will be decorated using your custom decorator.

Kafka Tool | UI Tool for Apache Kafka