IBM Application Performance Management 8.1.4.0 8.1.4.0-IBM-APM-RUBY-AGENT-IF0001 Readme

IMPORTANT NOTE: To download this update, you must first login to IBM Fix Central. 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/

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

General description
This is an interim fix for the Ruby Agent provided with IBM Cloud Application Performance Management family of products, Version 8.1.4.0.
It includes fixes for the Ruby Agent and upgrades the data collector from version 01.00.13.00 to 01.00.13.01.
The files for previous Ruby Agent must exist before you can apply this patch.

Platforms and prerequisites
The Ruby Agent is supported on the platforms documented here.

The interim fix for the Ruby Agent is intended to be applied to the Ruby Agent version 01.00.13.00 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.

None

None

Prior to installation

The Ruby Agent version 01.00.12.00 must be installed before applying the interim fix.
The files for previous Ruby data collector must exist before you can apply this patch.

Installing

Installing the interim fix

1. Download the patch bundle from Fix Central:
   
   • Download 8.1.4.0-IBM-APM-RUBY-AGENT-XLINUX-IF0001.tar
     
   
   
2. In <agent_home>/lx8266/km/bin folder, Run:
   Linux:
   ./uninstall.sh
3. Unpack the patch bundle on each computer system where the data collector is already installed by using the tar utility on Linux.
   
   e.g.
   
   tar -xf 8.1.4.0-IBM-APM-RUBY-AGENT-XLINUX-IF0001.tar
   
   
4. Enter the created directory
   
   
5. 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 on Linux/AIX.
   
   
6. If you didn't configure agent before you install the patch, in <agent-home>/agent/bin folder, configure Ruby Agent with:
   
   Linux:
   ./ruby-agent.sh config
7. In <agent-home>/agent/bin folder, start Ruby Agent with:
   Linux:
   ./ruby-agent.sh start
8. Restart previously monitored Ruby applications.
9. If you didn't configure data collector before you install the patch, please install & configure data collector following installation guide and go to next step 8. For details, please refer to https://www.ibm.com/support/knowledgecenter/SSHLNR_8.1.4/com.ibm.pm.doc…
10. If you configured data collector before you install the patch, following the below steps to update data collector:
    1. stop all you configured ruby applications
    2. Uninstall data collector with command ' gem uninstall stacktracer'
    3. go into folder <agent home>/lx8266/km/bin, and run below command to install new data collector:
       gem install --local stacktracer-<version>.gem
       
    4. Go into folder <agent home>/install-images/kkm/dchome if it existed, and there will be a subfolder named with application name for every configured ruby application. For every subfolder, go into this subfolder and then go into subfolder 'config' to edit config file 'instrumenter_settings.rb'; In the config file, set item ':include_sql_text' to the value as what you want; If it's set to 'true' currently, and you need to set it to 'false' in case you don't want to collect sensitive information.
    5. start all you configured ruby applications again.
11. In <agent-home>/agent/bin folder, start ruby Agent with: Linux:
    ./ruby-agent.sh start
    
12. Restart previously monitored ruby applications.

Performing the necessary tasks after installation of the interim fix

A successful installation modifies the Ruby Agent version to 01.00.12.01.
Run the <agent-home>/agent/bin/cinfo -i command and verify that the km agent version is 01.00.12.01

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

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

The Secure Hash Algorithm 1 (SHA1) checksum of the image is as follows:
SHA1(8.1.4.0-IBM-APM-RUBY-AGENT-XLINUX-IF0001.tar)= f026d06693115e32b113039ae1424f6f3bece3ef

Image Contents
The following files implement this fix.
- 8.1.4.0-IBM-APM-RUBY-AGENT-README-IF0001.readme.html - This README file

- 8.1.4.0-IBM-APM-RUBY-AGENT-XLINUX-IF0001.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-RUBY-AGENT-XLINUX-IF0001/
|-- apmpatch.sh
|-- patches
|-- patch.properties

New Features

The following changes are included in Ruby Agent interim fix:

• None

The following problems are addressed by this interim fix.

APARs

• None

• None
  

• 131548 protect user's personal sensitive information
  

• None