Skip to main content

Update and Uninstall

The Platform Capability Center supports online automatic batch upgrade and uninstallation of Agents. For business scenarios with a large number of instances, you can easily deploy a massive number of Agents in the console with a single click, and you can also freely perform gray releases of new Agents.

Online Update and Uninstall​

Scenarios Not Supported for Online Update/Uninstall​

  • Application instances deployed in Docker do not support automatic update or uninstall.
  • If different JVM instances share the same Agent, these instances do not support update or uninstall.
  • Update and uninstall operations require file write permissions. If the Agent instance does not have file write permissions, update and uninstall are not supported.
  • Offline instances do not support update or uninstall.

For Agent instances that do not support online update, the Update link will be grayed out. When you hover the mouse over the Update link, the reason for not supporting online update will be displayed.

Online Update​

Note: For 3.0 Agents, only online upgrade to a higher version is supported; downgrade to a lower version is not supported.

To update the Agent for a specified instance online, follow these steps:

  1. In the left navigation bar, click Configuration > Agent Management > Agent Management to enter the Agent Management page.

  2. Click the Update link after the specified instance to open the Instance Update dialog box.

    • The left panel displays the Agents to be updated, selected by default.

    • The right panel lists the available Agent versions for update, all unselected by default.

    • Supports updating to any Agent version.

    • Supports uploading a new Agent locally, so you can update to the newly uploaded Agent version.

      When uploading a new Agent locally, you need to enter the MD5 value and upload the Agent package. You can add files by dragging or by clicking the Upload File button. After uploading, the system will calculate the MD5 of the file and compare it with the entered MD5 value. If the check fails, "MD5 verification failed" will be prompted. If the upload fails, retry or cancel is supported. After a successful upload, the Agent information will be displayed in the Agent list.

  3. After selecting the Agent version, click the Update button. The update status will change to Updating.

  4. After about 1 to 3 minutes (may take longer depending on network speed), the update status changes to Updated, Pending Restart. At this time, a folder named Backup will be generated in the Agent installation directory to back up the previous version of the Agent.

  5. Restart the application server.

    • If the update process is successful, the update status changes to Update Successful.

    • If the update process fails, the update status changes to Update Failed.

      Click the update record button to view the update process and specific failure information.

Batch Update​

To update Agents in batch online, follow these steps:

  1. In the left navigation bar, click Configuration > Agent Management > Agent Management to enter the Agent Management page.

  2. After checking the checkboxes in front of multiple instances, click the Batch Update button in the upper right corner to open the Batch Update dialog box.

    • The left panel displays the application instances to be updated, selected by default.

    • The right panel lists the available Agent versions for update, all unselected by default.

    • Supports updating to any Agent version.

    • Supports uploading a new Agent locally, so you can update to the newly uploaded Agent version.

      When uploading a new Agent locally, you need to enter the MD5 value and upload the Agent package. You can add files by dragging or by clicking the Upload File button. After uploading, the system will calculate the MD5 of the file and compare it with the entered MD5 value. If the check fails, "MD5 verification failed" will be prompted. If the upload fails, retry or cancel is supported. After a successful upload, the Agent information will be displayed in the Agent list.

  3. After selecting the Agent version, click the Update button. The update status will change to Updating.

  4. After about 1 to 3 minutes (may take longer depending on network speed), the update status changes to Updated, Pending Restart.

  5. Restart the application server.

    • If the update process is successful, the update status changes to Update Successful.

    • If the update process fails, the update status changes to Update Failed.

      Click the update record button to view the update process and specific failure information.

Online Uninstall​

To uninstall the Agent for a specified instance online, follow these steps:

  1. In the left navigation bar, click Configuration > Agent Management > Agent Management to enter the Agent Management page.

  2. Click the Uninstall link after the specified instance to open the Instance Uninstall dialog box.

  3. Click the Confirm button. The status will change to Uninstalling.

  4. After uninstallation is complete, the update status displays Uninstalled, Pending Restart.

  5. Restart the application server.

After the application instance restarts, the information for this instance will no longer appear in the list after 30 minutes.

Batch Uninstall​

To uninstall Agents in batch online, follow these steps:

  1. In the left navigation bar, click Configuration > Agent Management > Agent Management to enter the Agent Management page.

  2. After checking the checkboxes in front of multiple instances, click the Batch Uninstall button in the upper right corner to open the Batch Uninstall dialog box.

    • The left panel displays the selected instances to be uninstalled, selected by default. If deselected, the Agent will not be uninstalled.
    • The right panel lists the business system and application information corresponding to the instances.

  3. Click the Uninstall button. The update status will change to Uninstalling.

  4. After uninstallation is complete, the update status displays Uninstalled, Pending Restart.

  5. Restart the application server.

After the application instance restarts, the information for these instances will no longer appear in the list after 30 minutes.

Manual Update and Uninstall​

Manual Update​

To manually update the Agent, follow these steps:

  1. Stop the application server.

  2. Back up the original tingyun-agent-java.jar file, tingyun-agent-core.jar file, Agent log file tingyun_agent.log, and the extensions folder.

  3. Replace with the new tingyun-agent-java.jar file, tingyun-agent-core.jar file, tingyun.properties configuration file, and extensions folder.

    Note: The Agent installation package includes the tingyun-agent-core.jar file.

  4. Use the backed-up example.xml file to replace the new example.xml file in the extensions directory.

  5. Modify the tingyun.properties configuration file.

    Please refer to the previous configuration file content for modification. Do not copy and replace directly, as the new version of the Agent may add or remove configuration items. Therefore, the file content needs to be compared and modified.

  6. Start the application server.

Manual Uninstall​

  1. Stop the application server.

  2. Remove the -javaagent parameter containing tingyun-agent-java.jar from the container startup script.

  3. Delete the tingyun folder.

  4. Start the application server.