icon/x Created with Sketch.

Splunk Cookie Policy

We use our own and third-party cookies to provide you with a great online experience. We also use these cookies to improve our products and services, support our marketing campaigns, and advertise to you on our website and other websites. Some cookies may continue to collect information after you have left our website. Learn more (including how to update your settings) here.
Accept Cookie Policy

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 MQTT Modular Input
SHA256 checksum (mqtt-modular-input_123.tgz) c403f92b3cac1c9b30670f646292e04d1b832c05297b0d30a6404d5f03c6e18d SHA256 checksum (mqtt-modular-input_122.tgz) 73fe1fd9a879fd399a45054d2e89b732cf33656270f35c44efa1f28e2f0d7345 SHA256 checksum (mqtt-modular-input_121.tgz) 83ca2a952c436cd84a8a07edf29865b172433a4ff1b135fca20f780eda508fa7 SHA256 checksum (mqtt-modular-input_12.tgz) 97e8cf37296264353beeb3a1d4b510ce3fcddc5d120b7297f563222b3b13b3c4 SHA256 checksum (mqtt-modular-input_11.tgz) fd8463ca8327232d5efa3288e5003ecb4bb9a96906b16bc317e6600a6ebb432c SHA256 checksum (mqtt-modular-input_10.tgz) a0bad558565dadaaa25bbaa10959b17d8666af956e2956a25711712801a7a8cd SHA256 checksum (mqtt-modular-input_091.tgz) 3036df47b5a51437d398f04af65a92f87825aa9eb1fafa8a56350236a28dc749 SHA256 checksum (mqtt-modular-input_09.tgz) f033a2c18e72a424e5321b7ffe437a2ac83a965af18487249254792e01de37cd SHA256 checksum (mqtt-modular-input_08.tgz) c2d816e5972b6f1e1ba125486461a2f6a3a7b64e0019a9087005f044c258f7c1 SHA256 checksum (mqtt-modular-input_06.tgz) 140efaa66ef5de5b9ab046cdc4d55102dbb9ba2f6c12654be1cc54fb82244843 SHA256 checksum (mqtt-modular-input_05.tgz) 32fc755c76880366bb8d17a41d1b1317913bddf651c9ff7c28ddbabe0ee2d1e9
To install your download
For instructions specific to your download, click the Details tab after closing this window.

Flag As Inappropriate

MQTT Modular Input

This is a Splunk Modular Input Add-On for indexing messages from a MQTT Broker.

Splunk MQTT Modular Input v1.2.3


This is a Splunk Modular Input Add-On for indexing messages from a MQTT Broker.

What is MQTT ?



This Modular Input utilizes the PAHO Java client library version 0.4.0 , http://www.eclipse.org/paho/


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


  • 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
  • If you are using a Splunk UI Browse to Settings -- Data Inputs -- MQTT to add a new Input stanza via the UI
  • If you are not using a Splunk UI (ie: you are running on a Universal Forwarder) , you need to add a stanza to inputs.conf directly as per the specification in README/inputs.conf.spec. The inputs.conf file should be placed in a local directory under an App or User context.

Activation Key

You require an activation key to use this App. Visit http://www.baboonbones.com/#activation to obtain a non-expiring key


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

These are also searchable in Splunk : index=_internal error mqtt.py

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/mqtt_ta/bin/mqtt.py 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 MQTT messages is enitrely pluggable with custom implementations should you wish.

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

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

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

Code examples are on GitHub : https://github.com/damiendallimore/SplunkModularInputsJavaFramework/tree/master/mqtt/src/com/splunk/modinput/mqtt


  • 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 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/mqtt_ta/bin/mqtt.py --scheme"


This project was initiated by Damien Dallimore , damien@baboonbones.com

Release Notes

Version 1.2.3
May 10, 2019

cosmetic fixes

Version 1.2.2
April 23, 2019

updated docs

Version 1.2.1
April 19, 2019

added trial key functionality

Version 1.2
March 28, 2019

docs updated

Version 1.1
June 3, 2018

minor manager xml ui tweak for 7.1

Version 1.0
May 27, 2018

Added an activation key requirement , visit http://www.baboonbones.com/#activation to obtain a free,non-expiring key
Docs updated
Splunk 7.1 compatible

Version 0.9.1
Nov. 26, 2015

Fixed subscription loop

Version 0.9
Nov. 24, 2015

Minor HEC data handling tweaks

Version 0.8
Sept. 22, 2015

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

Version 0.6
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/mqtt.py

Version 0.5
Oct. 22, 2014

Initial Beta Release


Subscribe Share

AppInspect Tooling

Splunk AppInspect evaluates Splunk apps against a set of Splunk-defined criteria to assess the validity and security of an app package and components.

Are you a developer?

As a Splunkbase app developer, you will have access to all Splunk development resources and receive a 10GB 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-2019 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.