Splunk® Supported Add-ons

Splunk Add-on for Java Management Extensions

Acrobat logo Download manual as PDF


Acrobat logo Download topic as PDF

Release history for the Splunk Add-on for JMX

Latest version

The latest version of the Splunk Add-on for Java Management Extensions is version 5.2.1. See Release notes for the Splunk Add-on for JMX for the release notes of this latest version.

Version 5.2.1

Version 5.2.1 of the Splunk Add-on for Java Management Extensions was released on Dec 14, 2021.

Compatibility

Version 5.2.1 of the Splunk Add-on for Java Management Extensions is compatible with the following software, CIM versions, and platforms.

Splunk platform versions 8.0.x, 8.1.x, 8.2.x
CIM 4.18.1
Platforms Platform Independent
Vendor products Local and remote JMX servers, MX4J HTTP-based connectors

The field alias functionality is compatible with the current version of this add-on. The current version of this add-on does not support older field alias configurations. Local process monitoring (using "PID" or "PID file" protocols) is only supported on Windows and Linux OS.

For more information about the field alias configuration change, refer to the Splunk Enterprise Release Notes.

New Features

Version 5.2.1 of the Splunk Add-on for Java Management Extensions has the following new features:

  • Change log4j version to log4j 2.15.0
  • Fixed a security vulnerability found in the log4j library

For information on upgrading to the newest version of this add-on, see the Upgrade the Splunk Add-on for JMX topic in this manual.

Fixed issues

Version 5.2.1 of the Splunk Add-on for JMX fixes the following issues. If no issues appear below, no issues have yet been reported:

Known issues

Version 5.2.1 of the Splunk Add-on for JMX has the following reported known issues. If no issues appear below, no issues have yet been reported:

Third-party software attributions

Some of the components included in this add-on are licensed under free or open source licenses. We wish to thank the contributors to those projects.

A complete listing of third-party software information for this add-on is available as a PDF file for download:
Splunk Add-on for JMX third-party software credits.

Version 5.2.0

Version 5.2.0 of the Splunk Add-on for Java Management Extensions was released on Oct 28, 2021.

Compatibility

Version 5.2.0 of the Splunk Add-on for Java Management Extensions is compatible with the following software, CIM versions, and platforms.

Splunk platform versions 8.0.x, 8.1.x, 8.2.x
CIM 4.18.1
Platforms Platform Independent
Vendor products Local and remote JMX servers, MX4J HTTP-based connectors

The field alias functionality is compatible with the current version of this add-on. The current version of this add-on does not support older field alias configurations. Local process monitoring (using "PID" or "PID file" protocols) is only supported on Windows and Linux OS.

For more information about the field alias configuration change, refer to the Splunk Enterprise Release Notes.

New Features

Version 5.2.0 of the Splunk Add-on for Java Management Extensions has the following new features:

  • Performance improvement for IBMSoap connection type server inputs.
  • Minor bug fixes.

For information on upgrading to the newest version of this add-on, see the Upgrade the Splunk Add-on for JMX topic in this manual.

Fixed issues

Version 5.2.0 of the Splunk Add-on for JMX fixes the following issues. If no issues appear below, no issues have yet been reported.


Known issues

Version 5.2.0 of the Splunk Add-on for JMX has the following reported known issues. If no issues appear below, no issues have yet been reported:

Third-party software attributions

Version 5.2.0 of the Splunk Add-on for Java Management Extensions incorporates the following third-party libraries:


Version 5.1.0

Version 5.1.0 of the Splunk Add-on for Java Management Extensions was released on July 19, 2021.

Compatibility

Version 5.1.0.1 of the Splunk Add-on for Java Management Extensions is compatible with the following software, CIM versions, and platforms.

Splunk platform versions 8.0.x, 8.1.x, 8.2.x
CIM 4.18.1
Platforms Platform Independent
Vendor products Local and remote JMX servers, MX4J HTTP-based connectors

The field alias functionality is compatible with the current version of this add-on. The current version of this add-on does not support older field alias configurations. Local process monitoring (using "PID" or "PID file" protocols) is only supported on Windows and Linux OS.

For more information about the field alias configuration change, refer to the Splunk Enterprise Release Notes.

New Features

  • Added support of Java 11 for data collection from remote JMX servers.
  • Migration to the latest Splunk UI which eliminates jQuery vulnerability and gives a fresh look to the add-on UI.
  • Dropped the support for Python2 and Splunk 7.x versions. Add-on now supports Python3 and Splunk 8.x versions only.
  • Compatibility with CIM version 4.18.1.
  • Minor bug fixes.


For information on upgrading to the newest version of this add-on, see the Upgrade the Splunk Add-on for JMX topic in this manual.

Fixed issues

Version 5.1.0 of the Splunk Add-on for JMX fixes the following issues. If no issues appear below, no issues have yet been reported:


Known issues

Version 5.1.0 of the Splunk Add-on for JMX has the following reported known issues. If no issues appear below, no issues have yet been reported:


Date filed Issue number Description
2021-07-15 ADDON-39438, ADDON-39230 The input UI page is displaying wrong error message of SH cluster node when invalid server details are added to the task.conf file from backend in standalone machine
2021-07-10 ADDON-39135, ADDON-39133, ADDON-39137 Expected validation error message is getting displayed in byte (b') string when user try to delete the default template
2021-06-25 ADDON-38680, ADDON-38692 Data collection Using PID for Self Java process (Splunk JMX mod input) is not working
2020-11-11 ADDON-30890 Error is displayed while upgrading the addon on Splunk Windows

Workaround:
Ignore the error and continue with the upgrade. The add-on will work as expected after Splunk restart.
2019-02-12 ADDON-21304, ADDON-42989 Getting "Config file: jmx_tasks does not exist." error in splunkd.log after creating input.

Workaround:
This error message can be ignored safely and once the input is configured, this error message will no longer be logged.
2015-10-19 ADDON-6111 Warning appears on JBoss server when using Predefined_Get_All_Template
2014-12-03 ADDON-2515 SystemProperties (TabularData) are not captured when using soap/hessian/burlap protocol
2014-11-27 ADDON-2422 TA path is hard coded and the configurations will not work if the name is not "Splunk_TA_jmx".
2014-11-27 ADDON-2421 MBean server throws java.lang.ClassCastException when using hessian or burlap protocol

Third-party software attributions

Version 5.1.0 of the Splunk Add-on for Java Management Extensions incorporates the following third-party libraries:


Version 5.0.1

Version 5.0.1 of the Splunk Add-on for Java Management Extensions was released on May 4, 2021.

Compatibility

Version 5.0.1 of the Splunk Add-on for Java Management Extensions is compatible with the following software, CIM versions, and platforms.

Splunk platform versions 7.2.x, 7.3.x, 8.0.x, 8.1.x
CIM 4.17
Platforms Platform Independent
Vendor products Local and remote JMX servers, MX4J HTTP-based connectors

The field alias functionality is compatible with the current version of this add-on. The current version of this add-on does not support older field alias configurations.

For more information about the field alias configuration change, refer to the Splunk Enterprise Release Notes.

New Features

  • Fixed an issue in modular input where nested stats data was not getting ingested to Splunk from IBM Websphere Application Server using the SOAP protocol.

For information on upgrading to the newest version of this add-on, see the Upgrade the Splunk Add-on for JMX topic in this manual.

Fixed issues

Version 5.0.1 of the Splunk Add-on for JMX fixes the following issues. If no issues appear below, no issues have yet been reported:

Date resolved Issue number Description
2021-05-04 ADDON-34149 Nested stats data was not getting ingested to Splunk from IBM WAS using the SOAP protocol

Known issues

Version 5.0.1 of the Splunk Add-on for JMX has the following reported known issues. If no issues appear below, no issues have yet been reported:


Date filed Issue number Description
2021-07-10 ADDON-39135, ADDON-39133, ADDON-39137 Expected validation error message is getting displayed in byte (b') string when user try to delete the default template
2020-11-11 ADDON-30890 Error is displayed while upgrading the addon on Splunk Windows

Workaround:
Ignore the error and continue with the upgrade. The add-on will work as expected after Splunk restart.
2020-10-29 ADDON-30529 Input UI page is unable to load when invalid server details are added in the task.conf file from backend
2020-02-04 ADDON-25183, ADDON-25885 Addons UI is not compatible with Splunk 7.3.3 and Splunk 7.3.4

Workaround:
Customer can switch to any other Splunk version compatible with all their apps and add-ons.
2019-02-12 ADDON-21304, ADDON-42989 Getting "Config file: jmx_tasks does not exist." error in splunkd.log after creating input.

Workaround:
This error message can be ignored safely and once the input is configured, this error message will no longer be logged.
2015-10-19 ADDON-6111 Warning appears on JBoss server when using Predefined_Get_All_Template
2014-12-03 ADDON-2515 SystemProperties (TabularData) are not captured when using soap/hessian/burlap protocol
2014-11-27 ADDON-2421 MBean server throws java.lang.ClassCastException when using hessian or burlap protocol
2014-11-27 ADDON-2422 TA path is hard coded and the configurations will not work if the name is not "Splunk_TA_jmx".

Third-party software attributions

Version 5.0.1 of the Splunk Add-on for Java Management Extensions incorporates the following third-party libraries:


Version 5.0.0

Version 5.0.0 of the Splunk Add-on for Java Management Extensions was released on November 14, 2020.

Compatibility

Version 5.0.0 of the Splunk Add-on for Java Management Extensions is compatible with the following software, CIM versions, and platforms.

Splunk platform versions 7.2.x, 7.3.x, 8.0.x, 8.1.0
CIM 4.17
Platforms Platform Independent
Vendor products Local and remote JMX servers, MX4J HTTP-based connectors

The field alias functionality is compatible with the current version of this add-on. The current version of this add-on does not support older field alias configurations.

For more information about the field alias configuration change, refer to the Splunk Enterprise Release Notes.

New Features

  • Support for data collection from IBM Websphere Application Server (WAS) using Simple Object Access Protocol (SOAP) protocol.
  • Support for using SOAP to collect data from the deployment manager of IBM WAS Network Deployment, where multiple nodes can be administered from one centralized manager.
  • Support for version 4.17 of the Common Information Model (CIM).
  • Bug fixes.

For information on upgrading to the newest version of this add-on, see the Upgrade the Splunk Add-on for JMX topic in this manual.

Fixed issues

Version 5.0.0 of the Splunk Add-on for JMX fixes the following issues:

Date resolved Issue number Description
2020-07-10 ADDON-26828 Addons unable to load UI or collect data on Splunk 8.0.4, 8.0.2004 and Splunk 8.0.5
2020-06-24 ADDON-26866 Table in inputs page can only fetch upto 30 entries only for template

Known issues

Version 5.0.0 of the Splunk Add-on for JMX has the following reported known issues. If no issues appear below, no issues have yet been reported:


Date filed Issue number Description
2021-02-23 ADDON-34149 Nested stats data was not getting ingested to Splunk from IBM WAS using the SOAP protocol
2020-11-11 ADDON-30890 Error is displayed while upgrading the addon on Splunk Windows

Workaround:
Ignore the error and continue with the upgrade. The add-on will work as expected after Splunk restart.
2020-10-29 ADDON-30529 Input UI page is unable to load when invalid server details are added in the task.conf file from backend
2020-02-04 ADDON-25183, ADDON-25885 Addons UI is not compatible with Splunk 7.3.3 and Splunk 7.3.4

Workaround:
Customer can switch to any other Splunk version compatible with all their apps and add-ons.
2019-02-12 ADDON-21304, ADDON-42989 Getting "Config file: jmx_tasks does not exist." error in splunkd.log after creating input.

Workaround:
This error message can be ignored safely and once the input is configured, this error message will no longer be logged.
2015-10-19 ADDON-6111 Warning appears on JBoss server when using Predefined_Get_All_Template
2014-12-03 ADDON-2515 SystemProperties (TabularData) are not captured when using soap/hessian/burlap protocol
2014-11-27 ADDON-2421 MBean server throws java.lang.ClassCastException when using hessian or burlap protocol
2014-11-27 ADDON-2422 TA path is hard coded and the configurations will not work if the name is not "Splunk_TA_jmx".

Third-party software attributions

Version 5.0.0 of the Splunk Add-on for Java Management Extensions incorporates the following third-party libraries:


Version 4.0.0

Version 4.0.0 of the Splunk Add-on for Java Management Extensions (JMX) was released on January 31, 2020.

Compatibility

Version 4.0.0 of the Splunk Add-on for Java Management Extensions is compatible with the following software, CIM versions, and platforms.

Splunk platform versions 7.0.x, 7.1.x, 7.2.x, 7.3.x, 8.0.0
CIM 4.14
Platforms Platform Independent
Vendor products Local and remote JMX servers, MX4J HTTP-based connectors

Fixed issues

Version 4.0.0 of the Splunk Add-on for JMX fixes the following issues:

Date resolved Issue number Description
2019-10-23 ADDON-23696 Create New Input page is not loading all server

Known issues

Version 4.0.0 of the Splunk Add-on for JMX has the following reported known issues. If no issues appear below, no issues have yet been reported:


Date filed Issue number Description
2020-11-11 ADDON-30890 Error is displayed while upgrading the addon on Splunk Windows

Workaround:
Ignore the error and continue with the upgrade. The add-on will work as expected after Splunk restart.
2020-10-29 ADDON-30529 Input UI page is unable to load when invalid server details are added in the task.conf file from backend
2020-05-30 ADDON-26866 Table in inputs page can only fetch upto 30 entries only for template
2020-05-26 ADDON-26828 Addons unable to load UI or collect data on Splunk 8.0.4, 8.0.2004 and Splunk 8.0.5

Workaround:
As a manual workaround, the "import html" statement on Line 16 of splunk/lib/python3.7/site-packages/splunk/util.py file could be commented out, which does not require Splunk restart to take affect.
2020-02-04 ADDON-25183, ADDON-25885 Addons UI is not compatible with Splunk 7.3.3 and Splunk 7.3.4

Workaround:
Customer can switch to any other Splunk version compatible with all their apps and add-ons.
2019-02-12 ADDON-21304, ADDON-42989 Getting "Config file: jmx_tasks does not exist." error in splunkd.log after creating input.

Workaround:
This error message can be ignored safely and once the input is configured, this error message will no longer be logged.
2015-10-19 ADDON-6111 Warning appears on JBoss server when using Predefined_Get_All_Template
2014-12-03 ADDON-2515 SystemProperties (TabularData) are not captured when using soap/hessian/burlap protocol
2014-11-27 ADDON-2421 MBean server throws java.lang.ClassCastException when using hessian or burlap protocol
2014-11-27 ADDON-2422 TA path is hard coded and the configurations will not work if the name is not "Splunk_TA_jmx".

Third-party software attributions

Version 4.0.0 of the Splunk Add-on for Java Management Extensions incorporates the following third-party libraries:

Version 3.3.0

Version 3.3.0 of the Splunk Add-on for Java Management Extensions was released on April 16, 2019.

Compatibility

Version 3.3.0 of the Splunk Add-on for Java Management Extensions is compatible with the following software, CIM versions, and platforms.

Splunk platform versions 6.6.x, 7.0.x, 7.1.x, 7.2.x
CIM 4.12
Platforms Platform Independent
Vendor products Local and remote JMX servers, MX4J HTTP-based connectors

Fixed issues

Version 3.3.0 of the Splunk Add-on for JMX fixes the following issues:

Date resolved Issue number Description
2019-03-04 ADDON-2531 On JMX server set up page, validation for number fields on Safari does not work properly
2019-03-03 ADDON-2476 On JMX data input page, there is a line "Showing 1-4 of 4 items" while no item is displayed

Known issues

Version 3.3.0 of the Splunk Add-on for JMX has the following reported known issues. If no issues appear below, no issues have yet been reported:


Date filed Issue number Description
2019-09-24 ADDON-23696 Create New Input page is not loading all server
2019-02-12 ADDON-21304, ADDON-42989 Getting "Config file: jmx_tasks does not exist." error in splunkd.log after creating input.

Workaround:
This error message can be ignored safely and once the input is configured, this error message will no longer be logged.
2016-03-08 ADDON-8208 Unable to collect WAS MBean Metrics due to credentials not being passed
2015-10-19 ADDON-6111 Warning appears on JBoss server when using Predefined_Get_All_Template
2014-12-03 ADDON-2515 SystemProperties (TabularData) are not captured when using soap/hessian/burlap protocol
2014-11-27 ADDON-2422 TA path is hard coded and the configurations will not work if the name is not "Splunk_TA_jmx".
2014-11-27 ADDON-2421 MBean server throws java.lang.ClassCastException when using hessian or burlap protocol

Third-party software attributions

Version 3.3.0 of the Splunk Add-on for JMX incorporates the following third-party software or libraries:

Version 3.2.0

Version 3.2.0 of the Splunk Add-on for Java Management Extensions is compatible with the following software, CIM versions, and platforms.

Splunk platform versions 6.4.X or later
CIM 4.0 or later
Platforms Platform Independent
Vendor products Local and remote JMX servers, MX4J HTTP-based connectors

Fixed issues

Version 3.2.0 of the Splunk Add-on for JMX fixes the following issues.

Date resolved Issue number Description
2018-04-27 ADDON-6349 add start_by_shell=false in generated inputs.conf
2018-03-26 ADDON-15958, ADDON-15957 Configuration screens do not work on Splunk platform 7.0.0
2018-03-26 ADDON-11322 Display error in Splunk 6.5

Known issues

Version 3.2.0 of the Splunk Add-on for JMX has the following reported known issues.


Date filed Issue number Description
2016-03-08 ADDON-8208 Unable to collect WAS MBean Metrics due to credentials not being passed
2015-10-19 ADDON-6111 Warning appears on JBoss server when using Predefined_Get_All_Template
2014-12-05 ADDON-2531 On JMX server set up page, validation for number fields on Safari does not work properly
2014-12-03 ADDON-2515 SystemProperties (TabularData) are not captured when using soap/hessian/burlap protocol
2014-12-02 ADDON-2476 On JMX data input page, there is a line "Showing 1-4 of 4 items" while no item is displayed
2014-11-27 ADDON-2421 MBean server throws java.lang.ClassCastException when using hessian or burlap protocol
2014-11-27 ADDON-2422 TA path is hard coded and the configurations will not work if the name is not "Splunk_TA_jmx".

Third-party software attributions

Version 3.2.0 of the Splunk Add-on for JMX incorporates the following third-party software or libraries.

Version 3.1.1

Version 3.1.1 of the Splunk Add-on for Java Management Extensions is compatible with the following software, CIM versions, and platforms.

Splunk platform versions 6.1 or later
CIM 4.0 or later
Platforms Platform independent
Vendor Products Local and remote JMX servers, MX4J HTTP-based connectors

Fixed issues

Version 3.1.1 of the Splunk Add-on for JMX fixes the following issues.

Date Issue number Description
2016-04-05 ADDON-8572 When adding a new JMX server with a Connection Type of Process ID, the Process ID field only accepts values between 1 and 65535.
2016-04-05 ADDON-8567 Custom root_endpoint set in web.conf doesn't work.
2016-03-24 ADDON-8379 Remove JBoss .jar files from Splunk Add-on for JMX bin/lib folder per best practice since different app servers may need different versions of .jar packages for JMX protocols. Splunk Add-on for JBoss users need to manually copy the JBoss .jar files to the Splunk Add-on for JMX bin/lib folder.
2016-02-21 ADDON-7494 Change the serialization mode from field based to get method based in order to extract all metrics from the stats attribute of MBean for IBM WebSphere.

Known issues

Version 3.1.1 of the Splunk Add-on for JMX has the following reported known issues.

Date Issue number Description
2017-10-05 ADDON-15958 Configuration screens do not work on Splunk 7.
2016-03-08 ADDON-8208 Unable to collect IBM WAS MBean metrics due to credentials not being passed.
2016-02-01 ADDON-7677 Add-on does not support the "debug" logging level for the priority parameter in the $SPLUNK_HOME/etc/apps/Splunk_TA_jmx/bin/lib/log4j.xml file. Only "info" and "error" logging levels are supported.
2016-01-30 ADDON-8695 FIPS mode is not supported by this add-on. For a workaround, see Add-ons and FIPS mode in the Splunk Add-ons manual.
2016-01-13 ADDON-5325 requireClientCert=true in server.conf is not supported by add-ons using modular inputs and REST. If this setting is enabled in server.conf, communication is broken between the modular input and splunkd and the add-on stops collecting data. The following error appears in the splunkd.log: "SSL3_GET_CLIENT_CERTIFICATE:peer did not return a certificate." The workaround is to set requireClientCert=false.
2015-10-19 ADDON-6111 Warning appears in JBoss server log when using Predefined_Get_All_Template in the Splunk Add-on for JMX.
2015-10-29 SPL-104398 For users running the Splunk platform on Ubuntu, the start_by_shell=false setting will not take effect and the Splunk platform will display a warning message on startup. Workaround: update your Splunk software to version 6.3.0 or later.
2015-11-06 ADDON-6349 When using dash shell (the default shell in Ubuntu), the Splunk platform does not terminate modular input processes properly. Workaround: If running the Splunk platform on Ubuntu, add start_by_shell=false to the [jmx://...] stanza of inputs.conf.
2014-12-05 ADDON-2531 UI validation displays incorrect messages for some fields.
2014-12-04 ADDON-2421 MBean server throws java.lang.ClassCastException when using hessian or burlap protocol due to limitation of MX4J library. Warnings can be ignored.
2014-12-04 ADDON-2515 SystemProperties (TabularData) are not captured when using soap/hessian/burlap protocol due to limitations of MX4J library. To support these three protocols, the JVM server also needs to use the same MX4J library.
2014-12-04 ADDON-2473 Add-on allows servers or templates to be deleted even if they are being used by a task. Deleted server or template will still display in the Task UI with no indication that it was deleted.
2014-12-04 ADDON-2476 On the JMX data input page, there is a line "Showing 1-4 of 4 items" while no items are displayed.
2014-12-02 ADDON-2472 Cannot upgrade the add-on via the UI on Windows 2012. Workaround: Disable the add-on first, then upgrade.
2014-12-01 ADDON-2422 Configurations will not work if the add-on folder name is not "Splunk_TA_jmx".
2014-11-20 ADDON-2187 Client cannot connect to JMX server if the server is using the protocol "local," which is an internal protocol in MX4J. It is not supported by Splunk.
2014-11-19 ADDON-2344 If an app.conf containing credentials is copied from another Splunk instance, the credential will be invalid.

Version 3.1.0

Version 3.1.0 of the Splunk Add-on for Java Management Extensions has the same compatibility specifications as version 3.1.1.

New Features

Version 3.1.0 of the Splunk Add-on for JMX has the following enhancement.

Date Issue number Description
2015-10-13 ADDON-5508 Change host from forwarder IP/hostname to data source ip:port or hostname:port and change source from JMX connection string (e.g., service:jmx:rmi:///jindi/rmi://127.0.0.1:8888/jmxrmi) to JMX MBean ObjectName (e.g., kafka.server.ReplicaManager.UnderReplicatedPartitions). This enhancement makes it easier for users to find JMX events using the source field.

Fixed issues

Version 3.1.0 of the Splunk Add-on for JMX fixes the following issues.

Date Issue number Description
2015-10-13 ADDON-5510 MBean information is missing when collecting data sources from third party applications which results in not being able to identify the data source.
2015-10-20 ADDON-6117 Add-on does not respect root_endpoint set in web.conf. The Add Server button is greyed out and inoperable.
2015-10-13 ADDON-5437 If the Splunk Add-on for ServiceNow or the Splunk Add-on for Box is installed and data inputs have been configured in one of these add-ons, then the inputs are disabled, the Splunk Add-on for JMX is unable to get data from a configured Tomcat server.
2015-10-13 ADDON-5202 The predefined template, Predefined_JVM_Template, renames the default mbean attribute name, causing an incorrect CIM mapping.

Known issues

Version 3.1.0 of the Splunk Add-on for JMX has the following reported known issues.

Date Issue number Description
2016-02-01 ADDON-7677/ ADDON-8208 Add-on does not support the "debug" logging level for the priority parameter in the $SPLUNK_HOME/etc/apps/Splunk_TA_jmx/bin/lib/log4j.xml file. Only "info" and "error" logging levels are supported.
2016-01-30 ADDON-7646 FIPS mode is not supported by this add-on. For a workaround, see Add-ons and FIPS mode in the Splunk Add-ons manual.
2016-01-13 ADDON-5325 requireClientCert=true in server.conf is not supported by add-ons using modular inputs and REST. If this setting is enabled in server.conf, communication is broken between the modular input and splunkd and the add-on stops collecting data. The following error appears in the splunkd.log: "SSL3_GET_CLIENT_CERTIFICATE:peer did not return a certificate." The workaround is to set requireClientCert=false.
2015-11-06 ADDON-6349 When using dash shell (the default shell in Ubuntu), the Splunk platform does not terminate modular input processes properly. Workaround: If running the Splunk platform on Ubuntu, add start_by_shell=false to the [jmx://...] stanza of inputs.conf.
2015-10-29 SPL-104398 For users running the Splunk platform on Ubuntu, the start_by_shell=false setting will not take effect and the Splunk platform will display a warning message on startup. Workaround: update your Splunk software to version 6.3.0 or later.
2014-12-05 ADDON-2531 UI validation displays incorrect messages for some fields.
2014-12-04 ADDON-2421 MBean server throws java.lang.ClassCastException when using hessian or burlap protocol due to limitation of MX4J library. Warnings can be ignored.
2014-12-04 ADDON-2515 SystemProperties (TabularData) are not captured when using soap/hessian/burlap protocol due to limitations of MX4J library. To support these three protocols, the JVM server also needs to use the same MX4J library, which is quite old.
2014-12-04 ADDON-2473 Add-on allows servers or templates to be deleted even if they are being used by a task. Deleted server or template will still display in the Task UI with no indication that it was deleted.
2014-12-04 ADDON-2476 On the JMX data input page, there is a line "Showing 1-4 of 4 items" while no items are displayed.
2014-12-02 ADDON-2472 Cannot upgrade the add-on via the UI on Windows 2012. Workaround: Disable the add-on first, then upgrade.
2014-12-01 ADDON-2422 Configurations will not work if the add-on folder name is not "Splunk_TA_jmx".
2014-11-20 ADDON-2187 Client cannot connect to JMX server if the server is using the protocol "local", which is an internal protocol in MX4J. It is not supported by Splunk.
2014-11-19 ADDON-2344 If an app.conf containing credentials is copied from another Splunk instance, the credential will be invalid.

Considerations if upgrading from version 3.0.2

If you are upgrading from version 3.0.2 or any prior version of the Splunk Add-on for JMX, note that the assignment of the host and source fields has changed in the 3.1.0 release as noted in the "New Features" section above. These changes may cause existing searches to no longer work. You will need to revise your SPL searches to use the correct host or source if any of your SPL searches depend on host or source.

Migration Guide

The Splunk Add-on for JMX is intended to replace the add-on components of Monitoring of Java Virtual Machines with JMX. Splunk built the Splunk Add-on for JMX as a separate add-on, so you cannot use the update function in your existing installation of the Monitoring of Java Virtual Machines with JMX app to install and use this add-on. The Splunk Add-on for JMX is compatible with the old app's inputs.conf and XML configuration files, so you can manually upgrade and continue to use your old configurations.

Some features of the Monitoring of Java Virtual Machines with JMX app are not available in this add-on.

  • Although the element formatter still exists for backwards compatibility, the add-on does not use it. Now the add-on indexes events in JSON format for better field extractions.
  • Although the attribute filterImplementationClass still exists in element notification, the attribute is not used in this version.

Migration steps

This add-on does not work with the Monitoring of Java Virtual Machines with JMX app on the same Splunk Enterprise instance, so you must follow these migration steps to upgrade.

Note: If you do not want to keep your old configurations and plan to create new data inputs, you can just remove the Monitoring of Java Virtual Machines with JMX app and install this add-on.

If you want to keep your old configurations, follow these steps.

1. Find the folder where the Monitoring of Java Virtual Machines with JMX app is installed. By default, it is $SPLUNK_HOME/etc/apps/jmx_ta.

2. Back up your XML configuration files in the app folder or its sub-folders.

3. Back up your inputs.conf in the local folder.

4. If you changed your inputs.conf in the default folder, merge your changes into your backup copy of your local/inputs.conf.

5. Backup all the other files in the local folder if you need them.

6. Uninstall the old app, or delete the app folder.

7. Install the Splunk Add-on for Java Management Extensions.

8. Put your backed up copy of your local/inputs.conf into $SPLUNK_HOME/etc/apps/Splunk_TA_jmx/local/.

9. Put your backed up XML configuration files into $SPLUNK_HOME/etc/apps/Splunk_TA_jmx/bin/config/.

10. Check the value of configuration config_file_dir in your local/inputs.conf.

  • If you did not set any value for config_file_dir in the stanza [jmx] in the old app's inputs.conf, the default value is now $SPLUNK_HOME/etc/apps/Splunk_TA_jmx/bin/config/. If you did set it, please change it to $SPLUNK_HOME/etc/apps/Splunk_TA_jmx/bin/config/.
  • Check the value of configuration config_file_dir in all your JMX data inputs in every app using those XML files. Make sure each data input's config_file_dir is set to $SPLUNK_HOME/etc/apps/Splunk_TA_jmx/bin/config/.

11. The default index is now the default index of Splunk Enterprise, instead of jmx. Also, the add-on does not include the index jmx index. If you want to use it, you need to add it manually. You also need to manually set index=jmx in all your JMX data inputs if you were using the old default value and want to continue to use jmx.

Third-party software attributions

Version 3.1.0 of the Splunk Add-on for JMX incorporates the following third-party software or libraries.

Version 3.0.2

Version 3.0.2 of the Splunk Add-on for Java Management Extensions has the same compatibility specifications as version 3.1.0.

Migration Guide

The Splunk Add-on for JMX is intended to replace the add-on components of Monitoring of Java Virtual Machines with JMX. Splunk built the Splunk Add-on for JMX as a separate add-on, so you cannot use the update function in your existing installation of the Monitoring of Java Virtual Machines with JMX app to install and use this add-on. The Splunk Add-on for JMX is compatible with the old app's inputs.conf and XML configuration files, so you can manually upgrade and continue to use your old configurations.

Some features of the Monitoring of Java Virtual Machines with JMX app are not available in this add-on.

  • Although the element formatter still exists for backwards compatibility, the add-on does not use it. Now the add-on indexes events in JSON format for better field extractions.
  • Although the attribute filterImplementationClass still exists in element notification, the attribute is not used in this version.

Migration steps

This add-on does not work with the Monitoring of Java Virtual Machines with JMX app on the same Splunk Enterprise instance, so you must follow these migration steps to upgrade.

Note: If you do not want to keep your old configurations and plan to create new data inputs, you can just remove the Monitoring of Java Virtual Machines with JMX app and install this add-on.

If you want to keep your old configurations, follow these steps.

1. Find the folder where the Monitoring of Java Virtual Machines with JMX app is installed. By default, it is $SPLUNK_HOME/etc/apps/jmx_ta.

2. Back up your XML configuration files in the app folder or its sub-folders.

3. Back up your inputs.conf in the local folder.

4. If you changed your inputs.conf in the default folder, merge your changes into your backup copy of your local/inputs.conf.

5. Backup all the other files in the local folder if you need them.

6. Uninstall the old app, or delete the app folder.

7. Install the Splunk Add-on for Java Management Extensions.

8. Put your backed up copy of your local/inputs.conf into $SPLUNK_HOME/etc/apps/Splunk_TA_jmx/local/.

9. Put your backed up XML configuration files into $SPLUNK_HOME/etc/apps/Splunk_TA_jmx/bin/config/.

10. Check the value of configuration config_file_dir in your local/inputs.conf.

  • If you did not set any value for config_file_dir in the stanza [jmx] in the old app's inputs.conf, the default value is now $SPLUNK_HOME/etc/apps/Splunk_TA_jmx/bin/config/. If you did set it, please change it to $SPLUNK_HOME/etc/apps/Splunk_TA_jmx/bin/config/.
  • Check the value of configuration config_file_dir in all your JMX data inputs in every app using those XML files. Make sure each data input's config_file_dir is set to $SPLUNK_HOME/etc/apps/Splunk_TA_jmx/bin/config/.

11. The default index is now the default index of Splunk Enterprise, instead of jmx. Also, the add-on does not include the index jmx index. If you want to use it, you need to add it manually. You also need to manually set index=jmx in all your JMX data inputs if you were using the old default value and want to continue to use jmx.

Fixed issues

Version 3.0.2 of the Splunk Add-on for JMX fixed the following issues.

Date Issue number Description
06/18/15 ADDON-4280 Improve behavior for already-configured passwords upon configuration change.
06/11/15 ADDON-3202 Server configuration page allows an http:// URL, but logs say that only jmx:// URLs are valid.
06/10/15 ADDON-3922 No logging error/item when TA task could not connect to target JVM (for example, connection rejected by wrongly configured password).
06/10/15 ADDON-4187 When doing JMX data collection from IBM WebSphere Application Server, it reported java.lang.NoClassDefFoundError: javax.management.j2ee.statistics.Stats. Fix includes installing IBM JDK or JRE for WebSphere data collection and manually adding necessary jar files.
06/10/15 ADDON-2752 Imports of 3rd party libraries can cause conflicts with other add-ons.

Known issues

Version 3.0.2 of the Splunk Add-on for JMX had the following reported known issues.

Date Issue number Description
2015-09-09 ADDON-5437 If the Splunk Add-on for ServiceNow or the Splunk Add-on for Box is installed and data inputs have been configured in one of these add-ons, then the inputs are disabled, the Splunk Add-on for JMX is unable to get data from a configured Tomcat server.
12/05/14 ADDON-2531 UI validation displays incorrect messages for some fields.
12/04/14 ADDON-2421 MBean server throws java.lang.ClassCastException when using hessian or burlap protocol due to limitation of MX4J library. Warnings can be ignored.
12/04/14 ADDON-2515 SystemProperties (TabularData) are not captured when using soap/hessian/burlap protocol due to limitations of the MX4J library. To support these three protocols, the JVM server also needs to use the same MX4J library, which is quite old.
12/04/14 ADDON-2473 Add-on allows servers or templates to be deleted even if they are being used by a task. Deleted server or template will still display in the Task UI with no indication that it was deleted.
12/04/14 ADDON-2476 On the JMX data input page, there is a line "Showing 1-4 of 4 items" while no items are displayed.
12/02/14 ADDON-2472 Cannot upgrade the add-on via the UI on Windows 2012. Workaround: Disable the add-on first, then upgrade.
12/01/14 ADDON-2422 Configurations will not work if the add-on folder name is not "Splunk_TA_jmx".
11/20/14 ADDON-2187 Clients cannot connect to JMX server if the server is using the protocol "local", which is an internal protocol in MX4J.
11/19/14 ADDON-2344 JMX TA can't work if the user copies credentials of any app from another Splunk Enterprise instance.

Third-party software attributions

Version 3.0.2 of the Splunk Add-on for JMX incorporated the following third-party software or libraries.

Version 3.0.1

Version 3.0.1 of the Splunk Add-on for Java Management Extensions has the same compatibility specifications as version 3.0.2.

Migration Guide

The Splunk Add-on for JMX is intended to replace the add-on components of Monitoring of Java Virtual Machines with JMX. Splunk built the Splunk Add-on for JMX as a separate add-on, so you cannot use the update function in your existing installation of the Monitoring of Java Virtual Machines with JMX app to install and use this add-on. The Splunk Add-on for JMX is compatible with the old app's inputs.conf and XML configuration files, so you can manually upgrade and continue to use your old configurations.

Some features of the Monitoring of Java Virtual Machines with JMX app are not available in this add-on.

  • Although the element formatter still exists for backwards compatibility, the add-on does not use it. Now the add-on indexes events in JSON format for better field extractions.
  • Although the attribute filterImplementationClass still exists in element notification, the attribute is not used in this version.

Migration steps

This add-on does not work with the Monitoring of Java Virtual Machines with JMX app on the same Splunk Enterprise instance, so you must follow these migration steps to upgrade.

Note: If you do not want to keep your old configurations and plan to create new data inputs, you can just remove the Monitoring of Java Virtual Machines with JMX app and install this add-on.

If you want to keep your old configurations, follow these steps.

1. Find the folder where the Monitoring of Java Virtual Machines with JMX app is installed. By default, it is $SPLUNK_HOME/etc/apps/jmx_ta.

2. Back up your XML configuration files in the app folder or its sub-folders.

3. Back up your inputs.conf in the local folder.

4. If you changed your inputs.conf in the default folder, merge your changes into your backup copy of your local/inputs.conf.

5. Backup all the other files in the local folder if you need them.

6. Uninstall the old app, or delete the app folder.

7. Install the Splunk Add-on for Java Management Extensions.

8. Put your backed up copy of your local/inputs.conf into $SPLUNK_HOME/etc/apps/Splunk_TA_jmx/local/.

9. Put your backed up XML configuration files into $SPLUNK_HOME/etc/apps/Splunk_TA_jmx/bin/config/.

10. Check the value of configuration config_file_dir in your local/inputs.conf.

  • If you did not set any value for config_file_dir in the stanza [jmx] in the old app's inputs.conf, the default value is now $SPLUNK_HOME/etc/apps/Splunk_TA_jmx/bin/config/. If you did set it, please change it to $SPLUNK_HOME/etc/apps/Splunk_TA_jmx/bin/config/.
  • Check the value of configuration config_file_dir in all your JMX data inputs in every app using those XML files. Make sure each data input's config_file_dir is set to $SPLUNK_HOME/etc/apps/Splunk_TA_jmx/bin/config/.

11. The default index is now the default index of Splunk Enterprise, instead of jmx. Also, the add-on does not include the index jmx index. If you want to use it, you need to add it manually. You also need to manually set index=jmx in all your JMX data inputs if you were using the old default value and want to continue to use jmx.

Fixed issues

Version 3.0.1 of the Splunk Add-on for JMX fixed the following issues.

Date Issue number Description
05/28/15 ADDON-3911 Users should be able to choose network Java collections over TLS instead of SSL.
05/18/15 ADDON-4015 Hardware and software requirements need more detail.
05/14/15 ADDON-4036 Java 8 support.
05/13/15 ADDON-3807 A few attributes defined in 'Predefined_JVM_Template' are not found in Windows2012/JDK1.7/Tomcat8.

Known issues

Version 3.0.1 of the Splunk Add-on for JMX had the following reported known issues.

Date Issue number Description
05/05/15 ADDON-3922 No logging error/item when TA task could not connect to target JVM (for example, connection rejected by wrongly configured password).
02/18/15 ADDON-3202 Server configuration page allows an http:// URL, but logs say that only jmx:// URLs are valid.
12/05/14 ADDON-2531 UI validation displays incorrect messages for some fields.
12/04/14 ADDON-2421 MBean server throws java.lang.ClassCastException when using hessian or burlap protocol due to limitation of MX4J library. Warnings can be ignored.
12/04/14 ADDON-2515 SystemProperties (TabularData) are not captured when using soap/hessian/burlap protocol due to limitations of the MX4J library. To support these three protocols, the JVM server also needs to use the same MX4J library, which is quite old.
12/04/14 ADDON-2473 Add-on allows servers or templates to be deleted even if they are being used by a task. Deleted server or template will still display in the Task UI with no indication that it was deleted.
12/04/14 ADDON-2476 On the JMX data input page, there is a line "Showing 1-4 of 4 items" while no items are displayed.
12/02/14 ADDON-2472 Cannot upgrade the add-on via the UI on Windows 2012. Workaround: Disable the add-on first, then upgrade.
12/01/14 ADDON-2422 Configurations will not work if the add-on folder name is not "Splunk_TA_jmx".
11/20/14 ADDON-2187 Clients cannot connect to JMX server if the server is using the protocol "local", which is an internal protocol in MX4J.
11/19/14 ADDON-2344 JMX TA can't work if the user copies credentials of any app from another Splunk Enterprise instance.

Third-party software attributions

Version 3.0.1 of the Splunk Add-on for JMX incorporates the following third-party software or libraries.

Version 3.0.0

Version 3.0.0 of the Splunk Add-on for JMX has the same compatibility specifications as version 3.0.1.

Migration Guide

The Splunk Add-on for JMX is intended to replace the add-on components of Monitoring of Java Virtual Machines with JMX. Splunk built the Splunk Add-on for JMX as a separate add-on, so you cannot use the update function in your existing installation of the Monitoring of Java Virtual Machines with JMX app to install and use this add-on. The Splunk Add-on for JMX is compatible with the old app's inputs.conf and XML configuration files, so you can manually upgrade and continue to use your old configurations.

Some features of the Monitoring of Java Virtual Machines with JMX app are not available in this add-on.

  • Although the element formatter still exists for backwards compatibility, the add-on does not use it. Now the add-on indexes events in JSON format for better field extractions.
  • Although the attribute filterImplementationClass still exists in element notification, the attribute is not used in this version.

Migration steps

This add-on does not work with the Monitoring of Java Virtual Machines with JMX app on the same Splunk Enterprise instance, so you must follow these migration steps to upgrade.

Note: If you do not want to keep your old configurations and plan to create new data inputs, you can just remove the Monitoring of Java Virtual Machines with JMX app and install this add-on.

If you want to keep your old configurations, follow these steps.

1. Find the folder where the Monitoring of Java Virtual Machines with JMX app is installed. By default, it is $SPLUNK_HOME/etc/apps/jmx_ta.

2. Back up your XML configuration files in the app folder or its sub-folders.

3. Back up your inputs.conf in the local folder.

4. If you changed your inputs.conf in the default folder, merge your changes into your backup copy of your local/inputs.conf.

5. Backup all the other files in the local folder if you need them.

6. Uninstall the old app, or delete the app folder.

7. Install the Splunk Add-on for Java Management Extensions.

8. Put your backed up copy of your local/inputs.conf into $SPLUNK_HOME/etc/apps/Splunk_TA_jmx/local/.

9. Put your backed up XML configuration files into $SPLUNK_HOME/etc/apps/Splunk_TA_jmx/bin/config/.

10. Check the value of configuration config_file_dir in your local/inputs.conf.

  • If you did not set any value for config_file_dir in the stanza [jmx] in the old app's inputs.conf, the default value is now $SPLUNK_HOME/etc/apps/Splunk_TA_jmx/bin/config/. If you did set it, please change it to $SPLUNK_HOME/etc/apps/Splunk_TA_jmx/bin/config/.
  • Check the value of configuration config_file_dir in all your JMX data inputs in every app using those XML files. Make sure each data input's config_file_dir is set to $SPLUNK_HOME/etc/apps/Splunk_TA_jmx/bin/config/.

11. The default index is now the default index of Splunk Enterprise, instead of jmx. Also, the add-on does not include the index jmx index. If you want to use it, you need to add it manually. You also need to manually set index=jmx in all your JMX data inputs if you were using the old default value and want to continue to use jmx.

New features

Version 3.0.0 of the Splunk Add-on for JMX has the following new features.

Date Issue number Description
01/04/15 ADDON-1381 Newly Splunk-supported.
01/04/15 ADDON-2534 Improved UI.
12/03/14 ADDON-2406 New predefined templates provided in the add-on to help users get started defining data collection parameters.
12/03/14 ADDON-2453 Users can configure the log level.
12/02/14 ADDON-2411 Replaced modular input configuration UI with new interface for configuring tasks and their components.
12/02/14 ADDON-2464 Users can import trust certification for connecting to a JMX server with SSL.
11/27/14 ADDON-2096 Indexed events mapped to the JVM data model of the Splunk CIM.
11/27/14 ADDON-2402 Support for scheduling JMX tasks in the configuration files.
11/27/14 ADDON-2401 Support for defining JMX servers in the configuration files.
11/27/14 ADDON-2403 Support for one task to pull data from multiple servers using multiple templates.
11/27/14 ADDON-2407 Support for configuration under specific app namespaces in the UI.
11/27/14 ADDON-2404 Support for management of legacy tasks inherited from previous versions of the add-on in the UI.
11/27/14 ADDON-2405 Validation for input fields in the UI.
11/27/14 ADDON-2408 When a user updates backend configuration files, the UI is updated automatically.
11/27/14 ADDON-2409 When a user updates backend configuration files, affected tasks are automatically refreshed and loaded.
11/27/14 ADDON-2400 Support for third-party app's JMX templates in configuration files and in the UI.
11/27/14 ADDON-2399 New UI page for configuring tasks.
11/27/14 ADDON-2373 New UI page for configuring templates.
11/27/14 ADDON-2372 New UI page for configuring server connection details.
11/23/14 ADDON-2098 Support for secure credential management for server access. Credentials are secured automatically in the configuration UI. For secure credential management in the XML configuration file, use the jmxaccount attribute.
11/12/14 ADDON-2097 The add-on ships with a set of pre-built panels.
11/05/14 ADDON-2100 Backwards compatibility with the Monitoring of Java Virtual Machines with JMX app.
11/05/14 ADDON-2196 Support for different polling intervals for each server, MBean, Attribute, and Operation.

Known issues

Version 3.0.0 of the Splunk Add-on for JMX has the following reported known issues.

Date Issue number Description
12/05/14 ADDON-2531 UI validation displays incorrect messages for some fields.
12/04/14 ADDON-3127 Java 8 Support. Java Runtime version 8 is not supported yet.
12/04/14 ADDON-2421 MBean server throws java.lang.ClassCastException when using hessian or burlap protocol due to limitation of MX4J library. Warnings can be ignored.
12/04/14 ADDON-2515 SystemProperties (TabularData) are not captured when using soap/hessian/burlap protocol due to limitations of the MX4J library. To support these three protocols, the JVM server also needs to use the same MX4J library, which is quite old.
12/04/14 ADDON-2473 Add-on allows servers or templates to be deleted even if they are being used by a task. Deleted server or template will still display in the Task UI with no indication that it was deleted.
12/04/14 ADDON-2476 On the JMX data input page, there is a line "Showing 1-4 of 4 items" while no items are displayed.
12/02/14 ADDON-2472 Cannot upgrade the add-on via the UI on Windows 2012. Workaround: Disable the add-on first, then upgrade.
12/01/14 ADDON-2422 Configurations will not work if the add-on folder name is not "Splunk_TA_jmx".
11/20/14 ADDON-2187 Clients cannot connect to JMX server if the server is using the protocol "local", which is an internal protocol in MX4J.

Third-party software attributions

Version 3.0.0 of the Splunk Add-on for JMX incorporates the following third-party software or libraries.

Last modified on 18 December, 2021
PREVIOUS
Release notes for the Splunk Add-on for JMX
 

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