Fix Readme
Abstract
Readme file for: Synthetic Playback Agent for IBM Cloud Application Performance Management 8.1.4.0 Interim Fix 11
Product/Component Release: 8.1.4
Update Name: 8.1.4.0-IBM-APM-SYNTHETIC-PLAYBACK-AGENT-IF0011
Fix ID: 8.1.4.0-IBM-APM-SYNTHETIC-PLAYBACK-AGENT-IF0011
Publication Date: 28 Feb 2020
Last modified date: 28 Feb 2020
Content
Download location
When selecting fixes, ensure your download options are set to "Include prerequisites and co-requisite fixes."
http://www.ibm.com/support/fixcentral/
Fix Download for Linux
Below is a list of components, platforms, and file names that apply to this Readme file.
| Product / Component Name | Platform | Fix |
| IBM Cloud APM Synthetic Playback agent | Linux x86_64 |
Prerequisites and co-requisites
General description
This is an interim fix for the Synthetic Playback Agent provided with 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 the Synthetic Playback Agent is intended to be applied to one 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
These Synthetic Playback Agent versions are provided with:
IBM Cloud Application Performance Monitoring Advanced Private, Version 8.1.4.0.
IBM Cloud Application Performance Monitoring Advanced, Version 8.1.4.0.
The Synthetic Playback Agent must already be installed before you can apply this interim fix.
Known issues
Sometimes the geckodriver link is not created automatically after upgrade to IF11. As a workaround, you need to create this link manually. We will fix this issue in next release.
Problem description:
In the ksn_trace0.log, you will see the following error:
com.ibm.csi.apm.synthetics.playback.selenium.SeleniumPlaybackService.getFirefoxDriver() - The driver executable does not exist: /usr/bin/geckodriver - The driver executable does not exist: /usr/bin/geckodriver
Workaround:
1. Check if the geckodriver link is created successfully. The link should look something like the following:
# ls -ltr /usr/bin/geckodriver
lrwxrwxrwx 1 root root 49 Mar 17 04:34 /usr/bin/geckodriver -> /opt/ibm/apm/agent/lx8266/sn/bin/geckodriver
2. If there is no geckodriver link on the env, then create it manually:
For example:
# ln -s /opt/ibm/apm/agent/lx8266/sn/bin/geckodriver /usr/bin/geckodriver
Known limitations
-
SN agent can support latest IDE version, but several Selenium IDE commands will not work when used in playbacks on a Synthetic Agent.
-
This table highlights the differences between Selenium IDE 3.12 and SN agent IF11.
| Commands | Work on IDE ? | Work 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 and drop 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 |
| mouse 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 anwser 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
Prior to installation
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
The agent needs to be restarted as part of applying the patch.
Installing
Installing the IBM Cloud Application Performance Management Agent update
- [Optional] If you configured proxy for sn agent with command "/$Candle_Home/lx8266/sn/bin/set_proxy.sh", then you need to backup the "/$Candle_Home/config/.sn.environment" before you apply this patch.
- Download the patch bundle from Fix Central:
- Download 8.1.4.0-IBM-APM-SYNTHETIC-PLAYBACK-AGENT-XLINUX-IF0011.tar
-
On each server where Synthetic Playback Agent is already installed, use the command `firefox -version` to check the version. If the version is not 68.5.0 ESR, update Firefox to version 68.5.0 ESR. Versions other than 68.5.0 ESR are not supported.
- Stop SN agent firstly, then create a folder and unpack the patch bundle to this folder using the tar utility.
For example:
# $Candle_Home/bin/synthetic_playback-agent.sh stop
# mkdir /tmp/SN-8.1.4-IF11
# tar xvf 8.1.4.0-IBM-APM-SYNTHETIC-PLAYBACK-AGENT-XLINUX-IF0011.tar -C /tmp/SN-8.1.4-IF11 - Change the current directory to the directory that includes this patch.
For example:
# cd /tmp/SN-8.1.4-IF11/8.1.4.0-IBM-APM-SYNTHETIC-PLAYBACK-AGENT-XLINUX-IF0011/ - Run the apmpatch.sh tool to install this patch:
For example:
# ./apmpatch.sh [$Candle_Home]
Notes:
The [$Candole_Home] parameter only needs to be provided if the agent is installed in a non-default directory.
The default $Candle_Home is /opt/ibm/apm/agent - [Optional] If you want to configure proxy for your sn agent, please run below commands:
# cd /$Candle_Home/lx8266/sn/bin
#./set_proxy.shplease input the agent install path, default is (/opt/ibm/apm/agent)agent install path is:/opt/ibm/apm/agent
please input the number of proxy type:
1 system proxy
2 manual proxy
3 pac proxy
4 no proxy
Select one of the proxy type to configure for your sn agent, input the necessary information to complete the configuration, then restart sn agent to make it effective.
Performing the necessary tasks after installation
A successful installation modifies the Synthetic Playback Agent version to 01.00.05.11
Run the <agent-home>/agent/bin/cinfo -i command and verify that the sn agent version is 01.00.05.11
Run the command /opt/firefox/firefox -v get below output:
Mozilla Firefox 68.5.0esr
There is a dependency between the Synthetic Playback agent interim fix and the 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 if necessary
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, please refer to the IBM Application 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-SYNTHETIC-PLAYBACK-AGENT-XLINUX-IF0011.tar)= cb5102334bf22f237da44c709898a4d365ebe2ae221f8a326f879825c1a0b38c
Image Contents
The following files implement this fix.
- 8.1.4.0-IBM-APM-SYNTHETIC-PLAYBACK-AGENT-README-IF0011.readme.html - This README file
- 8.1.4.0-IBM-APM-SYNTHETIC-PLAYBACK-AGENT-XLINUX-IF0011.tar - For extracting patch files use the tar utility.
Extracting the above bundle (.tar) creates the following directory and patch files:
Note: you can use tar command to extract the .tar file:
# tar -xvf 8.1.4.0-IBM-APM-SYNTHETIC-PLAYBACK-AGENT-XLINUX-IF0011.tar
8.1.4.0-IBM-APM-SYNTHETIC-PLAYBACK-AGENT-XLINUX-IF0011/
|-- apmpatch.sh
|-- patches
|-- patch.properties
New Features
CVE-2019-17008
CVE-2019-17010
CVE-2019-17012
CVE-2019-17017
CVE-2019-17022
CVE-2019-17024
List of fixes
The following problems are addressed by this interim fix.
APARs
None
IBM Cloud Application Performance Management Synthetic Playback agent defects:
NoneEnhancements included from previous interim fixes:
APARs and defects included in previous interim fixes:
Document change history
| Version | Date | Description of change |
| 1.0 | 28 Feb 2020 | Initial Version |
| 2.0 | 11 Apr 2020 | Revised Version |
Was this topic helpful?
Document Information
Modified date:
13 April 2020
UID
ibm13848247