Splunk MQTT Modular Input v1.3

Overview

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

What is MQTT ?

http://en.wikipedia.org/wiki/MQTT

Implementation

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

Dependencies

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

Setup

• 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

Logging

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 $SPLUNKHOME/etc/apps/mqttta/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 $SPLUNKHOME/etc/apps/mqttta/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

Troubleshooting

• 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 : "$SPLUNKHOME/bin/splunk cmd python ../etc/apps/mqttta/bin/mqtt.py --scheme"

Support

BaboonBones.com offer commercial support for implementing and any questions pertaining to this App.