Splunk® Supported Add-ons

Splunk Add-on for Java Management Extensions

Acrobat logo Download manual as PDF


Acrobat logo Download topic as PDF

Connect the Splunk Add-on for Java Management Extensions to IBM Websphere Application Server

Configure the Splunk Add-on for Java Management Extensions (JMX) to connect to IBM Websphere Application Server.

Installation of the IBM Java Development Kit (JDK) or Java Runtime Environment (JRE), is required to collect JMX data from an IBM WebSphere application server. Put the JDK or JRE bin directory in the system path to make sure that the JMX data collection uses this IBM version of the Java runtime. See the IBM developer site to download the IBM JRE or JDK

  1. In your IBM WebSphere installation directory, navigate to $WAS_ROOT/WebSphere/AppServer/runtimes.
  2. Copy the following files:
    • com.ibm.ws.admin.client_*.jar
    • com.ibm.ws.ejb.thinclient_*.jar
    • com.ibm.ws.orb_*.jar
  3. Navigate to $SPLUNK_HOME/etc/apps/Splunk_TA_jmx/bin/lib in your Splunk platform instance.
  4. Paste the files in the $SPLUNK_HOME/etc/apps/Splunk_TA_jmx/bin/lib directory.
  5. After copying, verify the files successfully copied to your $SPLUNK_HOME/etc/apps/Splunk_TA_jmx/bin/lib directory before continuing. For example, if you run the following command:
     ls /opt/splunk/etc/apps/Splunk_TA_jmx/bin/lib/com.ibm*

    You should see something similar to the following result:

       /opt/splunk/etc/apps/Splunk_TA_jmx/bin/lib/com.ibm.ws.admin.client_8.5.0.jar
       /opt/splunk/etc/apps/Splunk_TA_jmx/bin/lib/com.ibm.ws.ejb.thinclient_8.5.0.jar
       /opt/splunk/etc/apps/Splunk_TA_jmx/bin/lib/com.ibm.ws.orb_8.5.0.jar
    
  6. Restart the Splunk platform.

Connect the Splunk Add-on for Java Management Extensions to IBM Websphere Application Server through SOAP protocol

Connect the Splunk Add-on for Java Management Extensions to IBM Websphere Application Server (WAS) using Simple Object Access Protocol (SOAP).

  1. As a prerequisite, perform the default configuration steps listed in the previous section of this topic before you configure the Splunk Add-on for Java Management Extensions to connect using the SOAP protocol.
  2. Navigate to $SPLUNK_HOME/etc/apps/Splunk_TA_jmx/local/config.
  3. Create a directory with a name that starts with any letter and consists only of underscores and alphanumeric characters. The same name must also be used when you configure your IBM WAS server. For example, <directory_name>.
  4. In your IBM WebSphere Application Server deployment, navigate to $WAS_ROOT/WebSphere/AppServer/profiles/<AppSrv>/properties
  5. Copy the following files:
    • ssl.client.props
    • soap.client.props
  6. Navigate to the $SPLUNK_HOME/etc/apps/Splunk_TA_jmx/local/config/<directory_name> directory created in Step 3.
  7. Paste the props files.
  8. In your IBM WebSphere Application Server deployment, navigate to $WAS_ROOT/WebSphere/AppServer/profiles/<AppSrv>/etc
  9. Copy the following files:
    • key.p12
    • trust.p12
  10. Navigate to the $SPLUNK_HOME/etc/apps/Splunk_TA_jmx/local/config/<directory_name> directory created in Step 3.
  11. Paste the files.
  12. In a text editor, open the ssl.client.props file and provide the correct path of your key.p12 and trust.p12 files:
    com.ibm.ssl.keyStore=$SPLUNK_HOME/etc/apps/Splunk_TA_jmx/local/config/<directory_name>/key.p12
    com.ibm.ssl.trustStore=$SPLUNK_HOME/etc/apps/Splunk_TA_jmx/local/config/<directory_name>/trust.p12
  13. Follow the steps in the Configure servers topic, and select the Connection Type as IBMsoap.
    • Data can directly be collected from the deployment manager of your IBM WAS Network deployment. If you use a deployment manager, data from each node of the deployment manager can be collected by entering the credentials of the deployment manager (DMGR) when configuring the server.
  14. Configure a task in the Splunk Add-on for Java Management Extensions. See the Configure inputs topic in this manual. Use the Predefined_IBM_WAS_Performance_Template template to collect performance data from your IBM WAS servers.

Connection to the IBM WAS using IBMsoap connection type is only supported when SSL and authentication is enabled on the IBM WebSphere Application Server. MBean notification listening is not supported for this configuration type, and any notificationListener element present in any Mbean will be ignored.

Enable PMI data collection on IBM WAS

  1. Open the IBM Websphere Application Server (WAS) Admin Web Console
  2. Navigate to IBM WAS Admin Console > Monitoring and Tuning > Performance Monitoring Infrastructure (PMI) > <ibm_server_name> and ensure that PMI data collection is enabled in IBM WAS.
  3. Save any changes.
Last modified on 20 December, 2021
 

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


Was this documentation topic helpful?

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