Skip to content

Configure JMX inputs for the Splunk Add-on for JBoss

The Splunk Add-on for JBoss relies on the Splunk Add-on for JMX to collect performance metrics for local or remote JBoss servers using MBean attributes. The Splunk Add-on for JBoss provides a jmx_templates.conf that the Splunk Add-on for JMX can invoke.

If you do not want to collect performance metrics for the JBoss server and only want to collect local logs or thread information from JMX MBean operations, you do not need to perform this configuration.

Prerequisite: You msust install Java Runtime 1.7 or later on the same machine as the Splunk Add-on for JMX. You also need to create a Management User or Application User to establish the JMX connection to the JBoss server. See Enable remote management through JMX for information.

  1. Install the latest version of the Splunk Add-on for JMX on the Splunk Enterprise instance responsible for JMX data collection, usually a heavy forwarder. This add-on can collect JMX metrics locally or remotely.

  2. Copy the following JBoss .jar files to the Splunk Add-on for JMX bin/lib folder:

  • jboss-cli-client.jar
  • jbossws-api-1.0.1.Final.jar

  • jbossws-common-2.1.0.Final.jar

    Note

    If you are using version 3.1.0 of the Splunk Add-on for JMX you do not need to copy these .jar files as the files are already included.

    a. Go to your JBoss installation directory and navigate to $JBOSS_HOME/bin/client/jboss-cli-client.jar.

    b. Copy the jboss-cli-client.jar file to $SPLUNK_HOME/etc/apps/Splunk_TA_jmx/bin/lib.

    c. Download the jbossws-api-1.0.1.Final.jar and jbossws-common-2.1.0.Final.jar files from the MVN repository at http://mvnrepository.com/artifact/org.jboss.ws/jbossws-api/1.0.1.Final and http://mvnrepository.com/artifact/org.jboss.ws/jbossws-common/2.1.0.Final, respectively.

    d. Copy the jbossws-api-1.0.1.Final.jar and jbossws-common-2.1.0.Final.jar files to $SPLUNK_HOME/etc/apps/Splunk_TA_jmx/bin/lib.

  1. After copying, verify the files successfully copied to your $SPLUNK_HOME/etc/apps/Splunk_TA_jmx/bin/lib directory before continuing.

  2. Restart the add-on.

  3. Go to Splunk Web and access the configuration pages for the Splunk Add-on for JMX, either by clicking Splunk Add-on for JMX in the left nav, or going to Apps > Manage Apps, then clicking Launch app in the row for Splunk Add-on for JMX.

  4. Click Add to add a new JMX server.

  5. Enter a Name and an optional JVM Description for your JBoss server.

  6. For Connection Type, select one of the following from the dropdown menu:

    • Use URL directly - Example:

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

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

    The JBoss server can be local (installed on the same server as the Splunk Add-on for JMX) or remote.

    • Customized script

    The JBoss server must be installed on the same server as the Splunk Add-on for JMX.

    • Process id

    The JBoss server must be installed on the same server as the Splunk Add-on for JMX.

    • Process file

    The JBoss server must be installed on the same server as the Splunk Add-on for JMX.

  7. Click Add.

  8. Navigate to the input configurations by clicking Configurations > Inputs.

  9. Click Create New Input to create a new JMX input.

  10. Enter a Name and optional Description for your input, then select the server that you just configured in the Servers tab.

  11. On the Templates tab, select one or more of the predefined templates for JBoss to collect the data that you want.

  12. Enter jboss:jmx in the Source Type text box.

  13. Click Add to enable your JMX input.

  14. Validate that data is coming in by searching for:

    Search

    sourcetype=jboss:jmx

For more information about configuring JMX inputs, refer to Configure the inputs for the Splunk Add-on for JMX in the Splunk Add-on for Java Management Extensions manual.