RTCClientTracing < Deployment

Engineering Lifecycle Management Wiki - Deployment

Community information and contribution guidelines

TWiki > Deployment Web > DeploymentTroubleshooting > PerformanceTroubleshooting > RTCClientPerformance > RTCClientTracing

Revision 18 - 2013-05-14 - 11:50:24 - Main.sbeard

<div id="header-title" style="padding: 10px 15px; border-width:1px; border-style:solid; border-color:#FFD28C; background-image: url(<nop>https://jazz.net/wiki/pub/Deployment/WebPreferences/TLASE.jpg); background-size: cover; font-size:120%">
---+!!  How to enable additional tracing in the Rational Team Concert client for Eclipse IDE
%DKGRAY% Authors: PerformanceTroubleshootingTeam <br>
Build basis: Rational Team Concert 4.0.x
%ENDCOLOR%</div></sticky>

<!-- Page contents top of page on right hand side in box -->
<sticky><div style="float:right; border-width:1px; border-style:solid; border-color:#DFDFDF; background-color:#F6F6F6; margin:0 0 15px 15px; padding: 0 15px 0 15px;">
%TOC{title="Page contents"}%
</div></sticky>

<sticky><div style="margin:15px;"></sticky>

It is possible to activate built-in traces in the RTC Eclipse Client. These traces may provide additional information about issues that are hard to reproduce in a different environment, including performance information.

---++ How to enable additional tracing

To add traces to an Eclipse-based application, you must create a file containing trace strings, and then relaunch the application with a specific command line.

---+++ How to find out what trace options are available

To find out what trace strings are available, you can proceed as follows:

   1 Open the Java Perspective: *Window &gt; Open Perspective &gt; Java*
   1 Click on *Run &gt; Run Configurations...*
   1 Click on *Eclipse Application*
   1 Press the *New* button (it is the first icon on the top-left)<br /><img alt="Tracing1.jpg" src="%ATTACHURL%/Tracing1.jpg" />
   1 Click on *Tracing*
   1 Select the plug-ins you want to trace. The RTC Plug-in names start with _com.ibm.team_. In some cases, you might need to trace Eclipse plug-ins, for example _org.eclipse.core.jobs_ or _org.eclipse.core.resources_. <br /><img alt="Tracing2.jpg" src="%ATTACHURL%/Tracing2.jpg" />
   1 Click on *Run*. A second instance of Eclipse starts, with the traces enabled.
   1 In the original instance, do: *Window &gt; Show View &gt; Console*. Look at the startup messages. You will see something like:<verbatim>
Debug options:
    file:/<original_workspace>/.metadata/.plugins/org.eclipse.pde.core/New_configuration/.options loaded</verbatim>
   1 Open the _.options_ file with a text editor.

---+++ Example of .options file with Trace strings

   1 Save the generated _.options_ file *in the RTC Client for Eclipse installation directory*. This file contains specific trace strings for the plug-ins you want to trace. 
   1 For example, these trace strings are appropriate for the Eclipse Client (_rcp_ stands for Rich Client Application):<verbatim>
com.ibm.team.filesystem.rcp.core/trace.componentsyncmodel.contexts=true
com.ibm.team.filesystem.rcp.core/trace.activeworkspaces=true
com.ibm.team.filesystem.rcp.core/trace.componentsyncmodel.refresh=true      
</verbatim>With these traces you will get results like the following while checking in and delivery source files:<verbatim>
...
BEGIN:	LocalChangeSource.update (Thu Feb 28 17:20:33 CET 2013)
END:	LocalChangeSource.update (1 ms)
BEGIN:	ComponentSyncContext.refresh full true (context CCMProject1 Default Component CCMProject1 Stream Workspace-CCMProject1 Stream type 2 repo: https://ibm-oprsurvfat7.ams.nl.ibm.com:9443/ccm/,user1,1,480) (Thu Feb 28 17:20:33 CET 2013)
BEGIN:	CompareToNode.computeItemsAndChildren elements size 1 (Thu Feb 28 17:20:33 CET 2013)
BEGIN:	ItemManager.fetchCompleteItem com.ibm.team.repository.common.model.impl.ContributorHandleImpl@171f171f (stateId: <unset>, itemId: [UUID _cdenUIAAEeKeWtSjJ9gfOQ], origin: com.ibm.team.repository.client.internal.TeamRepository@2a652a65, immutable: true) (Thu Feb 28 17:20:33 CET 2013)
END:	ItemManager.fetchCompleteItem DEFAULT Proxy of com.ibm.team.repository.common.model.impl.ContributorImpl@15b215b2 (stateId: [UUID _63Y9V4AGEeKa-d3d_MzpVw], itemId: [UUID _cdenUIAAEeKeWtSjJ9gfOQ], origin: com.ibm.team.repository.client.internal.TeamRepository@2a652a65, immutable: true) (contextId: [UUID _8lNyYNwSEd2pIJ5QVwgQGg], modified: 2013-02-26 12:23:18.311, workingCopy: <unset>) (mergePredecessor: null, workingCopyPredecessor: <unset>, workingCopyMergePredecessor: <unset>, predecessor: [UUID _63XvMoAGEeKa-d3d_MzpVw]) (emailAddress: user1@example.com, userId: user1, name: user1 user1, archived: false) (2 ms)
....
</verbatim> 
Note: the _com.ibm.team.filesystem.cli_ strings relate to the Command Line Interfaces client. See [[https://jazz.net/wiki/bin/view/Main/SCMCommandLineMetronome][SCM Command Line Interfaces Metronome]] for more information.


---+++ Launch the RTC Client for Eclipse with the traces enabled

   1 Launch the following command *from the RTC Client Installation directory* (so that the _.options_ file can be found by the JVM): %BR% Windows: <verbatim>
eclipsec.exe -product com.ibm.team.concert.product -debug > trace.txt 2>&1</verbatim> Linux: <verbatim>./jdk/jre/bin/java -Xms100m -Xmx512m -Dosgi.requiredJavaVersion=1.5 -Dosgi.bundlefile.limit=100 -jar ./plugins/org.eclipse.equinox.launcher_1.1.1.R36x_v20101122_1400.jar -showsplash -debug -product com.ibm.team.concert.product  > trace.txt 2>&1</verbatim>
      1 Note: The above command line for Linux is derived from the contents of the _eclipse.ini_ file contained in the Rational Team Concert Client for Eclipse IDE v4.0.1. It is subject to change in higher releases or if you install on an existing Eclipse, with a different JVM, shell-sharing with other products etc. An easy way to construct the command line appropriate for your installation is as follows:
         1 Launch the product normally
         1 From a command prompt, execute "ps -ef |grep javaw" (to see the command line of all "javaw" processes. There may be more than one, and you have to identify the one that refers to Rational Team Concert Client for Eclipse IDE)
         1 Make note of the command line used to launch RTC Client for Eclipse IDE
         1 Replace "javaw" with "java"
         1 Add  "-debug -product com.ibm.team.concert.product  > trace.txt 2>&1" at the end of the command
      1 Note: If you installed the Rational Team Concert for Eclipse IDE - Extension Install - on Rational Application Developer, see [[http://www-01.ibm.com/support/docview.wss?uid=swg21327307][How to trace Rational Application Developer for WebSphere Software]]
   1 The resulting trace will be found in the file _trace.txt_, located in the RTC Client Installation directory, after the run completes.

---+++++!! Related topics: 

   * [[RTCClientPerformance][Why is the Rational Team Concert client slow? ]]
   * [[https://jazz.net/wiki/bin/view/Main/SCMCommandLineMetronome][SCM command line interfaces metronome]]
   * [[PerformanceTroubleshooting][Performance troubleshooting]]

---+++++!! External links:

   * How to trace Rational Application Developer for <noautolink>WebSphere</noautolink> Software: [[http://www-01.ibm.com/support/docview.wss?uid=swg21327307][http://www-01.ibm.com/support/docview.wss?uid=swg21327307]]
   * How to contact IBM support: [[http://www-01.ibm.com/software/rational/support/contact.html][http://www-01.ibm.com/software/rational/support/contact.html]]
   * How to send data to IBM support: [[http://www.ecurep.ibm.com/app/upload][http://www.ecurep.ibm.com/app/upload]]

---+++++!! Additional contributors: None

---+++++!!! Questions and comments:

%COMMENT{type="below" target="RTCClientTracingComments" button="Submit"}%

%INCLUDE{"RTCClientTracingComments"}%

<sticky></div></sticky>

Attachments

Topic attachments
I	Attachment	Action	Size	Date	Who	Comment
jpg	Tracing1.jpg	manage	114.6 K	2013-02-27 - 18:55	UnknownUser
jpg	Tracing2.jpg	manage	138.4 K	2013-02-27 - 18:55	UnknownUser

Copyright © by IBM and non-IBM contributing authors. All material on this collaboration platform is the property of the contributing authors.
Contributions are governed by our Terms of Use. Please read the following disclaimer.
Dashboards and work items are no longer publicly available, so some links may be invalid. We now provide similar information through other means. Learn more here.