Repository files navigation

Utilities for working with Kafka

Utilities for working with Kafka Streams applications. This library provides:

• TopologyInformation to parse Kafka StreamsTopologyDescription and extract sinks and sources
• Helpers to automatically configure Serdes for Kafka Streams applications

They are mainly used instreams-bootstrap andfluent-kafka-streams-tests, but you are free to use them in your own projects if needed.

You can add kafka-streams-utils via Maven Central.

implementationgroup:'com.bakdata.kafka',name:'kafka-streams-utils',version:'1.0.0'

<dependency>    <groupId>com.bakdata.kafka</groupId>    <artifactId>kafka-streams-utils</artifactId>    <version>1.0.1</version></dependency>

For other build tools or versions, refer tothelatest version in MvnRepository.

BOM is short for Bill of Materials.It is a Maven feature that allows you to manage the versions of dependencies in a single place.This project provides a BOM for Kafka dependencies, i.e., Kafka core dependencies in grouporg.apache.kafka as well as Confluent dependencies in groupio.confluent.

You can add kafka-bom via Maven Central.

implementation(platform('com.bakdata.kafka:kafka-bom:1.0.0'))

<dependencyManagement>    <dependencies>        <dependency>            <groupId>com.bakdata.kafka</groupId>            <artifactId>kafka-bom</artifactId>            <version>1.0.1</version>            <type>pom</type>            <scope>import</scope>        </dependency>    </dependencies></dependencyManagement>

For other build tools or versions, refer tothelatest version in MvnRepository.

After adding the BOM to your project, you can use the provided dependencies without specifying a version.

implementationgroup:'org.apache.kafka'name:'kafka-streams'implementationgroup:'io.confluent'name:'kafka-streams-avro-serde'

<dependencies>    <dependency>        <groupId>org.apache.kafka</groupId>        <artifactId>kafka-streams</artifactId>    </dependency>    <dependency>        <groupId>io.confluent</groupId>        <artifactId>kafka-streams-avro-serde</artifactId>    </dependency></dependencies>

If you want to contribute to this project, you can simply clone the repository and build it via Gradle.All dependencies should be included in the Gradle files, there are no external prerequisites.

> git clone git@github.com:bakdata/kafka-utils.git>cd kafka-utils&& ./gradlew build

Please note, that we havecode styles for Java.They are basically the Google style guide, with some small modifications.

We are happy if you want to contribute to this project.If you find any bugs or have suggestions for improvements, please open an issue.We are also happy to accept your PRs.Just open an issue beforehand and let us know what you want to do and why.

This project is licensed under the MIT license.Have a look at theLICENSE for more details.