Office Communications Server 2007 R2 Logging Tool

Use the Office Communications Server Logging Tool to set up and monitor debug sessions for components of Office Communications Server.

Logging Options

The specific options to use for a logging (debug) session, including the components, level, and flags to log.

Components

Select the components for which you want to enable logging. Only components that belong to the Office Communications Server role on which you are running Logging Tool are available in the list.

Level

Click to choose the appropriate level of logging. Each level is inclusive of the levels preceding it in the list. For example, if you select Warnings, logging includes Fatal Errors, Errors, and Warnings.

Flags

Select the flags include in logging. The list includes only the flag options available for the selected component. By default, TF_COMPONENT is available for all components.

Note: Select the All Flags check box to generate detailed traces (that is, the former LcsTracer "Trace" option) which can then be used by Microsoft Customer Service and Support to further troubleshoot the problem.

Global Options

Global options include log file options and real-time options that are applied to all logging sessions.

Log File Options

Select the options to specify the type of log file, maximum file size, and if new log files can be appended when each log file reaches the maximum size.

Type

Specify the type of log file to create:

• Circular logging. Use this option to specify that the log file will start writing again from the top of the file when the file reaches the maximum size.

• Sequential logging. Use this option to specify that logging is to stop when the file reaches the maximum size.

• New file. Use this option to specify that logging is to roll over the log file and start over when the file reaches the maximum size. This generates a new log file.

Maximum Size

Specify the maximum size of individual log files.

Append to log file

Select the Append to log file check box to append events to an existing sequential log file. If the file does not exist, it is created. Specify this option only if you specify system (10 ms) for the Clock Resolution settings in Logging Tool advanced options. Otherwise, events will have incorrect time stamps.

Real Time Options

Specify options to enable real-time monitoring and configure real-time monitoring options:

• Real Time Monitoring. Select this check box to see traces in the console window as they accumulate in the log.

• Display only, no log file. Select this check box to see traces in the console window, but not generate a log file.

Filter Options

Specify options to filter what is displayed in the console window when real-time monitoring is enabled.

Enable Filters

Select the Enable Filters check box to enable filtering of log files displayed, so that only traffic to and from the addresses you specify are included. Ensure that you also specify the URI and FQDN addresses.

Note: Trace filtering is available only for the SipStack and UserServices components.

URI

Type the uniform resource identifier (URI) of each address for which you want to see traces in the console window. The filter will display only traffic to and from the specified SIP URI.

FQDN

Type the fully qualified domain name (FQDN) of each address for which you want to see traces in the console window. The filter will display only traffic to and from the specified computer FQDN.

Clear Filters

Click this button to clear URI addresses from the real-time monitoring filter.

Log File Folder

Specify the folder in which the log files are to be created and saved. The default is %windir%\Tracing.

Browse

Click to browse for a location to write log files.

Start Logging

Click to start a logging session, after specifying the appropriate Logging Options, Global Options, Real-Time Options, Log File Folder, and any Advanced Options.

Stop Logging

Click to stop a logging session so that you can view and analyze log files.

View Log Files

Click to view text files containing captured logs.

Analyze Log Files

Click to analyze component protocol logs for the following components:

• Office Communications Server SipStack (SIP)

• Office Communications Server S4 (SIP)

• Office Communications Server Conferencing signaling traffic (C3P), including MCU Infra C3P and Focus C3P

• Office Communications Server Web conferencing traffic (PSOM)

• Office Communications Server Unified Communications Client API (UCCA) client

• Error reports from the archiving database

Note: To view protocol traffic, you must select the TF_Protocol flag before you begin logging.

This analysis functionality is only available if the Microsoft Office Server 2007 R2 Resource Kit is installed on the computer.

Advanced Options

Click to open the Advanced Options dialog box and configure advanced options, including formatting, buffering, clock resolution, and additional components.

Important:  Microsoft recommends that you do not adjust the buffering, clock resolution, additional components, format file search path, log file prefix, or real time prefix options unless you are advised to do so by Microsoft Customer Service and Support.

Exit

Click to exit the logging tool. If you started logging, logging continues after you exit the program.

Learn More Online

Click to expand or collapse

Office Communications Server 2007 R2 Logging Tool, OCSLogger.exe, helps you troubleshoot by capturing logging and tracing information from the product while the product is running. This tool replaces the flat file logging functionality available in previous releases of the product. Logging Tool generates log files on a per-server basis and must be actively running and tracing on each computer for which you want to generate a log.

For details, see the Operations section of the Office Communications Server Technical Library.