Share via


Lync Server 2010 Logging Tool: Advanced Options

 

Topic Last Modified: 2011-01-25

In the Advanced Options dialog box in Microsoft Lync Server 2010 Logging Tool, you can set additional options for more granular control over your logging sessions. In most cases you probably will not need to modify these settings unless requested by Microsoft Customer Service and Support.

Advanced Options

The Advanced Options dialog box includes options for formatting, buffering, clock resolution, and additional components.

Formatting

Use the options on the Formatting tab to specify advanced options for controlling log formats. Formatting does not impact how you capture logs, only how you view them. The following formatting options are available:

  • Log File Prefix   Specifies the prefix to use in log files for components that support levels.

  • Real Time Prefix   Specifies the prefix to use in log files for the real-time monitoring window.

You can use the following Log File Prefix and Real Time Prefix settings:

Setting Description

%!COMP!

Component name

%!LEVEL!

Level name

%!FLAGS!

Flag name

%!FUNC!

Function or method that generated the log record

%2

Source file and line number that generated the record

%3

ID of the thread that generated the record

%4

Time that the event record was generated

%5

Cumulative processor time

%7

Local sequence number for the component

%8

ID of the process that generated the record

%9

Number of the CPU that generated the record

%1 and %6

Do not use (not allowed)

%3, %7, %8, and %9 are integers that should be followed by a printf-style numeric format specifier enclosed in exclamation marks. For example, %3**!04X!** displays the thread ID as a four-digit hexadecimal number.

%2, %4, and %5 are always strings, so they can be followed only by a string format specifier (!s!). Additionally, the real time prefix can contain the following escape characters: \n, \t, \s, or \\. These characters are replaced with a new line sequence, a tab, a space, and a single backslash, respectively.

  • Display times in UTC   By default, log time stamps are displayed in Coordinated Universal Time (UTC). To display time stamps in the local server time, clear this check box.

  • Format file search path   Logging Tool has all the information necessary to capture log information for log levels and flags. If you have access to trace information files that contain more tracing information, you can use this setting to specify the path to those trace information files.

Buffering

You can use the options on the Buffering tab to modify the default buffer values for real-time monitoring. The following advanced buffering options are available:

  • Buffer size   The maximum size, in KB, of the buffer during real-time monitoring. The default is 64 KB.

  • Minimum number of buffers    The default is 20.

  • Maximum number of buffers   The default is 40.

  • Real time display flush timer   The number of seconds that elapse before the display is refreshed for real-time monitoring. The default is 10 seconds. Setting this value to a lower number will cause the real-time monitoring display to be refreshed more frequently. However, if you are not running real-time monitoring with the Display only option selected, a lower timer value can result in very large log files.

Warning

Buffers are allocated from non-paged system memory. As a result, high values for buffer size or number of buffers can have a negative impact on system performance.

Clock Resolution

The options on the Clock Resolution tab control resolution for the time stamp. Available values are 10 ms, 100 ns, and CPU Frequency..

Clock resolution descriptions are provided in the user interface and in the following table.

10 ms

Provides a low-resolution (10 milliseconds) time stamp but is comparatively less expensive to retrieve. System time is the default. Note that if the volume of events is high, the resolution for system time may not be fine enough to determine the sequence of events. In this case, a set of events will have the same time stamp, but the order in which the events are delivered may not be correct. In this case the local sequence number can be used to determine the order.

100 ns

Provides a high-resolution (100 nanoseconds) time stamp but is comparatively more expensive to retrieve. You should use this resolution if you have high event rates or if the consumer merges events from different buffers.

CPU Frequency

Provides the highest resolution time stamp and is the least expensive to retrieve. However, the CPU counter is unreliable and should not be used in production. For example, on some computers, the timers will change frequency due to thermal and power changes, in addition to stopping in some states.

Advanced Components

The Advanced Components tab contains two fields: Paths to search for executables and Executable Files. Click in the field to add the information. Typically, you modify these settings only at the request of Microsoft Customer Service and Support.

See Also

Concepts

Lync Server 2010 Logging Tool