Utility to collect ClearCase logs and diagnostic data on Windows

Technote (FAQ)


Question

How can you collect IBM Rational ClearCase logs and diagnostic data on Microsoft Windows to assist IBM Rational Client Support?

Answer

There are 3 options you can use to proactively collect general information and diagnostic data on a problem machine to assist technical support in troubleshooting your problem.







CLEARBUG 2 - Version 2.60 updated 11-October-2011

Name of Utility: Clearbug2

Clearbug 2


Update: Clearbug2 Integration into ISA


Clearbug2.exe
is included with IBM Support Assistant (ISA) and IBM Support Assistant Lite as part of the data collector functionality provided for Rational ClearCase version 7.1 and 7.0.


This will allow you to:

  • Quickly access information on ClearCase 7.x.
  • Search through all IBM technical resources.
  • Collect data to gather general information needed for troubleshooting.
    • Full Collector: System information and clearbug2.exe.
    • Quick Collector: System information and clearbug2.exe -nowinmsd.
    • Collect WinMSD: Collects only WinMSD information.
  • Open problem report from through ESR interface.
  • ISA V3.1 - automatically be notified of changes and updates to the product plug-in.






N ote



What does it do?
Clearbug2 collects various pieces of information that assist Rational Support in gathering diagnostic data of your problematic environment.

Usage:  clearbug2 -help | -ver | -nowinmsd | -liconly | -longvobs | -longviews

Switches:
  '-help'      = This help menu
  '-ver'       = Display the Clearbug Version
  '-nowinmsd'  = This will skip the collection of Winmsd
  '-liconly'   = Collect only RCL/FlexLM information
  '-longvobs'  = Collect lsvob -long listing.
  '-longviews' = Collect lsview -long listing.
  '-fulllogs'  = Collect cleartool getlog -all -full.

Any or all of -nowinmsd, -longvobs, -longviews and -fulllogs can be used. -liconly will bypass all but license data collection.

Where can I get it? File is attached at the top of this technote.

On Windows, this information includes:

  • WinMSD (optional)
  • Host information
  • ClearCase Version information
  • Network information
  • System Logs
  • ClearCase information
  • Flex/LM license Data, including
    • Flex/LM Registry data
    • Flex/LM license server status, including keys in use ("lmutil lmstat -a" output)
    • Flex/LM license server log if run on a Windows License server.
    • Flex/LM license files for Rational products
  • (Optionally) Expanded VOB and view registry data.
  • Windows memory management keys related to pool usage (New in 2.60)
  • Server and Workstation service "parameter" keys that may impact paged pool usage. (New in 2.60)


How to execute:
  1. Copy the Clearbug2.zip archive to the server whose diagnostic data you wish to collect.

  2. Unzip the Clearbug2.zip archive to a location on the host.

  3. Execute Clearbug2.exe (double-click the executable). The following console window will open:



    Note 1:
    Collecting the WINMSD takes time as there is a lot of information Windows has to compile. Time to complete will vary. To omit the collection of the WINMSD, run clearbug2 from the command line using the following syntax:

    clearbug2 -nowinmsd

    Example:

    C:\temp>clearbug2 -nowinmsd

    **Skipping collection of winmsd information**


    Note 2: Collecting the tracert information may take some time when there are either a large number of network "hops" to reach the desired remote hosts (Domain controller, License and/or registry server). There is currently no way to avoid this delay.


    Note 3: In order to improve clearbug2 runtime in environments with a large number of VOBs and/or views, clearbug2 now collects local view and VOB information using cleartool the -quick option or the -host checks. As a result, the tool may not collect the full list of local VOBs and views. Two new options -- -longvobs and -longviews -- will collect full cleartool lsvob -long and cleartool lsview -long output in cases like these.

  4. When complete, a file called clearbug.zip will be created on the desktop. If the clearbug2 tool cannot create the archive, a warning similar to the following will:





Disclaimer

All source code and/or binaries attached to this document are referred to here as "the Program". IBM is not providing program services of any kind for the Program. IBM is providing the Program on an "AS IS" basis without warranty of any kind. IBM WILL NOT BE LIABLE FOR ANY ACTUAL, DIRECT, SPECIAL, INCIDENTAL, OR INDIRECT DAMAGES OR FOR ANY ECONOMIC CONSEQUENTIAL DAMAGES (INCLUDING LOST PROFITS OR SAVINGS), EVEN IF IBM, OR ITS RESELLER, HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.


CLEARBUG

Name of Utility: clearbugnt.exe

Found in:
C:\Program Files\Rational\ClearCase\etc\utils

What does it do? Clearbug collects various pieces of information that assist Rational Support in gathering diagnostic data of your problematic environment.

On Windows, this information includes:

  • Host information
  • ClearCase Version information
  • Network information
  • System Logs
  • ClearCase information


How to execute:
  1. Go to a command prompt (do not run from 4NT, batch, or other third party shell).

  2. Change to the %clearcase_home%\etc\utils directory.

  3. Type "clearbugnt" and hit enter.

    Note: You will need to close the System Information Logs window when it pops up. That will be collected separately later.

  4. A file called clearbug.zip will be created in the %rational_home%\etc\utils directory (you must have write access to this directory).


CCDOCTOR

Name of Utility: ccdoctor.exe (ClearCase Doctor)

Found in: C:\Program Files\Rational\ClearCase\bin

What does it do? ClearCase Doctor collects various pieces of information that assist Rational Support in gathering diagnostic data of your problematic environment.
How to execute:

  1. Go to a command prompt and type "ccdoctor" and hit enter. This will launch the ClearCase Doctor.

  2. Click 'Start Analysis'

  3. Select: Analysis > Save As... from the pull down menu and save this file with the default '.ccdoc' extension.

  4. Add this file to the clearbug.zip file.



WINMSD (Msinfo32)

Name of Utility: winmsd.exe (Windows Management System Diagnostic)

Found in: C:\WINDOWS\system32/winmsd.exe

What does it do? WinMSD, is a utility used to gather detailed configuration information about computers running Windows. It can be beneficial for Support to use this information to troubleshoot ClearCase issues.

Note: You can start Microsoft System Information with Winmsd.exe as in Windows NT 4.0, but the difference under Windows 2000, XP and 2003 is that Winmsd.exe is a stub executable file that starts Msinfo32.exe. Msinfo32.exe is located in the Program Files\Common Files\Microsoft Shared\MSInfo folder.

How to execute:

Note: WINDOWS 2000 and WINDOWS XP users must collect the winmsd information manually as clearbugnt has a defect that does not automatically collect this information.

  1. Go to Start > Run type “winmsd” and hit enter.

  2. Go to File > Save and save as System Information File. (.nfo)

  3. Add this file to the clearbug.zip file.

View Microsoft articles for more information:
  • KB232848 -- How to Create a WinMSD Report
  • KB255713 -- Command-Line Parameters for MSINFO32


MANUAL COLLECTION:

In the event you cannot or do not wish to run the automated utilities, below are the manual instructions to collect the most basic logs and information required to initially troubleshoot most problems.

  1. Collect the output of cleartool getlog -all -last 50

    Note: If the ALBD service is not running, the following error will occur albd_contact call failed and the logs will not be collected.
  2. Collect the Windows System and Application logs using the Event Viewer.

    Start > Run type eventvwr.msc /s

    Use the "action" menu to save the application, system and security log as a .evt file.
    Review Microsoft KB article 308427 for more details.
  3. Collect the output of cleartool hostinfo -long -properties -full
  4. Collect the installed programs by running grabber.exe. The readme file and grabber.exe executable are contained in the grabber.zip file attached below.

Grabber
grabber.zip

Related information

IBM Support Assistant 3.x
Data Collection Utility for UNIX and Linux
Manual Data Collection on UNIX and Linux

Cross reference information
Segment Product Component Platform Version Edition
Software Development Rational ClearCase Utilities and Tools

Rate this page:

(0 users)Average rating

Document information


More support for:

Rational ClearCase
Utilities and Tools

Software version:

7.0, 7.0.0.1, 7.0.0.2, 7.0.0.3, 7.0.0.4, 7.0.0.5, 7.0.0.6, 7.0.0.7, 7.0.0.8, 7.0.0.9, 7.0.1, 7.0.1.1, 7.0.1.2, 7.0.1.3, 7.0.1.4, 7.0.1.5, 7.0.1.6, 7.0.1.7, 7.0.1.8, 7.0.1.9, 7.0.1.10, 7.0.1.11, 7.0.1.12, 7.1, 7.1.0.1, 7.1.0.2, 7.1.1, 7.1.1.1, 7.1.1.2, 7.1.1.3, 7.1.1.4, 7.1.1.5, 7.1.1.6, 7.1.1.7, 7.1.2, 7.1.2.1, 7.1.2.2, 7.1.2.3, 7.1.2.4, 8.0

Operating system(s):

Windows

Reference #:

1131335

Modified date:

2011-01-26

Translate my page

Machine Translation

Content navigation