Install the Splunk Add-on for JMX
- Get the Splunk Add-on for JMX by downloading it from Splunkbase or browsing to it using the app browser within Splunk Web.
- Determine where and how to install this add-on in your deployment, using the following tables on this page.
- Perform any prerequisite steps before installing, if required and specified in the following tables.
- Complete your installation.
If you need step-by-step instructions on how to install an add-on in your specific deployment environment, see the installation walkthroughs for links to installation instructions specific to a single-instance deployment, distributed deployment, Splunk Cloud, or Splunk Light.
Use the following tables to determine where and how to install this add-on in a distributed deployment of Splunk Enterprise or any deployment for which you are using forwarders to get your data in. Depending on your environment, your preferences, and the requirements of the add-on, you may need to install the add-on in multiple places.
While it is possible to use the add-on to poll remote JMX management servers, Splunk recommends installing this add-on on a heavy forwarder that is installed on the same host as the central JMX server. This deployment configuration simplifies your configuration because you can call the port locally, you do not need to use certificates, and you can use the Java version that is local to the machine.
Where to install this add-on
This table provides a quick reference for installing this add-on to a distributed deployment of Splunk Enterprise.
|Splunk instance type||Supported||Required||Comments|
|Search Heads||Yes||Yes||Install this add-on to all search heads where JMX knowledge management is required.|
|Indexers||Yes||No||Not required, as the parsing operations occur on the heavy forwarders.|
|Heavy Forwarders||Yes||Yes||This add-on requires heavy forwarders to perform data collection.|
|Universal Forwarders||No||No||This add-on requires heavy or light forwarders.|
Distributed deployment feature compatibility
This table provides a quick reference for the compatibility of this add-on with Splunk distributed deployment features.
|Distributed deployment feature||Supported||Comments|
|Search Head Clusters||Yes||You can install this add-on on a search head cluster for all search-time functionality, but only configure inputs on forwarders to avoid duplicate data collection. |
Before installing this add-on to a cluster, make the following changes to the add-on package:
1. Remove the
|Indexer Clusters||Yes||Before installing this add-on to a cluster, make the following changes to the add-on package: |
1. Remove the
|Deployment Server||No||Supported for deploying unconfigured add-on only. Using a deployment server to deploy the configured add-on to multiple forwarders acting as data collectors causes duplication of data.|
The Splunk Add-Ons manual includes an Installing add-ons guide that helps you successfully install any Splunk-supported add-on to your Splunk platform.
For a walkthrough of the installation procedure, follow the link that matches your deployment scenario:
Installation and configuration overview for the Splunk Add-on for JMX
Upgrade the Splunk Add-on for JMX
This documentation applies to the following versions of Splunk® Supported Add-ons: released
Feedback submitted, thanks!