IBM Support

Internet Service Monitoring Agent for IBM Application Performance Management 8.1.4.0 Interim Fix 1 Readme

Fix Readme


Abstract

Readme file for: Internet Service Monitoring Agent for IBM Application Performance Management 8.1.4.0 Interim Fix 1
Product/Component Release: 8.1.4.0
Update Name: 8.1.4.0-IBM-APM-ISM-AGENT-IF0001
Fix ID: 8.1.4.0-IBM-APM-ISM-AGENT-IF0001
Publication Date: 13 January 2022
Last modified date: 12 January 2022

Content

Download location
Prerequisites and co-requisites
Known issues
Known limitations
Installation information
Installing
Troubleshooting installation problems from the Support site
Additional information
New Features
List of fixes
Document change history

Download location

1. To download this update, you must first log in to IBM Fix Central (http://www.ibm.com/support/fixcentral/).

2. There are three download options on Fix Central: Download Director, FTPS/SFTP, and Using your browser (HTTPS). If you want to download individual packages, you need to choose FTPS/SFTP or HTTPS, since Download Director will download all. 

Below is a list of components, platforms, and file names that apply to this Readme file.

Product / Component Name Platform Fix
IBM Application Performance Management Internet Service Monitoring Agent Linux x86_64
Windows

  

Prerequisites and co-requisites

General description 

This is an interim fix for the Monitoring agent for Internet Service Monitoring, provided with IBM Application Performance Management family of products, Version 8.1.4.0.
This interim fix upgrades the Internet Service Monitoring agent version to 08.22.01.00.
It provides the fix for vulnerability reported against Log4j library under CVE-2021-4104. As a part of solution log4j has been upgraded to version 2.17.0.

Platforms and prerequisites 

The Monitoring Agent for Internet Service Monitoring is supported on the platforms documented. here.

The interim fix for the Internet Service Monitoring agent is intended to be applied to the Monitoring Agent for Internet Service Monitoring version 08.20.12.00.

If you have an older version of ISM agent installed currently, then first you need to upgrade it to version 08.20.12.00.

Internet Service Monitoring version 08.20.12.00 is provided with:
IBM Cloud Application Performance Monitoring Base Extension, Version 8.1.4.0.14 or 8.1.4.0.15 or 8.1.4.0.16 or 8.1.4.0.17

Known issues

None

Known limitations

None

Installation information

Prior to installation

The Internet Service Monitoring agent version 08.20.12.00 must be installed before applying the agent interim fix.
Stop the Internet Service Monitoring agent before starting installation.

a. Run command prompt in administrator or root mode and go to

    Windows: "<APM agent install directory>\APM\bin"

    Linux: "<APM agent install directory>/apm/agent/bin"

b. To stop ISM agent, run command

   Windows: "ism-agent.bat stop"

   Linux: "./ism-agent.sh stop"

  

Installing

Installing the agent interim fix

  1. Download the patch bundle from Fix Central for each OS type where your agent is installed: 
    • If the agent is installed on Linux x86_64, download 8.1.4.0-IBM-APM-ISM-AGENT-XLINUX-IF0001.tar
    • If the agent is installed on Windows, download 8.1.4.0-IBM-APM-ISM-AGENT-WIN64-IF0001.zip
  2. Unpack the patch bundle on each computer system where the agent is already installed by using the tar utility on Linux or unzip on Windows.
  3. e.g., tar -xf 8.1.4.0-IBM-APM-ISM-AGENT-XLINUX-IF0001.tar
  4. Enter the created directory 
  5. Run the apmpatch.sh/bat tool as the same user who installed the agent: 

    Linux:
    ./apmpatch.sh [<APM-AGENT-HOME>] 

    Windows:
    apmpatch.bat <APM-AGENT-HOME> 

    Where the <APM-AGENT-HOME> value specifies the directory where the agent is installed. This value is a required parameter for Windows. However, for Linux, it needs to be provided only if the agent is not installed in default directory.
 

Performing the necessary tasks after installation

A successful installation modifies the Internet Service Monitoring agent version to 08.22.01.00.

On Linux:
- Ensure that the <APM-AGENT-HOME>/bin/cinfo -t output for the Monitoring Agent for Internet Service Monitoring is '08.22.01.00'.
- The agent interim fix installation logs are written to the "<APM-AGENT-HOME>/logs/" directory.
- Ensure that the log4j2.properties file is created on ISM agent host at given location: $ISMHOME/etc/props

On Windows:
- Ensure that version number 08.22.01.00 is displayed for the Monitoring Agent for Internet Service Monitoring on the Performance Management window.
- The agent interim fix installation logs are written to the "<APM-AGENT-HOME>\INSTALLITM\" directory.
- Ensure that the log4j2.properties file is created on ISM agent host at given location: %ISMHOME%\etc\props

APM Server:
- For this new change to take effect create at least one new ISM profile and deploy it.
- Ensure that the log4j2.properties file is created on APM server at given location: <install_dir>/wlp/usr/servers/min/dropins/CentralConfigurationServer.war/data_source/is (Default value of install_dir is /opt/ibm)

Note
- If you want to change log level for ISMBATCH utility or APM server side utility, refer "log4j2.properties" file.
- After upgrading the agent, you also see old log4j files present in installation directory, but it doesn't have any impact (you can manually delete those files)
Old log4j files location:
Agent Host:
Linux - 
$ISMHOME/etc/props/log4j.properties, 
$ISMHOME/platform/linux2x86_64/bin/apache-log4j-1.2.15.jar
Windows - 
%ISMHOME%\etc\props\log4j.properties, 
%ISMHOME%\platform\win64\bin\log4j-1.2.8.jar
APM Server:
<install_dir>/wlp/usr/servers/min/dropins/CentralConfigurationServer.war/data_source/is/log4j.properties

Uninstalling if necessary

This agent maintenance package cannot be rolled back. If necessary, you can uninstall and reinstall the monitoring agent and patches.

For detailed instructions to uninstall monitoring agents, please refer to the IBM Performance Management guide, here: 
http://www.ibm.com/support/knowledgecenter/SSHLNR_8.1.4/com.ibm.pm.doc/install/uninstall_agents.htm 

Troubleshooting installation problems from the Support site

For more detailed information, refer to the Troubleshooting and support Guide: 
http://www.ibm.com/support/knowledgecenter/SSHLNR_8.1.4/com.ibm.pm.doc/install/trouble_intro.htm 

Additional information

The Secure Hash Algorithm 256 (SHA256) checksum of the image is as follows:

SHA256(8.1.4.0-IBM-APM-ISM-AGENT-XLINUX-IF0001.tar)=eef2330f4a8dac52d9d39661ea7b12fa10420e1d8de959690413830110715dc8

SHA256(8.1.4.0-IBM-APM-ISM-AGENT-WIN64-IF0001.zip)=c43bd78aa34711fad5a3d2e6b89c152428987788252862e2d54b8b36afa2a9aa

Image Contents 

The following files implement this fix:

- 8.1.4.0-IBM-APM-ISM-AGENT-IF0001.readme.html - This README file
 
- 8.1.4.0-IBM-APM-ISM-AGENT-XLINUX-IF0001.tar - For extracting patch files use the tar utility.

Extracting the linux bundle (.tar) creates the following directory and patch files:

8.1.4.0-IBM-APM-ISM-AGENT-XLINUX-IF0001/
|-- apmpatch.sh
|-- patches
|-- patch.properties
 
- 8.1.4.0-IBM-APM-ISM-AGENT-WIN64-IF0001.zip - For extracting patch files use the tar utility.

Extracting the windows bundle (.zip) creates the following directory and patch files:

8.1.4.0-IBM-APM-ISM-AGENT-WIN64-IF0001/
|-- apmpatch.bat
|-- patches
|-- patch.properties
 

New Features

List of fixes

The following problems are addressed by this interim fix.

Security Fix 
  • Fix provided for Log4j CVE-2021-4104 vulnerability.
APARs 
  • None
 
Agent defects: 
  • None

Enhancements included from previous interim fixes: 

APARs and defects included in previous interim fixes: 
  • APARs
  • Agent defects

Document change history

Version Date Description of change
1.0 13 Jan 2022 Initial Version

[{"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SSVJUL","label":"IBM Application Performance Management"},"Component":"","Platform":[{"code":"PF016","label":"Linux"},{"code":"PF033","label":"Windows"}],"Version":"8.1.4.0","Edition":"","Line of Business":{"code":"LOB45","label":"Automation"}}]

Document Information

Modified date:
14 January 2022

UID

ibm16537764