https://github.com/hivemq/hivemq-kafka-hello-world-customization

An example customization project for the HiveMQ Enterprise Extension for Kafka using the HiveMQ Kafka Extension Customization SDK.
https://github.com/hivemq/hivemq-kafka-hello-world-customization

customization demonstration hello-world hivemq kafka kafka-extension kafka-extension-customization mqtt

Last synced: 3 months ago
JSON representation

An example customization project for the HiveMQ Enterprise Extension for Kafka using the HiveMQ Kafka Extension Customization SDK.

• Host: GitHub
• URL: https://github.com/hivemq/hivemq-kafka-hello-world-customization
• Owner: hivemq
• License: apache-2.0
• Created: 2020-08-10T14:42:12.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-10-16T13:54:37.000Z (3 months ago)
• Last Synced: 2024-10-18T13:53:56.221Z (3 months ago)
• Topics: customization, demonstration, hello-world, hivemq, kafka, kafka-extension, kafka-extension-customization, mqtt
• Language: Java
• Homepage: https://www.hivemq.com
• Size: 282 KB
• Stars: 7
• Watchers: 17
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.adoc
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
:hivemq-link: https://www.hivemq.com

:hivemq-kafka-docs: {hivemq-link}/docs/kafka/latest/enterprise-extension-for-kafka/kafka.html

:hivemq-kafka-customization-docs: {hivemq-link}/docs/kafka/latest/enterprise-extension-for-kafka/kafka-customization.html

:hivemq-blog-tools: {hivemq-link}/mqtt-toolbox/

:hivemq-support: https://community.hivemq.com/c/hivemq-extension-sdk/kafka-customization/14

= HiveMQ Kafka Extension Hello World Customization

image:https://img.shields.io/badge/Customization_Type-Demonstration-orange?style=for-the-badge[Extension Type]

image:https://img.shields.io/github/v/release/hivemq/hivemq-kafka-hello-world-customization?style=for-the-badge[GitHub release (latest by date),link=https://github.com/hivemq/hivemq-kafka-hello-world-customization/releases/latest]

image:https://img.shields.io/github/license/hivemq/hivemq-kafka-hello-world-customization?style=for-the-badge&color=brightgreen[GitHub,link=LICENSE]

== Purpose

This Hello World customization uses a Mqtt-to-Kafka transformer which forwards MQTT PUBLISHES to a Kafka cluster.

It maps the MQTT topic structure to a matching Kafka topic structure and preserves MQTT 5 user properties as Kafka record headers.

We strongly recommend reading the {hivemq-kafka-docs}[HiveMQ Enterprise Extension for Kafka Documentation]

to grasp the core concepts of HiveMQ Kafka customization development.

== Installation

. Clone this repository into a Java 11 gradle project.

. Run `./gradlew jar` task from gradle to build the customization.

. Move the file: "build/libs/hivemq-kafka-hello-world-customization-4.34.0.jar" to the directory: "HIVEMQ_HOME/extensions/hivemq-kafka-extension/customizations"

. Copy the resources/kafka-configuration.xml to "HIVEMQ_HOME/extensions/hivemq-kafka-extension" and adapt it to your environment.

. Delete the "HIVEMQ_HOME/extensions/hivemq-kafka-extension/DISABLED" file.

. Start HiveMQ.

== First Steps

=== Manual Testing

Connect with an {hivemq-blog-tools}[MQTT client] of your choice.

Publish a MQTT message to the topic _transform/customization_.

Monitor your Kafka cluster for a record from topic _transform.customization_.

== Next Steps

Awesome, you got your first HiveMQ Kafka customization working.

Now read the {hivemq-kafka-customization-docs}[HiveMQ Kafka Extension Customization Documentation] to see what customizations can do.

== Need Help?

If you encounter any problems, we are happy to help.

The best place to get in contact is our {hivemq-support}[community forum].

== License

HiveMQ Kafka Extension Hello World Customization is licensed under the `APACHE LICENSE, VERSION 2.0`.

A copy of the license can be found link:LICENSE[here].