Install the Splunk Add-on for JBoss

Use the tables below to determine where and how to install this add-on in a distributed deployment of Splunk Enterprise. See the installation walkthrough section at the bottom of this page for links to installation instructions specific to a single-instance deployment, distributed deployment, or Splunk Cloud.

Inputs for the Splunk Add-on for JBoss

There are three different inputs in this add-on. You can choose to use one or several of them. Keep these requirements in mind as you choose how to install the add-on in your environment.

• If you plan to gather logs from a local JBoss server (access.log, server.log and gc.log) which are collected via file monitoring, the heavy forwarder or single-instance Splunk Enterprise doing the data collection must be installed directly on the JBoss server.
• The modular input for thread information must be enabled on a heavy forwarder or single-instance Splunk Enterprise.
• The JMX input for performance data depends on the Splunk Add-on for JMX, which must be installed on a heavy forwarder or single-instance Splunk Enterprise.

Distributed installation of 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 JBoss knowledge management is required.
Indexers	Yes	Conditional	Not required if you use heavy forwarders to monitor JBoss log files directly on JBoss machines. Required if you use universal forwarders for monitor inputs.
Heavy Forwarders	Yes	Yes	This add-on requires heavy forwarders to perform data collection via JMX and modular inputs.
Universal Forwarders	Yes	No	Supported for monitor inputs only. You must also install this add-on on your indexers if you use a universal forwarder rather than a heavy forwarder to monitor JBoss log files.

Distributed deployment 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. If the eventgen.conf file is present in your installation package, remove it along with any files in the Samples folder. 2. If the inputs.conf file is present in your installation package, remove the file.
Indexer Clusters	Yes	Before installing this add-on to a cluster, make the following changes to the add-on package: 1. If the eventgen.conf file is present in your installation package, remove it along with any files in the Samples folder. 2. If the inputs.conf file is present in your installation package, remove the file.
Deployment Server	Yes	Note:. Using a deployment server to deploy the configured add-on to multiple forwarders acting as data collectors may cause duplication of data if multiple forwarders are collecting data from the same remote Jboss server. The add-on uses the credential vault to secure your credentials, and this credential management solution is incompatible with the deployment server. Make sure that the deployment server and forwarder uses the same credential vault. Alternatively, configure the add-on on the deployment server with Jboss credentials in plain text and after pushing the configured add-on to the forwarder, the credentials would be encrypted.

Installation walkthrough

See Installing add-ons in the Splunk Add-Ons documentation for detailed instructions describing how to install a Splunk add-on in the following deployment scenarios:

• single-instance Splunk Enterprise
• distributed Splunk Enterprise
• Splunk Cloud