Logging the Vault IDE component

A collection of information about Vault, including solutions to common problems.

Moderator: SourceGear

Post Reply
Posts: 2448
Joined: Wed Dec 17, 2003 5:03 pm
Location: SourceGear

Logging the Vault IDE component

Post by dan » Fri Jan 21, 2005 2:44 pm

There are two types of client logging: Normal client logging, and Visual Studio IDE logging.

Normal client logging is accomplished using a .config file to specify logging classes. The KB article at http://support.sourcegear.com/viewtopic.php?p=5375 describes how to set this up.

While this kind of logging does have an "ide" class that logs client IDE operations, it only logs activity that happens on the managed (C#) side of the IDE. When Visual Studio makes calls into Vault, it first goes through an unmanaged C++ layer before making calls into the managed Vault operations libraries.

Since this unmanaged layer is the closest to the calls actually being made by Visual Studio, it can often reveal better information about how Visual Studio is calling into Vault, which is the cause of a number of problems related to IDE integration.

This type of logging is enabled through the registry rather than through a .config file. To start this type of logging, type in "regedit" in a command prompt and go to the following key: HKEY_LOCAL_MACHINE\SOFTWARE\SourceGear\Vault Client

Create a new string value titled "SCCLogFileName". Modify the string value to contain the path to a log file you want the IDE to write to.

After the registry entry is created, restart the IDE and the it will start logging VS calls to this file.

Note: This logging is only available in Vault client 3.0.2 at higher.

Post Reply