How to set up debug tracing for the ClearCase Remote Client

Technote (FAQ)


Question

How do you turn on client side tracing for use in troubleshooting IBM Rational ClearCase Remote Client (CCRC) issues (both the Rich Client Platform and the Eclipse plug-in) on Microsoft Windows, UNIX and Linux?

Answer

Note: For diagnosing issues with CCRC version 7.1, refer to technote 1413762 MustGather documents for ClearCase Remote Client (CCRC) version 7.1.

Enable CCRC (Eclipse plug-in and CCRC RCP) Tracing:

  1. Copy the previous workspace (client) .log to a backup file.

    Note: The workspace .log file is located by default in the following location:

    WINDOWS:
    C:\Documents and Settings\{USERNAME}\.Rational\CCRC701\workspace\.metadata\.log

    LINUX/UNIX:
    {~username}/.Rational/CCRC701/workspace/.metadata/.log


  2. Create a text file named .options and store the file in the same directory as the eclipse or ccrc applications being executed by the client.

    Note: On Windows, files that precede with a period ( "." ) need to be created from the command line.

    Windows Example (Expand or Collapse)

  3. Copy the following text into the options file and replace the {path to a text file} section with an appropriate path on the client to the trace log file.

    For example c:\\ccrc_client_trace.txt on Windows OR /tmp/ccrc_client_trace.log on UNIX or Linux.

    Note: The double backslashes above (in c:\\ccrc_client_trace.txt) are needed for Windows to interpret the proper path and file name.

    Hint:
    There is both client and server tracing options in the output below.

    Note: The path uses a forward slash on Windows for the path and not a back slash.


    # -------------- CCRC Tracing Options File -----------------
    # All line preceeded with a # sign are not evaluated.

    # ------Server Tracing-------
    # subsystems available:
    # CCRC - Core general tracing related to CCRC server operations
    # CCWEB- CCWeb(CGI operations)
    # SUM -  UCM specific

    com.ibm.rational.clearcase/server_trace=true
    com.ibm.rational.clearcase/server_trace/subsys=CCRC:CCWEB:SUM
    com.ibm.rational.clearcase/server_trace/level=4

    # ------Client Only Tracing-------
    # Parameters available:
    # HTTP_CLIENT - Tracing specific to HTTP communications
    # CTRC_UI -     Tracing specific to the user interface
    # CTRC_CORE -   For client core tracing

    com.ibm.rational.clearcase/client_trace=true
    com.ibm.rational.clearcase/client_trace/params=HTTP_CLIENT:4 CTRC_UI:3 CTRC_CORE:3

    com.ibm.rational.clearcase/client_trace/output=file
    com.ibm.rational.clearcase/client_trace/file_name=
    {path to a text file}

    # --------------------------------------------------------------




  4. Start Eclipse or CCRC using the -debug switch.


    Option 1:
    Windows, UNIX and Linux command-line

    Start Eclipse or CCRC from the command line using the -debug option as follows:


    Windows Example:

    C:\Program Files\IBM\Rational\ClearCase\CCRC>ccrc -debug


    C:\eclipse_3.1.2\eclipse>eclipse.exe -debug

Linux Example:

 /opt/IBM/Rational/CCRC701/ccrc -debug

 /opt/eclipse_3.2/eclipse/eclipse -debug

    Note: The debug operation will point to the default installation location for the options file, however, if you do not have write access to this directory due to security restrictions, you can create the options file at an alternate location and specify its location.
    For example the options file has been created and specified in an alternate location in the syntax example below :

   C:\Program Files\IBM\Rational\CCRC>ccrc -debug "C:\Documents and Settings
  \username\options"




Option 2: Windows GUI

Modify the ClearCase Remote Client shortcut or the Eclipse shortcut and add the -debug switch after the executable in the target window.

Note: The -debug switch must come first before any other switches.

Windows Example (Expand or Collapse)
Example:



Double click your new shortcut to start CCRC or Eclipse in debug mode.

Note: Upon executing the debug version of CCRC or Eclipse, a command window will open and display a message that the options file was loaded successfully and it will state the location of the client trace file.

  1. Perform the operation in CCRC. Ensure to take note the time (clock time) that you start the operation in order to assist support in reading the trace log (as this can be helpful if troubleshooting long operation traces).

    Complete the operation and terminate CCRC after the behavior you are looking to diagnose has completed.

    * Send the client log file above from the path specified in the options file.

    * Locate and send the trace log file on the Rational Web Platform (RWP) server (if tracing was enabled and a log was created). The server log files for debug are located in the following directory:

    WINDOWS:
    C:\Program Files\Rational\ClearCase\var\log\trace\{USERNAME}\*.log


    LINUX/UNIX:

    /var/adm/rational/clearcase/log/trace/{username}/*.log



    Note:
    There will be multiple files for each RPC sent over to the server.

    For example ccrc_fred_s1707973141_d070720_t211420_p24232.log

    -- where s###### is the users' specific session number
    See the session.dat file under /var/adm/rational/clearcase/ccweb/{username} on Linux or UNIX and C:\ccweb\{username} on Windows
    -- where d###### is the date of the RPC
    -- where t###### is the time
    -- where p###### is the packet sequence



  2. Along with the trace, gather the instances configuration details found in Help > About Rational ClearCase Remote Client > Configuration Details





    Copy the text into a text document.

    This will provide support with a wealth of information specific to the instance of Eclipse (CCRC RCP client or Eclipse SDK) in use.

Related information

Getting started with the ClearCase Remote Client
About the CCRC .ccase_wvreg lockfile
Level 4 tracing crashes CCRC
Trace CCWeb client operations on Windows
About the temporary files created by ClearCase
Simplified Chinese version

Cross reference information
Segment Product Component Platform Version Edition
Software Development Rational ClearCase ClearCase Remote Client (CCRC)

Rate this page:

(0 users)Average rating

Add comments

Document information


More support for:

Rational ClearCase
ClearCase Remote Client

Software version:

7.0, 7.0.0.1, 7.0.1

Operating system(s):

AIX, HP-UX, IRIX, Linux, Solaris, Windows

Reference #:

1234118

Modified date:

2013-09-24

Translate my page

Machine Translation

Content navigation