Hardware and software requirements for the Splunk Add-on for JBoss

Prerequisites

The Splunk Add-on for JBoss supports multiple data inputs, each capable of collecting different data from your JBoss application servers. For more information about which kind of data you can collect with which input, refer to the source types page.

The OpenJDK Java Runtime or Oracle Java Runtime is required in order to collect JBoss server thread information and JBoss server performance metrics through the Splunk Add-on for Java Management Extensions (JMX).

Collecting local log files

If you want to collect local JBoss log files, you must install a universal or heavy forwarder or single instance directly on the machine running your JBoss server, so it can access the logs locally.

Enable the logs you want to collect on the JBoss server.

For instructions on enabling the server log (server.log), see the JBoss documentation.

For instructions on enabling the garbage collection log (gc.log), see the JBoss documentation.

For instructions on enabling the access log (access.log), see the JBoss documentation.

Collecting thread information

The following is required if you would like to collect JBoss server thread information from MBean operations:

• Install Java Runtime 1.7 or later on the same machine as the Splunk Add-on for JBoss. Note: You need to use the OpenJDK Java Runtime or Oracle Java Runtime.
• Enable remote management through JMX on the JBoss servers for which you would like to collect thread information. This enables the Splunk Add-on for JBoss to make the JMX connection to the JBoss server. Follow the instructions in the Enable remote management through JMX section below.

Collecting performance metrics from MBean attributes

The following is required if you would like to collect JBoss server performance metrics from MBean attributes:

• Install the latest version of the Splunk Add-on for Java Management Extensions (JMX). See the Splunk Add-on for Java Management Extensions documentation for installation and configuration information.
• Install Java Runtime 1.7 or later on the same machine as the Splunk Add-on for JBoss. Note: You need to use the OpenJDK Java Runtime or Oracle Java Runtime.
• Enable remote management through JMX on the JBoss servers for which you would like to collect performance metrics. This enables the Splunk Add-on for JMX to make the JMX connection to the JBoss server. Follow the instructions in the following section.

Enable remote management through JMX

You need to create a Management User if you are running JBoss EAP in standalone server mode or create both a Management User and an Application User if you are running JBoss EAP in managed domain mode.

• To be able to authenticate with the remote host controller, create a Management User using the EAP_HOME/bin/add-user.sh script.

• If you are using the managed domain operating mode, in order to authenticate with the remote server, also create an Application User using the EAP_HOME/bin/add-user.sh script.

For standalone mode, run the following command:

EAP_HOME/bin/standalone.sh -Djboss.bind.address=ip -Djboss.bind.address.management=ip

For managed domain mode, run the following command:

EAP_HOME/bin/domain.sh -Djboss.bind.address=ip -Djboss.bind.address.management=ip. 

Note: Specify the IP address to enable remote access.

You should now be able connect to the remote instance using the Management User account. The connection string looks similar to this:

service:jmx:remoting-jmx://<IP_Address>:9999 (JBoss EAP 6.x server)

service:jmx:remote+http://<IP_Address>:9990 (JBoss EAP 7.x server)

For managed domain mode, edit the EAP_HOME/bin/domain.xml and uncomment the following line from the profile to enable it.

<remoting-connector use-management-endpoint="false"/>

This enables you to connect to the remote server using the Application User account.

For more information about JBoss EAP user management, see the JBoss documentation.

Splunk platform requirements

Because this add-on runs on the Splunk platform, all of the system requirements apply for the Splunk software that you use to run this add-on.

• For Splunk Enterprise system requirements: see System Requirements in the Splunk Enterprise Installation Manual.
• If you are managing on-premises forwarders to get data into Splunk Cloud, see System Requirements in the Splunk Enterprise Installation Manual, which includes information about forwarders.