The suite of Change Management Server data collectors are now available through IBM Support Assistant Workbench and IBM Support Assistant Lite for the following Rational products :
- Rational ClearCase v7.1
- Rational ClearQuest v7.1
The set of collectors available are:
- General Change Management Server Collector
- Server Configuration Collector
- Server Processes Trace Collector
Details of what is collected as well as collector walk through is shown below.
Prerequisites / Installation These collectors are available as part of IBM Support Assistant Workbench and IBM Support Assistant Lite in the above listing of Rational products.
IBM Support Assistant IBM Support Assistant (ISA) is a full serviceability workbench that can increases your capacity for self-help by making it easier to access support resources. This includes product information, tools and capability for automated data collection. For more information, see: Features and benefits of IBM Support Assistant.
Prerequisites - You'll need IBM Support Assistant Workbench v4.1.x or higher for this collector to be available.
- If you do not have ISA workbench available, you need an IBM ID and password to download ISA workbench. Register here if you do not already have one.
- A copy of ISA workbench is available for download from the Serviceability Workbench Section in the ISA download page .
Install Add-on - Launch ISA workbench. Use the Update > Find New... > Product Add-on to select one of the products listed above.
- Once you have the product add-on installed, select Collect and Send Data to select and run the available data collectors.
IBM Support Assistant Lite IBM Support Assistant Lite (ISA Lite) is the customized subset of the ISA workbench that provides only the automated data collection capability. If you do not have ISA workbench installed and need to provide information for our support team, you can use this to quickly gather information. For more information, see: Overview of IBM Support Assistant Lite
Prerequisites: - You need an IBM ID and password to download ISA Lite. Register here if you do not already have one.
- You need Java JRE 1.4.2 or greater on your machine to run ISA Lite
Download & Launching ISA Lite: - You can download ISA Lite for Rational ClearCase v7.1 or Rational ClearQuest v7.1 from the Quick Data Collection Section in the ISA download page.
- Extract the .zip file in a folder.
- In the same folder, cd ISALite
- If Java is available in your path , simply run: runISALite.bat or runISALite.sh
- If Java is not available on your path, you'll need to set JAVA_HOME first.
- Windows: set JAVA_HOME=<your full path to Java> This path should point to the bin directory in your Java installation, containing java.exe.
- Linux/Unix (in ksh): export JAVA_HOME=<your full path to Java>. This path should point to the bin directory in your Java installation, containing java
General Change Management Server Collector
Use this data collector to gather information for general issues relating to change management server . This includes change management server configuration, IBM Installation Manager as well as information related to embedded WAS. Its recommended that you run this with administrator privileges.
Data Collected:
- If product is not found :
| Folder | | Description | | / | CC_V71_NOT_AVAILABLE.txt or
CQ_V71_NOT_AVAILABLE.txt | A file to indicate that the collector didn't detect ClearCase / ClearQuest on the machine (via Installation Manager) | - The following is collected only if appropriate product is found through Installation Manager
Change Management Server Configuration Data | Folder | File | Description | | /wsadmin_out |  | | | CC_ISALite-71-export.txt or
CQ_ISALite-71-export.txt | Executes wsadmin command to retrieve cmprofile information.
Sample for Linux:
<product_install>/common/eWAS/bin/wsadmin.sh -profile -profileName cmprofile teamAdminUtils.jacl -c "exportToFile /tmp/export1.txt" | | wsadmin_execution_out.txt | Output from wsadmin execution. | | /dat_files_common_CM_profiles_cmprofile_config_cells | *.dat files | Collect all the *.dat files from:
<product_install>/common/CM/profiles/cmprofile/config/cells/*/stp/*.dat | | /log_files_common_CM_profiles_cmprofile_logs | *.* | Collect all files from:
<product_install>/common/CM/profiles/cmprofile/logs/*.* | WAS information (runs only if <product_install>/eWAS directory was found) | Folder | File | Description | | /WAS_COLLECTION | | | | <system_date>.jar file output. | WAS General Information:
Executes: <product_install>/eWAS/collector.bat (or sh)
To examine this file, change the .jar extension to .zip, and extract. | | versionInfo_Long.txt | WAS Version Information : -long option
Executes: <product_install>/common/eWAS/versionInfo.bat (or sh) -long | | versionInfo_maintaincePackages.txt | WAS Version Information: -maintenancePackages
Executes: <product_install>/common/eWAS/versionInfo.bat (or sh) -maintenancePackages | | versionInfo_components.txt | WAS Version Information: -components
Executes: <product_install>/common/eWAS/versionInfo.bat (or sh) -components | | versionReport.html | WAS Version Report:
Executes: <product_install>/common/eWAS/genVersionReport.bat (or sh) | | historyReport.html | WAS History Report:
Executes: <product_install>/common/eWAS/genHistoryReport.bat (or sh) |
Detailed Walk Thru for "General Change Management Server Collector"
The collector will first inform you what it is going to collect. Click OK, to proceed
The collector will run to completion and request feedback and ftp options.
Please continue to Data Collector Completion Options & Uploads for additional information.
Server Configuration Collector
Use this data collector to gather only change management server configuration information.
Data Collected:
This data collector is a subset of the "General Change Management Server Collector", as it only gathers the Change Management Server Configuration Data as stated above.
Detailed Walk Thru for "General Change Management Server Collector"
The collector will first inform you what it is going to collect. Click OK, to proceed
The collector will run to completion and request feedback and ftp options.
Please continue to Data Collector Completion Options & Uploads for additional information.
Server Processes Trace Collector
Use this data collector to enable process trace on the Change Management Server. User will be prompted to recreate the server issue found, and when completed, to continue with the data collection tool to disable trace settings and gather information.
Trace settings: - File modified: <product_install>/common/CM/bin/tslogger.properties
- Settings to enable trace:
logger.dc.logging=ON
logger.dc.trace.level=DEBUG_MAX - Settings to disable trace:
logger.dc.logging=OFF
logger.dc.trace.level=OFF
IMPORTANT: This collector WILL re-start CM Server twice in order to enable and disable trace settings.
- You'll need appropriate administrator access to run this collector.
- If the trace settings are not disabled, it will impact server performance.
Data Collected
- If product is not found :
| Folder | | Description | | / | CC_V71_NOT_AVAILABLE.txt or
CQ_V71_NOT_AVAILABLE.txt | A file to indicate that the collector didn't detect ClearCase / ClearQuest on the machine (via Installation Manager) | - The following is collected only if appropriate product is found through Installation Manager
| Folder | File | Description | | / | | | | CMServer_StopServer_pre_logging_enable.txt | Output from executing code to stop server.
Executes: :<product_install>/common/eWAS/bin/stopServer.bat (or sh) server1 -profileName cmprofile | | CMServer_StartServer_logging_enable.txt | Output from executing code to start server with trace setting enabled.
Executes: <product_install>/common/eWAS/bin/startserver.sh server1 -profileName cmprofile | | CMServer_StopServer_pre_logging_disable.txt | Output from executing code to stop server.
Executes: :<product_install>/common/eWAS/bin/stopServer.bat (or sh) server1 -profileName cmprofile | | CMServer_StartServer_logging_disable.txt | Output from executing code to start server with trace setting disabled
Executes: <product_install>/common/eWAS/bin/startserver.sh server1 -profileName cmprofile | | /enable_settings | | | | tslogger_enableLogging.properties | Attributes used to updated tslogger.properties file. | | tslogger.properties.<timestamp> | Backup file of the existing tslogger.properties file | | tslogger.properties | New tslogger.properties file. This should have trace enabled. | | /disable_settings | | | | tslogger_disableLogging.properties | Attributes used to disable trace settings in tslogger.properties file | | tslogger.properties | New tslogger.properties file. This should have trace disabled. | | /common_CM_logs_server1/ccrpc [or cqrpc] | | | | SystemOut.log, SystemErr.log | Files from : <product_install>/common/CM/logs/server1/ccrpc [or cqrpc] | | trace.log | Output from the trace enablement. |
Detailed Walk Thru for "Server Processes Trace Collector" Reproducing Problem At this point, recreate the problem you encountered with the CM Server.
Click OK only when you had completed problem recreation.
Once you click OK, the CM Server will be stopped and restarted with trace options disabled. This will also gather trace data.
The collector will run to completion and request feedback and ftp options.
Please continue to Data Collector Completion Options & Uploads for additional information.
Data Collector Completion Options & Uploads When the collector is completed, it will request feedback about ISA or ISA Lite. Select Yes, to provide feedback. Select No to continue.
You'll also be provided with data upload options. This will allow you to send the collected data to IBM or another location via FTP or HTTPS.
IMPORTANT: To upload information to IBM, you'll need to have a PMR number. This is obtained when you work with our support team. If you do not have a PMR number, but do have support contract, you can leverage the Software Support page to open a service request and included the collected data with the service request.
IBM Service Request Page: https://www.ibm.com/support/servicerequest/ The upload options are:
- Send the Logs to IBM using secure transfer (HTTPS). You'll need an PMR number to transfer the data to IBM. This sends the collected data to IBM Support team through the HTTPS protocol.
- FTP the Logs to IBM Support (not encrypted). You'll need an PMR number to transfer the data to IBM. This sends the collected data to IBM Support team through the FTP protocol. This is a less secure option.
- FTP the Logs to a Different Location (not encrypted) This allows you to send the collected data to another location via FTP. You'll need to provide the target FTP location and appropriate authentication to access it.
- Do Not FTP the Logs. Do nothing.
Click OK to continue. If you choose options other than 4 above, you will need to fill in additional information required to complete the upload.
When the collector completes, the .zip file is created at the location specified in Output File name. You can use any unzip tool to extract the files to examine the content of collected data.
|
