Upgrade APM Insight Java Agent

Agent versions 5.4 and above

For agent versions 5.4 and above, APM Insight Java agent can be upgraded from server using any of the following ways:

  1. Auto Upgrade
  2. Manual Upgrade
Note: Auto upgrade feature will only work for major version changes in agent. Minor changes will not be covered.

Auto Upgrade

    • You can choose to upgrade to the latest agent version automatically from the web client directly, without the need to download from the website manually.
    • By enabling the Agent Auto-upgrade option, Applications Manager will automatically download the new agent zip file for upgrade when a new agent version is available.
    • By default, this auto-upgrade option is disabled. To enable, navigate to APM tab → Your application → Action → Edit → APM Insight Agent Configuration ProfileEdit, then enable the Agent auto-upgrade option and click Save.

Java agent auto-upgrade in APM Insight

  • After the deployment process is complete, you will be requested to restart your application server. Once the server is restarted, the updated version will come into effect.

Manual Upgrade

  • When a new version of the agent is available, following message will be displayed at the top of the APM Insight details page "The deployed agent version at this instance is 5.4. Update Agent to the latest version 5.5. Refer our release notes."

    Java agent manual upgrade in APM Insight

  • Users can initiate the upgrade process by clicking on Update Agent link in the above said notification. On clicking the Update Agent link, a confirmation dialog will appear to initiate agent update
  • Click on the Yes, continue button to start the agent update. On doing so, the alert message changes to "Agent update will happen shortly...".

    Java agent manual upgrade success in APM Insight

  • After a few minutes, either on page refresh or on navigating to other tabs, the alert message will be modified.
  • On successful download of the agent, the alert message changes to "Agent downloaded successfully. Please restart your application". Once the server is restarted, the updated version will come into effect.
  • If an error occurs during the agent update, then the message changes to "Problem encountered during agent update. View details.". On clicking the View Details link, the error message will be displayed with options to continue or cancel.

    Note: The Re-initiate option will clear the upgrade status in the cache and immediately try to perform agent update, so message gets modified to "Agent update will happen shortly..." again.

    Java agent auto-upgrade in APM Insight

Agent versions below 5.4

For agent versions below 5.4, APM Insight Java agent can be upgraded by following the steps given below:

  • Download the latest APM Insight Java Agent (apminsight-javaagent.zip) file.
  • Extract the zip file to a new directory to find agent jars (apminsight-javaagent.jar and apminsight-javaagent-api.jar) and its configuration files.
  • Navigate to the directory where you have deployed the APM Insight Java Agent in your Application Server.
  • Take a backup of your old apminsight-javaagent.jar and apminsight-javaagent-api.jar in the directory. Then replace them with the new one.
  • Restart the target Application server.

1. Customers upgrading to Applications Manager 14440 or above must upgrade their Java agent to version 4.x or above.
2. While upgrading Java Agent from version 2.x to 4.x or above, the following keys in apminsight.conf file needs to be updated:
          a. license.key value from Applications Manager web client APM tab > Help Card > License Key needs to be added.
          b. apm.host value needs to be changed to https://<appmanager_host>:<ssl_port> or http://<appmanager_host>:<http_port> after upgrade.

Example 1:

Example 2:

Visit Configuration Guide page for more details.