IBM Support

IBM Application Performance Management 8.1.4.0 Interim Fix 18: 8.1.4.0-IBM-APM-SYNTHETIC-PLAYBACK-AGENT-IF0018 Readme

Fix Readme


Abstract

Readme file for Synthetic Playback Agent for IBM Cloud Application Performance Management 8.1.4.0 Interim Fix 18.

Content

Product release 8.1.4
Update name 8.1.4.0-IBM-APM-SYNTHETIC-PLAYBACK-AGENT-IF0018
Fix ID 8.1.4.0-IBM-APM-SYNTHETIC-PLAYBACK-AGENT-IF0018

Download location

When you select fixes, from the following link, ensure that your download options are set to "Include prerequisites and co-requisite fixes."

http://www.ibm.com/support/fixcentral/

Prerequisites and co-requisites

General description 

This fix is an interim fix for the Synthetic Playback Agent provided with the IBM Cloud Application Performance Management family of products version 8.1.4.0.

Platforms and prerequisites 

The Synthetic Playback Agent is supported on the platforms documented here.

Prerequisites for this interim fix 

The interim fix for Synthetic Playback Agent can be applied to any of the following Synthetic Playback Agent versions:

  • 01.00.05.00
  • 01.00.05.01
  • 01.00.05.02
  • 01.00.05.03
  • 01.00.05.05
  • 01.00.05.06
  • 01.00.05.07
  • 01.00.05.08
  • 01.00.05.09
  • 01.00.05.10
  • 01.00.05.11
  • 01.00.05.12
  • 01.00.05.13
  • 01.00.05.14
  • 01.00.05.15
  • 01.00.05.16 
  • 01.00.05.17

These Synthetic Playback Agent versions are provided with the following:

  • IBM Cloud Application Performance Monitoring Advanced Private version 8.1.4.0
  • IBM Cloud Application Performance Monitoring Advanced version 8.1.4.0

Ensure that Synthetic Playback Agent is installed before applying the interim fix.

Known limitations

  • SN agent can support the latest IDE version, but several Selenium IDE commands do not work when used in playbacks on a Synthetic Agent.

  • This table highlights the differences between Selenium IDE 3.12 and SN agent IF18.

    Commands Works on IDE? Works on Synthetic?
    Add selection Yes No
    Answer on next prompt Yes Yes
    Assert Yes Yes
    Assert alert Yes Yes
    Assert checked Yes Yes
    Assert not checked Yes Yes
    Assert confirmation Yes Yes
    Assert editable Yes Yes
    Assert not editable Yes Yes
    Assert element present Yes Yes
    Assert element not present Yes Yes
    Assert prompt Yes Yes
    Assert-selected value Yes Yes
    Assert not selected value Yes Yes
    Assert-selected label Yes Yes
    Assert text Yes Yes
    Assert not text Yes Yes
    Assert title Yes Yes
    Assert value Yes Yes
    Check Yes Yes
    Choose cancel on next Confirmation Yes Yes
    Choose cancel on next prompt Yes Yes
    Choose OK on next confirmation Yes Yes
    Click Yes Yes
    Click at Yes Yes
    Close Yes Yes
    Debugger Yes No
    Do Yes Yes
    Double-click Yes Yes
    Double-click at Yes Yes
    Drag to object Yes Yes
    Echo Yes Yes
    Edit content Yes Yes
    Else Yes Yes
    Else if Yes Yes
    End Yes Yes
    Execute script Yes Yes
    Execute async script Yes Yes
    For each Yes Yes
    If Yes Yes
    Mouse down Yes Yes
    Mouse down at Yes Yes
    Mice move at Yes Yes
    Mouse out Yes Yes
    Mouse over Yes Yes
    Mouse up at Yes Yes
    Open Yes Yes
    Pause Yes Yes
    Remove selection Yes Yes
    Repeat if Yes Yes
    Run Yes No
    Run script Yes Yes
    Select Yes Yes
    Select frame Yes Yes
    Select window Yes Yes
    Send keys Yes Yes
    Set speed Yes Yes
    Set window size Yes Yes
    Store Yes Yes
    Store attribute Yes Yes
    Store JSON Yes No
    Store value Yes Yes
    Store text Yes Yes
    Store title Yes Yes
    Store window handle Yes Yes
    Store XPath count Yes Yes
    Submit Yes Yes
    Times Yes Yes
    Type Yes Yes
    Uncheck Yes Yes
    Verify Yes Yes
    Verify checked Yes Yes
    Verify not checked Yes Yes
    Verify editable Yes Yes
    Verify not editable Yes Yes
    Verify element present Yes Yes
    Verify element not present Yes Yes
    Verify selected value Yes Yes
    Verify not selected value Yes Yes
    Verify selected label Yes Yes
    Verify text Yes Yes
    Verify not text Yes Yes
    Verify title Yes Yes
    Verify value Yes Yes
    Verify selected label Yes Yes
    Wait for element editable Yes Yes
    Wait for element not editable Yes Yes
    Wait for element not present Yes Yes
    Wait for element not visible Yes Yes
    Wait for element present Yes Yes
    Wait for element visible Yes Yes
    WebDriver answer on visible prompt Yes No
    WebDriver choose cancel on visible confirmation Yes No
    WebDriver choose cancel on visible prompt Yes No
    WebDriver choose OK on visible confirmation Yes No
    While Yes Yes

Installation information

Before installation

Ensure that one of the following Synthetic Playback Agent versions are already installed before you apply the interim fix:
  • 01.00.05.00
  • 01.00.05.01
  • 01.00.05.02
  • 01.00.05.03
  • 01.00.05.05
  • 01.00.05.06
  • 01.00.05.07
  • 01.00.05.08
  • 01.00.05.09
  • 01.00.05.10
  • 01.00.05.11
  • 01.00.05.12
  • 01.00.05.13
  • 01.00.05.14
  • 01.00.05.15
  • 01.00.05.16
  • 01.00.05.17
The agent needs to be restarted as part of applying the patch.

Installing

Installing IBM Cloud Application Performance Management Agent update

  1. [Optional] If you configured proxy for Synthetic Playback Agent with the command "/$Candle_Home/lx8266/sn/bin/set_proxy.sh", then you need to back up the "/$Candle_Home/config/.sn.environment" before you apply this patch.
  2. Download the patch bundle from Fix Central: 
    • Download 8.1.4.0-IBM-APM-SYNTHETIC-PLAYBACK-AGENT-XLINUX-IF0018.tar
  3. On each server where Synthetic Playback Agent is already installed, use the command 'firefox -version' to check the version. Check the table below to see the supported list of the Mozilla Firefox ESR.

    Supported Mozilla Firefox ESR version 102.*, 115.*
  4. Stop Synthetic Playback Agent first, then create a folder and unpack the patch bundle to this folder by using the tar utility.
    For example,
    # $Candle_Home/bin/synthetic_playback-agent.sh stop
    # mkdir /tmp/SN-8.1.4-IF18
    # tar xvf 8.1.4.0-IBM-APM-SYNTHETIC-PLAYBACK-AGENT-XLINUX-IF0018.tar -C /tmp/SN-8.1.4-IF18
  5. Change the current directory to the directory that includes this patch.
    For example,
    # cd /tmp/SN-8.1.4-IF18/8.1.4.0-IBM-APM-SYNTHETIC-PLAYBACK-AGENT-XLINUX-IF0018/
  6. Run the apmpatch.sh tool to install this patch:
    For example,
    # ./apmpatch.sh [$Candle_Home]
    Note: If the agent is installed in a non-default directory, then you must provide the [$Candle_Home] parameter. The default $Candle_Home is /opt/ibm/apm/agent.
  7. [Optional] If you want to configure a proxy for your Synthetic Playback Agent, then run the following commands:
    # cd /$Candle_Home/lx8266/sn/bin
    #./set_proxy.sh
    Enter the agent installation path, default path is /opt/ibm/apm/agent
    Agent installation path is /opt/ibm/apm/agent
    Input the number of proxy types:
    1 manual proxy
    2 no proxy
    Select one of the proxy types to configure your Synthetic Playback Agent, input the necessary information to complete the configuration, and then restart the Synthetic Playback Agent to make it effective.
    Note: PACproxy and System proxy are not supported.

Performing the necessary tasks after installation

A successful installation modifies the Synthetic Playback Agent version to 01.00.05.18.

  1. Run the following command to verify that the Synthetic Playback Agent version is 01.00.05.18.
     
    <agent-home>/agent/bin/cinfo -i 
  2. Run the the following command to view the output.
    /usr/bin/firefox -v
    Mozilla Firefox 102.8.0esr

There is a dependency between Synthetic Playback Agent Interim Fix and Cloud APM 8.1.4.0 Server Interim Fix 8 or a later interim fix. It is recommended that you install the latest Cloud APM server interim fix after you update your playback agents so that you can use Selenium .side scripts. 

Uninstalling

This 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, refer to the IBM Application Performance Management guide that is available at the following location:
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 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-SYNTHETIC-PLAYBACK-AGENT-XLINUX-IF0018.tar)= 0996b7a2c4c203cc5b7991d3e6771243efa6a7f206b4600cdbedb42d3085ccf3

Image Contents 

The following files are included in this fix.

  • 8.1.4.0-IBM-APM-SYNTHETIC-PLAYBACK-AGENT-README-IF0018.readme.html - This is a readme file.
  • 8.1.4.0-IBM-APM-SYNTHETIC-PLAYBACK-AGENT-XLINUX-IF0018.tar - For extracting the patch files use the tar utility.
Extracting the bundle (.tar) creates the following directory and patch files:
Note: You can use the tar command to extract the .tar files:
# tar -xvf 8.1.4.0-IBM-APM-SYNTHETIC-PLAYBACK-AGENT-XLINUX-IF0018.tar

8.1.4.0-IBM-APM-SYNTHETIC-PLAYBACK-AGENT-XLINUX-IF0018
|-- apmpatch.sh
|-- patches
|-- patch.properties

New Features

None

List of fixes

The following CVE's are addressed by this interim fix.

  • CVEID: CVE-2020-8908
    Description: Guava could allow a remote authenticated attacker to bypass security restrictions, caused by a temp directory creation vulnerability in com.google.common.io.Files.createTempDir(). By sending a specially crafted request, an attacker could exploit this vulnerability to bypass access restrictions.
    Affected platforms: Google Guava 29.0
    Fix: Upgraded Google Guava to 30.0.
  • CVEID: CVE-2018-10237
    Description: Google Guava is vulnerable to a denial of service, caused by improper eager allocation checks in the AtomicDoubleArray and CompoundOrdering class. By sending specially crafted data, a remote attacker could exploit this vulnerability to cause a denial of service condition.
    Affected platforms: Google Guava 11.0, Google Guava 24.1
    Fix: Upgraded Google Guava to 30.0.

IBM Cloud Application Performance Management Synthetic Playback agent defects: 

None

Enhancements included from earlier interim fixes: 
None

APARs and defects included in earlier interim fixes: 
None

Document change history

Version Date Description of Change
1.0 24 Mar 2023 Initial version
1.1 18 May 2023 Added Firefox 102.9 ESR Support
1.2 16 May 2024 Added Firefox 115.* ESR versions support

[{"Business Unit":{"code":"BU048","label":"IBM Software"},"Product":{"code":"SSVJUL","label":"IBM Application Performance Management"},"ARM Category":[{"code":"a8m500000008b2uAAA","label":"Synthetic Agent"}],"ARM Case Number":"","Platform":[{"code":"PF016","label":"Linux"}],"Version":"8.1.4","Line of Business":{"code":"LOB67","label":"IT Automation \u0026 App Modernization"}}]

Product Synonym

APM

Document Information

Modified date:
21 May 2024

UID

ibm16965798