Generate performance data logs (Performance data collection)

Performance data collection enables you to collect data about operational events in Unified Service Desk client application to log files, which is used to identify and troubleshoot performance issues.

You can generate the performance data logs to:

  • Analyze the end-to-end performance of Unified Service Desk from the time of client application booting.
  • Analyze the performance of operations that agents perform in the Unified Service Desk client application.

You can generate the performance data logs in two ways:

  • Using application configuration file (UnifiedServiceDesk.exe.config) to generate data log for the end-to-end client application, which includes booting through closing the client application.
  • Using keyboard shortcuts to generate data log for operations.

Note

If you encounter performance issues with Unified Service Desk, customer support may ask you to collect the performance data and send the log files to help troubleshoot the issue.

Use application configuration file (UnifiedServiceDesk.exe.config) to generate performance data log

Use the application configuration file (UnifiedServiceDesk.exe.config) to generate (collect) startup performance data log.

If you experience performance issues with boot of Unified Service Desk, you can manually modify the application configuration file (UnifiedServiceDesk.exe.config) to start collecting the performance data to log files.

To start collecting the startup performance data log, change the value in application configuration file from Off to Verbose in the XML node.

<add name="Microsoft.Uii.Common.Performance" value="Verbose"/>

More information: Diagnostics Verbosity Level

Use keyboard shortcut to generate performance data log

When you are working with the client application and want to analyze the performance of the operations that you execute, you need to generate the performance log from which you can generate a performance report specific those operations.

Start performance data collection using a keyboard shortcut

  1. Press Ctrl+Alt+Q or the configured keyboard shortcut to start collecting performance data. Unified Service Desk displays a window asking - Do you want to start collecting performance data?.

    Do you want to start collecting performance data

    Note

    When you press the keyboard shortcut and if Unified Service Desk does not display the performance data collection starting window, then ensure the keyboard focus is not on the Internet Explorer Webpage. Press Alt+0 to bring the keyboard focus outside the Internet Explorer webpage, and then press the keyboard shortcut to start the performance data collection. More information: Manage Options for Unified Service Desk

  2. Click Yes to start collecting the performance data.

Note

If you press Ctrl+Alt+Q after you start collecting performance data for a session, Unified Service Desk displays a window with a message - Performance data collection has already started. PerfSessionId - XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX. Performance data collection already started

Stop performance data collection using keyboard shortcut

  1. Press Ctrl+Alt+P or the configured keyboard shortcut to stop the collection of performance data.
    Unified Service Desk displays a window with a message - Do you want to stop collecting performance data? PerfSessionId - XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX.

    Do you want to stop collecting performance data

  2. Click Yes to stop collecting the performance data.

Note

If you press Ctrl+Alt+P after you stop collecting performance data for a session, Unified Service Desk displays a window Performance data collection has already stopped. Performance data collection already stopped

Location of the performance data file

When you start collecting performance data, log files are generated with a unique performance session ID (GUID) on the client computer.

The default path where the log files are maintained on the client computer:

%APPDATA%\Roaming\Microsoft\Microsoft Dynamics 365 Unified Service Desk\<version>\USDPerformanceData_<hhmmssfff>_<yyyy-mm-dd>

You can change the default path of the log files from the application configuration file. In the XML node of the application configuration file, change the value of the following attributes.

Attribute Default Value New Value
Location LocalUserApplicationDirectory Custom
CustomLocation - <\New folder path in client computer>
Example: C:\UnifiedServiceDesk\Logs

Default XML node in the application configuration file:

<add name="RollingPerfTraceListener" type="Microsoft.Crm.UnifiedServiceDesk.Dynamics.Utilities.Performance.RollingPerfTraceListener, Microsoft.Crm.UnifiedServiceDesk.Dynamics" BaseFileName="USDPerformanceData" Location="LocalUserApplicationDirectory" MaxFileSize ="52428800" MaxFileCount="10"/>

Example of setting new path in the application configuration file:

<add name="RollingPerfTraceListener" type="Microsoft.Uii.Common.Performance.RollingPerfTraceListener, Microsoft.Uii.Common" BaseFileName="USDPerformanceData" Location="Custom" CustomLocation="C:\UnifiedServiceDesk\Logs" MaxFileSize ="52428800" MaxFileCount="10"/>

MaxFileSize is the maximum size (in bytes) of one performance log file that Unified Service Desk maintains at the default or configured path in the client computer. When the size of performance log file is equal to MaxFileSize value, Unified Service Desk generates a new file in the default or configured path and continues to collect the performance data.

Example: You configure MaxFileSize="52000000". When the size of performance log file is 52000000 bytes (52 MB), Unified Service Desk generates a new performance log file in the default or configure path and continues to collect the performance data.

MaxFileCount is the count of files that Unified Service Desk maintains at the default or configured path in client computer. When the count of the performance log file is equal to MaxFileCount value, Unified Service Desk deletes the oldest performance log file to generate the new performance log file in the default or configured path.

Example: You configure MaxFileCount="10". Unified Service Desk generates 10 performance log files in the default or configured path. To generate a new performance log file, Unified Service Desk deletes the oldest performance log file and generates the new performance log file. At all times, the count of performance log files cannot exceed the MaxFileCount.

Note

Each time you start collecting performance data, Unified Service Desk creates a new file with a performance session ID, which it maintains on the client computer.

Configure a performance data collection keyboard shortcut

An agent working on a client computer can start and stop collecting the Unified Service Desk performance data using keyboard shortcuts. By default, the keyboard shortcut to start performance data collection is Ctrl+Alt+Q and to stop performance data collection is Ctrl+Alt+P.

To change the default keyboard shortcut, a System Administrator needs to configure new keyboard shortcuts to start and stop collection of Unified Service Desk performance data.

To configure a new performance data collection keyboard shortcut:

  1. Sign in to Dynamics 365.

  2. Go to Settings > Unified Service Desk.

  3. Open the Audit & Diagnostics Setting record in the Audit & Diagnostics Settings section.

    Note

    If there is no existing record, create a new Audit & Diagnostics Setting record. More information: Create an Audit & Diagnostics record to use for diagnostics.

  4. Expand the Diagnostics Settings area to see Performance Data Collection.

  5. Type the keyboard shortcut in the format key1+key2+key3 for the On-Demand Begin Shortcut field.

  6. Type the keyboard shortcut in the format key1+key2+key3 for the On-Demand End Shortcut field.

  7. Click Save & Close.

See also

Overview of Unified Service Desk Performance Analyzer

Download Unified Service Desk Performance Analyzer

Overview of performance report user interface

Configure auditing and diagnostics in Unified Service Desk

Manage Options for Unified Service Desk