Splunk® Supported Add-ons

Splunk Add-on for Java Management Extensions

Acrobat logo Download manual as PDF


Acrobat logo Download topic as PDF

Configure inputs for the Splunk Add-on for JMX using .conf files

You can configure inputs manually by configuring jmx_tasks.conf file.

Create a stanza in jmx_tasks.conf

  1. In your Splunk platform instance, navigate to $SPLUNK_HOME/etc/apps/Splunk_TA_jmx/local.
  2. Create a jmx_tasks.conf file, if it does not already exist.
  3. Open the jmx_tasks.conf file in a text editor.
  4. In a text editor, edit the jmx_tasks.conf file to create a task. See the following example:
    [test_task]
    description = Test Task
    destinationapp = Splunk_TA_jmx
    index = default
    interval = 60
    servers = Splunk_TA_jmx:server1 | Splunk_TA_jmx:server2
    sourcetype = jmx
    templates = Splunk_TA_jmx:test | Splunk_TA_ibm-was:WebSphere_AB_AlarmManager_Attributes
    
  5. This input is enabled by default. In order to disable it, add a disabled = 1 line to the bottom of the stanza.

  6. Adjust or add other arguments as needed. See the guidelines in the following table for reference:
    Argument Description
    description The description for the configured stanza. It may contain any free-form string and is provided for the convenience and readability of the user.
    destinationapp The name of the app where this stanza is configured. Keep its value as Splunk_TA_jmx.
    index The index to use for events collected through this add-on. Add this argument to specify a non-default index. The default index is main.
    interval How long Splunk Enterprise waits before collecting data again, in seconds. Note that an interval configured at the server level overrides this input-level configuration for that specific server.
    servers Enter the name of the servers from which the data should be collected in the format <destinationapp>:<server_name>, where destinationapp is the Destination App parameter and server_name is the Name parameter of the configured server. As shown in the sample above, multiple servers should be separated by pipe symbol. Note: If the Connection Type parameter of the server is IBMsoap, only a single server should be entered per stanza as separate property files (soap.client.props and ssl.client.props) are required to make connection to a single IBM WAS server. Multiple inputs will have to be configured to collect data from multiple servers.
    sourcetype The source type to use for events collected through this add-on. The default is jmx.
    templates Enter the name of the templates to define the Mbeans from which the data should be collected in the format <destinationapp>:<template_name>, where destinationapp is the Destination App parameter and template_name is the Name parameter of the configured template. As shown in the sample above, multiple templates should be separated by pipe symbol.

    The name for every stanza must be unique.

  7. Save your changes.
  8. Once the stanza is configured with accurate information, a corresponding stanza is created in inputs.conf, along with the configuration XML file, and the modular input will start to collect data.

Enable or disable storing configuration in another add-on

By default, this add-on is configured to store configuration in another add-on. To disable this feature—which hides the Destination App selection box on the input, servers and template pages in Splunk Web—complete this step:

  • In your local splunk_ta_jmx_settings.conf file, set the display_destination_app setting to 0.
Last modified on 18 December, 2021
PREVIOUS
Configure inputs for the Splunk Add-on for JMX in Splunk Web
  NEXT
MBean configuration XML reference

This documentation applies to the following versions of Splunk® Supported Add-ons: released, 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