Skip to content

Latest commit

 

History

History
51 lines (39 loc) · 4.02 KB

configure-enhanced-diagnostic-logging-custom-hosted-controls.md

File metadata and controls

51 lines (39 loc) · 4.02 KB
Raw
title description ms.date ms.topic author ms.author search.audienceType ms.custom
Configure enhanced diagnostic logging for custom hosted controls | MicrosoftDocs
Learn how to configure diagnostic logging to record operational events and errors in the client application, and troubleshoot performance issues.
06/27/2024
article
gandhamm
mgandham
customizer
developer
evergreen

Configure enhanced diagnostic logging for custom hosted controls

[!INCLUDEpn_unified_service_desk] enables you to configure diagnostic logging to record operational events and errors in the client application to a log file, which can be later used to identify and troubleshoot performance issues or errors. For more information about diagnostic logging, see Configure client diagnostic logging in Unified Service Desk.

Diagnostic logging for predefined hosted control types has been enhanced to provide rich information about an exception or error, such as the source where the error occurred (hosted control name, hosted control type, session ID) and detailed information about the error along with the stack trace. The rich diagnostic information greatly improves in quickly identifying and troubleshooting issues in [!INCLUDEpn_unified_service_desk].

You can leverage the same enhanced diagnostic logging capabilities available in the predefined hosted controls for your custom controls by using the LogException method in your custom control code to provide rich information about the exception (if it occurs) so that its easier to identify if the issue is caused by your custom code or some other control in [!INCLUDEpn_unified_service_desk].

LogException method is overloaded, and internally uses DynamicsLogger to provide rich diagnostic information for exceptions in your custom control. Use one of the following two signatures to use this method:

  • Pass in the exception object and the event type that caused the trace (optional). If you do not specify the event type, by default Error trace event type is passed:

    LogException(Exception ex, TraceEventType eventType = TraceEventType.Error);

  • Pass in the string value for custom error message, event type that caused the trace, and the exception object:

    LogException(string errorMessage, TraceEventType eventType, Exception ex);

    Here is an example of the diagnostic information as a result of using LogException method where detailed information about the source (session ID, hosted control name and type) and the exception detail is logged:

Exception raised in :  Session ID : d14893b0-6859-4827-9ddc-949d3fd36854 - Application : DemoControl - USD Component Type : USDHostedControl - Hosting Type : USD Hosted Control - Display Group : MainPanel -   
Exception details:   
Source: DemoControl  
Target: Void ThrowAndLogException_Click(System.Object, System.Windows.RoutedEventArgs)  
Exception: SampleLogException  
StackTrace:   at DemoControl.USDControl.ThrowAndLogException_Click(Object sender, RoutedEventArgs e

See also

Configure client diagnostic logging in Unified Service Desk
Unified Service Desk Hosted Controls
Create custom Unified Service Desk hosted control

[!INCLUDEfooter-include]