Troubleshooting
Problem
How to collect the data necessary to diagnose and resolve IBM Engineering Workflow Management (EWM) source control issues.
Cause
This MustGather assists you in collecting the data necessary to help you diagnose and resolve the issue. If you are unable to determine the root cause by using the information collected, open a support case with IBM Support for further investigation and providing the data collected.
Resolving The Problem
You can use the IBM Support Assistant Lite (ISA Lite) Data Collector tool to quickly collect diagnostic files, such as log files, configuration files or to run traces. ISA Lite collects information about your Jazz Team Server environment and stores the information in a .zip archive file. If you have a need to open a service request with IBM Support for further assistance, you can send the archive file with the data collection so that they can help diagnose and fix problems.
Gather the following information in addition to the data collected by ISA Lite.
When there is a problem with transferring data between the server and the client such as a timeout, OutOfMemoryError or general slowness, collect the following data:
Enable SCM Service Logging
A restart is not required.
Enable SCM tracing
Reproduce the problem. Collect and send in the following:
Gather the following information in addition to the data collected by ISA Lite.
| SCM performance Issues |
When there is a problem with transferring data between the server and the client such as a timeout, OutOfMemoryError or general slowness, collect the following data:
Enable SCM Service Logging
- Navigate to the /ccm/admin page and click Advanced in the right column.
- Search for the Enable SCM Service Logging property.
- Set the property to true.
- Scroll to the top of the page and click Save.
You see a Configuration changes saved successfully message.
A restart is not required.
Enable SCM tracing
- Add the following lines to <server-install-dir>/server/conf/ccm/log4j.properties:
log4j.logger.com.ibm.team.scm=TRACE
- Enable these settings without restarting from the following URL https://<server:port>/ccm/admin?internal=true
- Select Reload Log Settings on the left side under Internal Tools.
To disable, you must replace TRACE and DEBUG with OFF and use the Reload Log Settings operation again.
Removing them or commenting them out prevents them from being disabled.
log4j.logger.com.ibm.team.scm=OFF
Disable the SCM Service Logging and the SCM tracing when the reproduction of the issue is complete to avoid unnecessary excessive logging.
Use the Query Stats counter service to gather query stats.
- Navigate to https://<server>/ccm/service/com.ibm.team.repository.service.ITeamServerStatusContentService Find and follow the com.ibm.team.repository.service.internal.diagnostics.IQueryStatisticsCounterContentService link.
- Press the Reset Query Stats link then the Start Collecting Query Stats link.
- Browse to the Query Stats View, copy and save the output to an ASCII file.
Metronome
If you are using the EWM Eclipse Client or Command Line Interface (CLI), then you can use the Metronome tool to measure the response times of the server. Metronome allows you to diagnose which service is performing poorly during data transfer.
If you are using the EWM Eclipse Client or Command Line Interface (CLI), then you can use the Metronome tool to measure the response times of the server. Metronome allows you to diagnose which service is performing poorly during data transfer.
- Eclipse: Measuring server response times.
- Command Line: SCM Command Line Metronome.
Gather javacore files
Gather javacore files
Reproduce the problem. Collect and send in the following:
- ISAlite data: Running IBM Support Assistant Data Collector.
- The Query Stats output from the Query Stats View, saved to an ASCII file.
- javacore files.
- Metronome data.
| SCM CLI (Command Line Interface) |
- If you run the command within the script, check what is the behavior of the command when you run it from CLI.
- Check whether the issue can be reproduced in the EWM Eclipse client (not by using the CLI) or web UI.
- If you encounter unresponsiveness (a hang), gather the data according to MustGather: Troubleshooting hangs of the scm.exe application
- Contact IBM support about any additional traces that might be applicable for troubleshooting your issue.
| SCM Eclipse Client |
- Enable tracing according to the Client Tracing document.
- Collect the relevant screen captures.
- Collect the workspace log file located in <workspace directory>/.metadata named .log
| SCM web UI |
- Collect the relevant screen captures.
- Browser's developer tools can be used to collect the browser network data or to check the scripts when you are reproducing the issue. You can find more details on how to use developer tools on Debugging the Web UI in the Development Environment.
| SCM Visual Studio Client |
- Enable debug trace according to How to Enable Debug Trace in Visual Studio document.
| SCM Shell Client |
- Gather the logs according to Obtaining verbose logs of Engineering Workflow Management Windows Shell client document.
[{"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SSUC3U","label":"IBM Engineering Workflow Management"},"Component":"SCM","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Versions","Edition":"","Line of Business":{"code":"LOB59","label":"Sustainability Software"}}]
Was this topic helpful?
Document Information
Modified date:
10 January 2024
UID
swg21632546