Siddhi IO Kafka

The siddhi-io-kafka extension is an extension to Siddhi that receives and publishes events from and to Kafka.

For information on Siddhi and it's features refer Siddhi Documentation.

Download

• Versions 5.x and above with group id io.siddhi.extension.* from here.
• Versions 4.x and lower with group id org.wso2.extension.siddhi.* from here.

Latest API Docs

Latest API Docs is 5.0.18.

Features

• kafka (Sink)
  

  A Kafka sink publishes events processed by WSO2 SP to a topic with a partition for a Kafka cluster. The events can be published in the TEXT XML JSON or Binary format.
  If the topic is not already created in the Kafka cluster, the Kafka sink creates the default partition for the given topic. The publishing topic and partition can be a dynamic value taken from the Siddhi event.
  To configure a sink to use the Kafka transport, the type parameter should have kafka as its value.

• kafka-replay-request (Sink)
  

  This sink is used to request replay of specific range of events on a specified partition of a topic.

• kafkaMultiDC (Sink)
  

  A Kafka sink publishes events processed by WSO2 SP to a topic with a partition for a Kafka cluster. The events can be published in the TEXT XML JSON or Binary format.
  If the topic is not already created in the Kafka cluster, the Kafka sink creates the default partition for the given topic. The publishing topic and partition can be a dynamic value taken from the Siddhi event.
  To configure a sink to publish events via the Kafka transport, and using two Kafka brokers to publish events to the same topic, the type parameter must have kafkaMultiDC as its value.

• kafka (Source)
  

  A Kafka source receives events to be processed by WSO2 SP from a topic with a partition for a Kafka cluster. The events received can be in the TEXT XML JSON or Binary format.
  If the topic is not already created in the Kafka cluster, the Kafka sink creates the default partition for the given topic.

• kafka-replay-response (Source)
  

  This source is used to listen to replayed events requested from kafka-replay-request sink

• kafkaMultiDC (Source)
  

  The Kafka Multi-Datacenter(DC) source receives records from the same topic in brokers deployed in two different kafka clusters. It filters out all the duplicate messages and ensuresthat the events are received in the correct order using sequential numbering. It receives events in formats such as TEXT, XML JSON and Binary`.The Kafka Source creates the default partition '0' for a given topic, if the topic has not yet been created in the Kafka cluster.

Installation

For installing this extension in the Streaming Integrator Server, and to add the dependent jars, refer Streaming Integrator documentation section on downloading and installing siddhi extensions.\ For installing this extension in the Streaming Integrator Tooling, and to add the dependent jars, refer Streaming Integrator documentation section on installing siddhi extensions.

Dependencies

Following JARs will be converted to osgi and copied to WSO2SI_HOME/lib and WSO2SI_HOME/samples/sample-clients/lib which are in <KAFKA_HOME>/libs directory.

• kafka_2.11-*.jar
• kafka-clients-*.jar
• metrics-core-*.jar
• scala-library-2.11.*.jar
• scala-parser-combinators_2.11.*.jar (if exists)
• zkclient-*.jar
• zookeeper-*.jar

Setup Kafka

As a prerequisite, you have to start the Kafka message broker. Please follow better steps.

1. Download the Kafka distribution
2. Unzip the above distribution and go to the ‘bin’ directory
3. Start the zookeeper by executing below command,

   zookeeper-server-start.sh config/zookeeper.properties

4. Start the Kafka broker by executing below command,

   kafka-server-start.sh config/server.properties

Refer the Kafka documentation for more details, https://kafka.apache.org/quickstart

Support and Contribution

• We encourage users to ask questions and get support via StackOverflow, make sure to add the siddhi tag to the issue for better response.

• If you find any issues related to the extension please report them on the issue tracker.

• For production support and other contribution related information refer Siddhi Community documentation.