Splunk® Supported Add-ons

Splunk Add-on for JBoss

Download manual as PDF

Download topic as PDF

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: Java Runtime 1.7 or later must be installed 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.

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

4. Restart the add-on.

5. 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.

6. Click Add Server to add a new JMX server.

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

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

  • Use URL directly - Example: service:jmx:rmi:///jndi/rmi://127.0.0.1:8888/jmxrmi
    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.

9. Click Create.

10. Navigate to the task configurations by clicking Configurations > Tasks.

11. Click Add Task to create a new JMX task.

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

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

14. On the Settings tab, set the Source Type to jboss:jmx.

15. Click Create to enable your JMX input.

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

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.

Last modified on 18 March, 2020
PREVIOUS
Enable and Validate inputs for the Splunk Add-on for JBoss
  NEXT
Troubleshoot the Splunk Add-on for JBoss

This documentation applies to the following versions of Splunk® Supported Add-ons: released


Was this documentation topic helpful?

Enter your email address, and someone from the documentation team will respond to you:

Please provide your comments here. Ask a question or make a suggestion.

You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters