Upgrading the Unified Agent

If you have the old version of Unified Agent installed, you can directly install the new version to upgrade.

Procedure

  1. Download the Unified Agent installation image unifiedAgent_2.2.tar.gz from PPA. For more information about Part Numbers, see Passport Advantage part numbers.

  2. Extract the installation packages to get the directory of installUA.sh.

    1. Run the following command:
      tar -zxvf unifiedAgent_2.3.tar.gz
cd unifiedAgent_2.3
    2. You can find the following three packages in the unifiedAgent_2.3 directory: 
      ua-traditional-monitoring-plinuxle.tar.gz
ua-traditional-monitoring-aix.tar.gz
ua-traditional-monitoring-xlinux.tar.gz
    3. Extract the package based on the platform where you want to install, for example, on xLinux platform, extract ua-traditional-monitoring-xlinux.tar.gz:
      tar -zxvf ua-traditional-monitoring-xlinux.tar.gz
cd ua-traditional-monitoring-xlinux

  3. Download the agent configuration package:

    1. Go to Administer > Monitoring > Integrations on IBM Cloud Pak console.
    2. Click the New integration button.
    3. In the Standard monitoring agents section, click the Configure button of Monitoring Data Collectors.
    4. Click Download file and specify the directory where you put the installUA.sh file. The ibm-cloud-apm-dc-configpack.tar file is downloaded to the same directory of installUA.sh.

  4. Run the installation script: 

    ./installUA.sh

  5. Follow the prompts to complete installation.

    1. Specify which plug-ins to install. To integrate runtime data collectors, you must install both LWDC plug-in and OpenTracing plug-in.
    2. Confirm your selection.
    3. Enter the directory where you want to install the plug-ins. By default, it is /opt/ibm/apm/ua.
    4. When you are asked whether you accept the license agreement, enter 1 to accept the agreement and continue, or enter 2 to decline.
    5. Older version is detected. Confirm to continue.

  6. When installation completes, the selected plug-ins are installed. The installation log file is <install_dir>/log/IBMCP4MCMUA_Agents_install_install_date-time.log, for example, opt/ibm/apm/ua/log/IBMCP4MCMUA_Agents_install_20200601-072052.log. The configuration settings of the old version are backed up in the directory of ${UA_HOME}/confbak, for example, /opt/ibm/apm/ua/confbak.

  7. Go to the bin directory where the Unified Agent is installed. By default, it is /opt/ibm/apm/ua/bin. Do the following steps to configure plug-ins:

    • To configure HMC plug-in, do the following steps:

      1. Run ./setup-hmc.sh.
        Note: If you want to see the usage of the script, run ./setup-hmc.sh -h.
      2. Enter the hostname or IP address of the HMC to monitor.
      3. Enter the name of the HMC user.
      4. Enter the password of the HMC user.

    • To configure Kafka plug-in, do the following steps:

      1. Run ./setup-kafka.sh.
      2. Configure the settings when prompted.
      3. Confirm whether the version of Apache Kafka and ZooKeeper is greater than or equal to 0.11.0.0 and 3.4.0. Enter 1 for yes, and 2 for no. By default, it is 1.
      4. Confirm whether your Apache Kafka brokers have configured Jolokia agents. Enter 1 for yes, and 2 for no. By default, it is 1.
        Note: If you do not have Jolokia agents configured for Kafka brokers, see the Enabling Jolokia for Apache Kafka brokers.
      5. Enter a comma-separated list of Apache ZooKeeper servers to monitor, for example, zk1:2181,zk2:2181,zk3:2181.
      6. Assign a name to the ZooKeeper ensemble, for example, zk4cluster1.
      7. Enter a comma-separated list of Apache Kafka brokers to monitor. It can be automatically discovered. Press Enter to accept the discovered list. If not, manually enter your own list.
      8. Enter a comma-separated list of Jolokia agents to monitor Apache Kafka. It can be automatically discovered. Press Enter to accept the discovered list. If not, manually enter your own list.
      9. Assign a name to the Kafka cluster, for example, cluster1.
    • To configure LWDC plug-in, do the following steps:
      1. Run `./setup-lwdc.sh.
      2. Configure the listening port, by default, it is 8848.
    • To configure OpenTracing plug-in, do the following steps:
      1. Run ./setup-opentracing.sh.
      2. Configure the listening port for Zipkin. By default, it is 9411.
      3. Configure the listening port for Jaeger. By default, it is 14268.

  8. Start the Unified Agent:

    ./start-agent.sh

    After you configure and start the Unified Agent, view the data that the agent is collecting from the IBM Cloud Pak console.