Teamprise Knowledge Base

TKB00044 Using a custom log configuration file

Last updated 2007-06-18 16:52:23 UTC by Shaw Terwilliger

Purpose

This article explains how to set up a Teamprise installation to use a customized log configuration file. Normally, you would only do this at the request of Teamprise support. Running Teamprise with a customized log configuration file allows the capture of extended logging information ("debug" info) which is often needed when diagnosing a bug.

Technique

When Teamprise starts, it checks for a log configuration file in a specific location on the local file system. If it fails to find the configuration file in this location, it uses an internal configuration file instead. By placing a custom configuration file in the location described below, you can override the built-in configuration.

Teamprise currently looks for a custom configuration file at this location:

TEAMPRISE_HOME/2.0/common/log4j-teamprise.properties

The value of TEAMPRISE_HOME is platform-dependent. On Windows, it is:

%USERPROFILE%\Local Settings\Application Data\Teamprise (eg C:\Documents and Settings\username\Local Settings\Application Data\Teamprise)

On Mac OS X, it is:

~/Library/Teamprise

On Unix platforms, it is:

~/.teamprise

Either way, you should follow these steps to use a custom logging configuration file:

1) Obtain the custom log4j-teamprise.properties file. Normally this file will be emailed to you by Teamprise support.

2) Locate the directory described above. To help locate it, note that this is the same directory in which the Teamprise license data is stored. If you see a file named "license" in the same directory, you know you've found the right place.

3) Place the log4j-teamprise.properties file in the "common" directory, along side the "license" file.

4) Run the Teamprise application. Note that the new logging configuration file will not be picked up until the Teamprise application is restarted, so if you had the application open, you must close and re-open it.

5) Attempt to reproduce the problem you're having with the Teamprise application.

6) Export the Teamprise diagnostic data by going to the Help menu and choosing Teamprise Support. See Exporting Teamprise Diagnostic Information.

7) After sending the diagnostic logs to Teamprise support, it is very important to remove the custom logging configuration file. The reason is that often capturing extended logging information will cause degraded performance of the application.

If you have any questions about the procedure, please contact Teamprise support.

Products affected:

  • Teamprise Command Line Client
  • Teamprise Explorer
  • Teamprise Plugin for Eclipse

Releases affected:

  • All

Platforms affected:

  • All
Keywords: log configuration debug logging log4j