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 6.0.0. See Release notes for the Splunk Add-on for JMX for the release notes of this latest version.

Version 5.6.0

Version 5.6.0 of the Splunk Add-on for Java Management Extensions was released on March 12, 2025.

Compatibility

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

Component	Description
Splunk platform versions	9.0.x, 9.1.x, 9.2.x, 9.3.x, 9.4.x
CIM	5.3.2
Platforms	Platform Independent
Vendor products	Local and remote JMX servers, MX4J HTTP-based connectors

Note

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

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.6.0 of the Splunk Add-on for JMX fixes the following issues. If no issues appear in this section, no issues have yet been reported:

Known issues

Version 5.6.0 of the Splunk Add-on for JMX has the following reported known issues. If no issues appear in this section, no issues have yet been reported:

Version 5.5.1

Version 5.5.1 of the Splunk Add-on for Java Management Extensions was released on November 15, 2024.

Compatibility

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

Component	Description
Splunk platform versions	9.0.x, 9.1.x, 9.2.x, 9.3.x
CIM	5.3.2
Platforms	Platform Independent
Vendor products	Local and remote JMX servers, MX4J HTTP-based connectors

Note

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.5.1 of the Splunk Add-on for Java Management Extensions has the following new features:

Fixed the security vulnerabilities found in the castor 1.2 version java library by using the latest modularized version castor-xml 1.4.1 instead of it.

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.5.1 of the Splunk Add-on for JMX fixes the following issues. If no issues appear in this section, no issues have yet been reported:

Known issues

Version 5.5.1 of the Splunk Add-on for JMX has the following reported known issues. If no issues appear in this section, no issues have yet been reported:

Version 5.5.0

Version 5.5.0 of the Splunk Add-on for Java Management Extensions was released on September 6, 2024.

Compatibility

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

Component	Description
Splunk platform versions	9.0.x, 9.1.x, 9.2.x, 9.3.x
CIM	5.3.2
Platforms	Platform Independent
Vendor products	Local and remote JMX servers, MX4J HTTP-based connectors

Note

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.5.0 of the Splunk Add-on for Java Management Extensions has the following new features:

• Added support for IPv6 addresses

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.5.0 of the Splunk Add-on for JMX fixes the following issues. If no issues appear in this section, no issues have yet been reported:

Known issues

Version 5.5.0 of the Splunk Add-on for JMX has the following reported known issues. If no issues appear in this section, no issues have yet been reported:

Version 5.4.0

Version 5.4.0 of the Splunk Add-on for Java Management Extensions was released on April 4, 2024.

Compatibility

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

Component	Description
Splunk platform versions	9.0.x, 9.1.x, 9.2.x
CIM	4.18.1
Platforms	Platform Independent
Vendor products	Local and remote JMX servers, MX4J HTTP-based connectors

Note

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.4.0 of the Splunk Add-on for Java Management Extensions has the following new features:

• Added support for Java 21 (openJDK, Oracle JDK and IBM WAS JDK) for data collection from JMX servers
• Fixed the security vulnerabilities found in the certifi, urllib3, semver and postcss libraries by upgrading their version from 2022.12.7 to 2023.11.17, 1.26.12 to 1.26.18, 7.3.8 to 7.5.4, and 8.4.21 to 8.4.32 respectively.

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.4.0 of the Splunk Add-on for JMX fixes the following issues. If no issues appear in this section, no issues have yet been reported:

Known issues

Version 5.4.0 of the Splunk Add-on for JMX has the following reported known issues. If no issues appear in this section, no issues have yet been reported:

Version 5.3.3

Version 5.3.3 of the Splunk Add-on for Java Management Extensions was released on March 7, 2023.

Compatibility

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

Component	Description
Splunk platform versions	9.0.x, 9.1.x
CIM	4.18.1
Platforms	Platform Independent
Vendor products	Local and remote JMX servers, MX4J HTTP-based connectors

Note

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.3.3 of the Splunk Add-on for Java Management Extensions has the following new features:

• Fixed the security vulnerabilities found in the certifi, urllib3, semver and postcss libraries by upgrading their version from 2022.12.7 to 2023.11.17, 1.26.12 to 1.26.18, 7.3.8 to 7.5.4, and 8.4.21 to 8.4.32 respectively.

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.3.3 of the Splunk Add-on for JMX fixes the following issues. If no issues appear in this section, no issues have yet been reported:

Known issues

Version 5.3.3 of the Splunk Add-on for JMX has the following reported known issues. If no issues appear in this section, no issues have yet been reported:

Version 5.3.2

Version 5.3.2 of the Splunk Add-on for Java Management Extensions was released on March 7, 2023.

Compatibility

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

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

Note

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.3.2 of the Splunk Add-on for Java Management Extensions has the following new features:

• Upgraded the certifi library to version 2022.12.7
• Fixed a security vulnerability found in the certifi library
• Removed the “castor-xml” and “castor-core” library and used the “com.springsource.org.castor” library instead in order to resolve security vulnerability

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.3.2 of the Splunk Add-on for JMX fixes the following issues. If no issues appear in this section, no issues have yet been reported:

Known issues

Version 5.3.2 of the Splunk Add-on for JMX has the following reported known issues. If no issues appear in this section, no issues have yet been reported:

Version 5.3.1

Version 5.3.1 of the Splunk Add-on for Java Management Extensions was released on July 18, 2022.

Compatibility

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

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

Note

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.3.1 of the Splunk Add-on for Java Management Extensions has the following new features:

• Added support for Java 17 for data collection from remote JMX servers.
• Added support for polling data from JMX servers with SSL Registry configured from the server-side.
• Upgraded the log4j library from version 2.1.6.0 to 2.17.2
• Enhanced UI labels for server configuration.

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.3.1 of the Splunk Add-on for JMX fixes the following issues. If no issues appear in this section, no issues have yet been reported:

Known issues

Version 5.3.1 of the Splunk Add-on for JMX has the following reported known issues. If no issues appear in this section, no issues have yet been reported:

Version 5.2.2

The JMX add-on log4j library was updated to version 2.16 in December 2021. Since then log4j has released version 2.17.1 which addresses additional vulnerabilities. These vulnerabilities are defined as moderate severity and the add-on does not use the affected code path. However, this add-on will be updated to the recommended version of 2.17.1 in an upcoming release.

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

Compatibility

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

Component	Description
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

Note

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.2 of the Splunk Add-on for Java Management Extensions has the following new features:

• Upgraded the log4j library from version 2.15.0 to 2.16.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.2 of the Splunk Add-on for JMX fixes the following issues. If no issues appear in this section, no issues have yet been reported:

Known issues

Version 5.2.2 of the Splunk Add-on for JMX has the following reported known issues. If no issues appear in this section, no issues have yet been reported:

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.

Component	Description
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

Note

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 in this section, 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 in this section, no issues have yet been reported:

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.

Component	Description
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

Note

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 in this section, 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 in this section, no issues have yet been reported:

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.

Component	Description
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

Note

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 in this section, 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 in this section, no issues have yet been reported:

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.

Component	Description
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

Note

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 in this section, no issues have yet been reported:

Known issues

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

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.

Component	Description
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

Note

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:

Known issues

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

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.

Component	Description
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:

Known issues

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

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.

Component	Description
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:

Known issues

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

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.

Component	Description
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.

Known issues

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

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.

Component	Description
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.

Known issues

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

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.

• Change host from forwarder IP/hostname to data source ip:port or hostname:port and change source from JMX connection string (for example, service:jmx:rmi:///jindi/rmi://127.0.0.1:8888/jmxrmi) to JMX MBean ObjectName (for example, 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.

Known issues

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

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.

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.

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.

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.

Known issues

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

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.

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.

Known issues

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

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.

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.

• Newly Splunk-supported.
• Improved UI.
• New predefined templates provided in the add-on to help users get started defining data collection parameters.
• Users can configure the log level.
• Replaced modular input configuration UI with new interface for configuring tasks and their components.
• Users can import trust certification for connecting to a JMX server with SSL.
• Indexed events mapped to the JVM data model of the Splunk CIM.
• Support for scheduling JMX tasks in the configuration files.
• Support for defining JMX servers in the configuration files.
• Support for one task to pull data from multiple servers using multiple templates.
• Support for configuration under specific app namespaces in the UI.
• Support for management of legacy tasks inherited from previous versions of the add-on in the UI.
• Validation for input fields in the UI.
• When a user updates backend configuration files, the UI is updated automatically.
• When a user updates backend configuration files, affected tasks are automatically refreshed and loaded.
• Support for third-party app’s JMX templates in configuration files and in the UI.
• New UI page for configuring tasks.
• New UI page for configuring templates.
• New UI page for configuring server connection details.
• 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.
• The add-on ships with a set of pre-built panels.
• Backwards compatibility with the Monitoring of Java Virtual Machines with JMX app. |
• 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.