IBM Support

IBM Application Performance Management 8.1.4.0 8.1.4.0-IBM-APM-SYNTHETIC-PLAYBACK-AGENT-IF0010 Readme

Fix Readme


Abstract

Readme file for: Synthetic Playback Agent for IBM Cloud Application Performance Management 8.1.4.0 Interim Fix 10
Product/Component Release: 8.1.4
Update Name: 8.1.4.0-IBM-APM-SYNTHETIC-PLAYBACK-AGENT-IF0010
Fix ID: 8.1.4.0-IBM-APM-SYNTHETIC-PLAYBACK-AGENT-IF0010
Publication Date: 26 Nov 2019
Last modified date: 26 Nov 2019

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

IMPORTANT NOTE: To download this update, you must first login to IBM Fix Central using the link below . Once logged in, you may select from the individual download packages. When selecting fixes, ensure your download options are set to "Include requisites: Yes". 
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.  


It includes fixes for the Synthetic Playback Agent and upgrades the agent  from version 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 or 01.00.05.09 to 01.00.05.10

The Synthetic Playback Agent must already be installed before you can apply this interim fix.

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 the Synthetic Playback Agent version 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 which is provided with:

IBM Cloud Application Performance Monitoring Base Private, Version 8.1.4.0
IBM Cloud Application Performance Monitoring Advanced Private, Version 8.1.4.0.

IBM Cloud Application Performance Monitoring Base, Version 8.1.4.0
IBM Cloud Application Performance Monitoring Advanced, Version 8.1.4.0.

Known issues

None

Known limitations

  • The Selenium IDE commands are not very consistent with them on SN IF10, so some of the commands can work well on IDE but can't be supported on SN IF10

  • Here is the table of comparison for commands between IDE 3.12 and SN IF10

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
vefify 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

The Synthetic Playback Agent version 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 or 01.00.05.09 must be installed before applying the interim fix. 

The agent is restarted as part of applying the patch.

Installing

Installing the IBM Cloud Application Performance Management Server update 
 

  1. [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.
  2. Download the patch bundle from Fix Central: 
    • Download 8.1.4.0-IBM-APM-SYNTHETIC-PLAYBACK-AGENT-XLINUX-IF0010.tar
  3. Use the command `firefox -version` to check the version. If the version is  not  68.2.0 ESR, update Firefox to version 68.2.0 ESR.  Versions other than 68.2.0 ESR  are not supported.

  4. Unpack the patch bundle on each computer system where the data collector is already installed by using the tar utility
  5. Enter the created directory
  6. Please stop agent instances first, then run the apmpatch.sh tool: 
    Run the apmpatch.sh script to apply the patch:

    Linux:
    ./apmpatch.sh [<APM agent install directory>] 


    Notes: the <APM agent install directory> parameter only needs to be provided if the agent is installed in a non-default directory.
  7. [Optional] If you want to configure proxy for your sn agent, please run below commands:
    # cd /$Candle_Home/lx8266/sn/bin
    #./set_proxy.sh
    please 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.10


Run the <agent-home>/agent/bin/cinfo -i command and verify that the km agent version is 01.00.05.10

Run the command /opt/firefox/firefox -v get below output:

Mozilla Firefox 68.2.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 1 (SHA1) checksum of the image is as follows:
SHA1(8.1.4.0-IBM-APM-SYNTHETIC-PLAYBACK-AGENT-XLINUX-IF0010.tar)= 2b97b87f1ef04625f6a174aa0b72ef221edb7d10a7035171481c471763eb81db

Image Contents 


he following files implement this fix.
- 8.1.4.0-IBM-APM-SYNTHETIC-PLAYBACK-AGENT-README-IF0010.readme.html - This README file

- 8.1.4.0-IBM-APM-SYNTHETIC-PLAYBACK-AGENT-XLINUX-IF0010.tar - For extracting patch files use the tar utility.

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

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

New Features
Support proxy with user / password
Support playback by Firefox 68.2.0 ESR

List of fixes

The following problems are addressed by this interim fix.

APARs

None

IBM Cloud Application Performance Management Synthetic Playback agent defects: 

None

Enhancements included from previous interim fixes: 
None

APARs and defects included in previous interim fixes: 

Document change history

Version Date Description of change
1.0 26 Nov 2019 Initial Version

[{"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Product":{"code":"SSVJUL","label":"IBM Application Performance Management"},"Component":"","Platform":[{"code":"PF016","label":"Linux"}],"Version":"8.1.4","Edition":"","Line of Business":{"code":"LOB45","label":"Automation"}}]

Document Information

Modified date:
26 November 2019

UID

ibm11110111