Accept License Agreements

This app is provided by a third party and your right to use the app is in accordance with the license provided by that third-party licensor. Splunk is not responsible for any third-party apps and does not provide any warranty or support. If you have any questions, complaints or claims with respect to this app, please contact the licensor directly.

Thank You

Downloading Kafka Messaging Modular Input
MD5 checksum (kafka-messaging-modular-input_10.tgz) ff152ae895f7504ca36db8e26bedcd4f MD5 checksum (kafka-messaging-modular-input_092.tgz) 9d4c417c0b2645677ab154f2c2bee77d MD5 checksum (kafka-messaging-modular-input_091.tgz) c47fc34e217c32599dd03ddefd6312f1 MD5 checksum (kafka-messaging-modular-input_09.tgz) 25a92c7b664906e77c9304ffa016f4d5 MD5 checksum (kafka-messaging-modular-input_081.tgz) 7200a86366dbafddb471ac27d29011cb MD5 checksum (kafka-messaging-modular-input_08.tgz) b9c1e4a4c51105436a8a7bfdf4e7108a MD5 checksum (kafka-messaging-modular-input_07.tgz) b9027f5716bac835a5d574c43467f949 MD5 checksum (kafka-messaging-modular-input_06.tgz) 944bd7361915a68b84dcf151886f7f42 MD5 checksum (kafka-messaging-modular-input_05.tgz) 599d7edfa32cc3a65e59faa66d76352e
To install your download
For instructions specific to your download, click the Details tab after closing this window.

Flag As Inappropriate

Kafka Messaging Modular Input

This is a Splunk Modular Input Add-On for indexing messages from an Apache Kafka broker or cluster of brokers that are managed by Zookeeper.
Kafka version is used for the consumer and the testing of this Modular Input.

Splunk Kafka Messaging Modular Input v1.0


This is a Splunk Modular Input Add-On for indexing messages from a Kafka broker or cluster of brokers that are managed by Zookeeper.
Kafka version is used for the consumer and the testing of this Modular Input.

What is Kafka ?


  • Splunk 5.0+
  • Java Runtime 1.7+
  • Supported on Windows, Linux, MacOS, Solaris, FreeBSD, HP-UX, AIX
  • Kafka version 0.8 +


  • Optionally set your JAVA_HOME environment variable to the root directory of your JRE installation.If you don't set this , the input will look for a default installed java executable on the path.
  • Untar the release to your $SPLUNK_HOME/etc/apps directory
  • Restart Splunk


As this is a Modular Input , you can then configure your Kafka inputs via Manager->Data Inputs->Kafka. The field entry should be straightforward and intuitive for anyone with basic experience with Kafka / Zookeeper.


Any log entries/errors will get written to $SPLUNK_HOME/var/log/splunk/splunkd.log

JVM Heap Size

The default heap maximum is 64MB.
If you require a larger heap, then you can alter this in $SPLUNK_HOME/etc/apps/kafka_ta/bin/ on line 95

JVM System Properties

You can declare custom JVM System Properties when setting up new input stanzas.
Note : these JVM System Properties will apply to the entire JVM context and all stanzas you have setup

Customized Message Handling

The way in which the Modular Input processes the received Kafka messages is enitrely pluggable with custom implementations should you wish.

To do this you code an implementation of the com.splunk.modinput.kafka.AbstractMessageHandler class and jar it up.

Ensure that the necessary jars are in the $SPLUNK_HOME/etc/apps/kafka_ta/bin/lib directory.

If you don't need a custom handler then the default handler com.splunk.modinput.kafka.DefaultMessageHandler will be used.

This handler simply trys to convert the received byte array into a textual string for indexing in Splunk.

Code examples are on GitHub :


  • JAVA_HOME environment variable is set or "java" is on the PATH for the user's environment you are running Splunk as
  • You are using Splunk 5+
  • You are using a 1.7+ Java Runtime
  • You are targetting Kafka version 0.8+
  • You are running on a supported operating system
  • Look for any errors in $SPLUNK_HOME/var/log/splunk/splunkd.log
  • Run this command as the same user that you are running Splunk as and observe console output : "$SPLUNK_HOME/bin/splunk cmd python ../etc/apps/kafka_ta/bin/ --scheme"


This project was initiated by Damien Dallimore ,

Release Notes

Version 1.0
April 21, 2016

Added a new custom handler : com.splunk.modinput.kafka.CSVWithHeaderDecoderHandler
This allows you to roll out CSV files (with or without header) into KV or JSON before indexing.

Example config you could pass to the custom message handler when you declare it


Version 0.9.2
Nov. 3, 2015

Better JSON handling for HEC output (hat tip to Tivo)

Version 0.9.1
Oct. 22, 2015

Better logging around HEC success/failure
Can now add custom timestamp into HEC payload
New custom handler (JSONBodyWithTimeExtraction) for pulling out timestamp from JSON messages from Kafka and adding this into HEC payload

Version 0.9
Sept. 22, 2015

Added support to optional output to Splunk via a HEC (HTTP Event Collector) endpoint

Version 0.8.1
June 20, 2015

Added support for raw connection string format so that multiple zookeeper hosts
can be provided in a comma delimited manner
ie: hostname1:port1,hostname2:port2,hostname3:port3/chroot/path

Version 0.8
June 17, 2015

Added chroot support for zookeeper connection strings

Version 0.7
Feb. 11, 2015

Enabled TLS1.2 support by default.
Made the core Modular Input Framework compatible with latest Splunk Java SDK
Please use a Java Runtime version 7+
If you need to use SSLv3 , you can turn this on in bin/

Version 0.6
Feb. 5, 2015

You can now pass a charset name to the DefaultHandler

Version 0.5
June 30, 2014

Initial beta release


Subscribe Share

Splunk Certification Program

Splunk's App Certification program uses a specific set of criteria to evaluate the level of quality, usability and security your app offers to its users. In addition, we evaluate the documentation and support you offer to your app's users.

Are you a developer?

As a Splunkbase app developer, you will have access to all Splunk development resources and receive a 50GB license to build an app that will help solve use cases for customers all over the world. Splunkbase has 1000+ apps and add-ons from Splunk, our partners and our community. Find an app or add-on for most any data source and user need, or simply create your own with help from our developer portal.

Follow Us:
© 2005-2017 Splunk Inc. All rights reserved.
Splunk®, Splunk>®, Listen to Your Data®, The Engine for Machine Data®, Hunk®, Splunk Cloud™, Splunk Light™, SPL™ and Splunk MINT™ are trademarks and registered trademarks of Splunk Inc. in the United States and other countries. All other brand names, product names, or trademarks belong to their respective owners.