Cómo configurar el registro de diagnóstico del cliente

Artículo
04/19/2023

Hay dos formas de configurar el registro de diagnóstico del cliente de Unified Service Desk:

Mediante un registro de Configuración de diagnóstico y auditoría que se crea y administra en el área Unified Service Desk de Microsoft Dataverse.
Realizando manualmente los cambios en el archivo UnifiedServiceDesk.exe.config. Este archivo se debe a distribuir a cada escritorio donde desee registro de diagnóstico del cliente de Unified Service Desk.

Además, puede configurar el registro de diagnóstico específicamente para las excepciones que pueden producirse en el cliente de Unified Service Desk.

Configure el registro de diagnóstico del cliente en Unified Service Desk

Esta sección describe cómo configurar manualmente el registro de diagnóstico en Unified Service Desk. En lugar de usar el procedimiento que se describe aquí, se recomienda usar la característica Configuración de diagnóstico y auditoría que proporciona administración centralizada de diagnóstico y capacidad de conectarse a una escucha personalizada. Más información: Configurar la auditoría y diagnósticos en Unified Service Desk

Importante

El diagnóstico configurado manualmente (descrito aquí) no funcionará más después de habilitar un registro de Configuración de diagnóstico y auditoría que está configurado para diagnóstico.
Unified Service Desk también proporciona una API que le permite configurar registros de diagnóstico detallados para controles hospedados personalizados. Más información: Configurar registros de diagnóstico mejorados para controles hospedados personalizados

Este tema describe cómo cambiar características de registro de clientes.

Puede habilitar el registro con el archivo UnifiedServiceDesk.exe.config, que está disponible en el directorio de instalación del cliente de Unified Service Desk en su equipo. Para configurar el tipo de registro y la ubicación del archivo de registro de Unified Service Desk:

Abra el archivo UnifiedServiceDesk.exe.config para editarlo. Si instaló el cliente de Unified Service Desk en la ubicación predeterminada, este archivo suele estar disponible en C:\Archivos de programa\Microsoft Dynamics 365 Customer Engagement USD\USD.

Vaya a la sección <switches> del archivo:

<switches>  
<!--   
     Possible values for switches: Off, Error, Warning, Information, Verbose  
        Verbose:      includes Error, Warning, Info, Trace levels  
        Information:  includes Error, Warning, Info levels  
        Warning:      includes Error, Warning levels  
        Error:        includes Error level  
 -->  
    <add name="EventTopicSwitch" value="Error"/>  
    <add name="Microsoft.Uii.Common.Logging" value="Error"/>  
    <add name="Microsoft.Xrm.Tooling.CrmConnectControl" value="Error"/>  
    <add name="Microsoft.Xrm.Tooling.Connector.CrmServiceClient" value="Error"/>  
    <add name="Microsoft.Xrm.Tooling.WebResourceUtility" value="Error"/>  
    <add name="Microsoft.Crm.UnifiedServiceDesk" value="Error"/>  
    <add name="Microsoft.Crm.UnifiedServiceDesk.Dynamics" value="Error"/>  
    <add name="Microsoft.Crm.UnifiedServiceDesk.CommonUtility.UserProfileManager" value="Error"/>  
    <add name="UnifiedServiceDesk.KPIControl" value="Error"/>  
</switches>

En la sección de <switches>, especifique un origen de registro (como EventTopicSwitch), y después especifique un valor de nivel de registro (como Error). La sección de <switches> controla los niveles de registro para diversos orígenes. De forma predeterminada, el registro de errores está habilitado para todos los conmutadores:
- Para obtener información acerca de los orígenes de registro disponibles, consulte Orígenes de registro disponibles más adelante en este tema.
- Para obtener información acerca de los valores que puede especificar para cada origen de registro, consulte Niveles de registro más adelante en este tema.

Para configurar la ubicación, el tamaño máximo de archivo, y el comportamiento de sustitución de los archivos de registro, vaya a la sección <shareListeners> en el archivo.

<sharedListeners>  
   <add name="fileListener"  
      type="Microsoft.Xrm.Tooling.Connector.DynamicsFileLogTraceListener, Microsoft.Xrm.Tooling.Connector"  
    BaseFileName="UnifiedServiceDesk"  
    Location="LocalUserApplicationDirectory" MaxFileSize ="52428800" MaxFileCount="10"/>  
   <add name="USDDebugListener" type="Microsoft.Crm.UnifiedServiceDesk.Dynamics.UsdTraceListener, Microsoft.Crm.UnifiedServiceDesk.Dynamics" />  
   <add name="ADALListener"  
    type="Microsoft.Xrm.Tooling.Connector.DynamicsFileLogTraceListener, Microsoft.Xrm.Tooling.Connector"  
    BaseFileName="ADAL"  
     Location="LocalUserApplicationDirectory" MaxFileSize ="52428800" MaxFileCount="10"/>  
</sharedListeners>

La sección <sharelisteners> controla la ubicación y el tipo de registros que se generan para Unified Service Desk. De forma predeterminada, fileListener creará un archivo llamado UnifiedServiceDesk.log en el directorio c:\Users\<UserName>\AppData\Roaming\Microsoft\Microsoft\Microsoft Dynamics 365 Unified Service Desk\<Version> y USDDebugListener creará eventos en la pestaña Salida del depurador del control hospedado de depurador.

Si desea cambiar la ubicación del archivo UnifiedServiceDesk.log, cambie el valor del parámetro Location.
De forma predeterminada, se crea un registro de Unified Service Desk después de que el tamaño de archivo del registro actual supere 52,42 MB. De forma predeterminada, hasta 10 archivos de registro se mantienen a la vez antes de que se elimine el archivo de registro más antiguo.
- Para cambiar el tamaño máximo del archivo de registro de Unified Service Desk, cambie el valor, en bytes, del parámetro MaxFileSize.
- Para cambiar el número de registros mantenidos antes de que se elimine el registro más antiguo, cambie el valor del parámetro MaxFileCount. Si se usa cero (0) se deshabilitará el registro de sustituciones y se guardarán todos los registros de clientes de Unified Service Desk creados.
De manera predeterminada, el registro del archivo y depurador está habilitado para todos los orígenes. Si desea agregar o quitar un agente de escucha de un origen de diagnóstico, busque el origen requerido en la sección <sources> y, a continuación, modifique la sección <listeners> del origen para incluir el agente de escucha que desee.

Por ejemplo, para agregar registro de eventos para Unified Service Desk, agregue el atente de escucha de registro de eventos al origen de Microsoft.Crm.UnifiedServiceDesk.
```
<source name="Microsoft.Crm.UnifiedServiceDesk" switchName="Microsoft.Crm.UnifiedServiceDesk" switchType="System.Diagnostics.SourceSwitch">  
    <listeners>  
        <add name="fileListener"/>  
        <add name="USDDebugListener" />  
        <add name="eventLogListener" type="System.Diagnostics.EventLogTraceListener" initializeData="USD"/>  
    </listeners>  
</source>  
```
Esto notificará eventos al registro de eventos de Windows con la etiqueta "USD", además del archivo y depurador. Para obtener más información sobre agentes de escucha de diagnóstico, consulte Agentes de escucha de registro de diagnóstico más adelante en este tema.

Orígenes de registro de diagnóstico

En la tabla siguiente se muestran orígenes de registro de solución de problemas comunes.

Nombre de origen	Description
EventTopicSwitch	Origen de registro detallado de User Interface Integration (UII) para supervisar tráfico de mensajería en UII.
Microsoft.Uii.Common.Logging	Origen de registro de UII general para mensajes notificados por UII.
Microsoft.Xrm.Tooling.CrmConnectControl	Origen del registro para el proceso de inicio de sesión. Este origen notificará información de diagnóstico general o detallada acerca del procedimiento de inicio de sesión.
Microsoft.Xrm.Tooling.Connector.CrmServiceClient	Origen del registro para todas las interacciones a nivel de datos de Dataverse. Este origen notificará todas las interacciones con Dataverse, excepciones y controles de tiempo.
Microsoft.Xrm.Tooling.WebResourceUtility	Origen del registro para solicitudes de datos de recursos web mediante vínculo de la interfaz de Dataverse.
Microsoft.Crm.UnifiedServiceDesk	Origen del registro para la funcionalidad principal de Unified Service Desk. Este origen de registro notificará acciones y eventos que son básicos para Unified Service Desk.
Microsoft.Crm.UnifiedServiceDesk.Dynamics	Origen del registro para el procesador de carga y arranque de Unified Service Desk. Este origen notificará acciones y eventos que forman parte de la inicialización y el inicio de UII y Unified Service Desk.
Microsoft.Crm.UnifiedServiceDesk.CommonUtility.UserProfileManager	Origen del registro para acciones que interactúan con el sistema de UserProfile; forma parte del sistema de almacenamiento en caché. Más información: Configurar almacenamiento en caché del cliente para su aplicación de agente

Puede alternar cada uno de estos orígenes del registro independientemente para admitir la solución de problemas y el aislamiento de problemas o la información de Unified Service Desk.

Niveles de registro de diagnóstico

Existen varios niveles de registro distintos disponibles para su uso. Sin embargo, cuando aumenta el nivel de registro, se generan y almacenan más datos en los archivos de registro.

Nivel de registro	Descripción
Desconectado	Deshabilita todos los eventos de este origen.
Error	Notifica solo eventos de error.
Advertencia	Notifica errores y eventos de advertencia.
Información	Notifica errores, advertencias y eventos de información.
Detallado	Notifica errores, advertencias, información y eventos detallados.
ActivityTracing	Notifica informes, advertencias, información y eventos detallados, así como seguimiento de actividad (nombres de método). Nota: ActivityTracing solo está disponible en algunos de los orígenes.
Todas	Notifica todos los eventos generados por el sistema.

Agentes de escucha de registro de diagnóstico

Los agentes de escucha de registro de diagnóstico se utilizan para enviar la salida del registro diagnóstico a archivos, al registro de eventos o a otros orígenes. De forma predeterminada, todos los orígenes de diagnóstico se conectan a agentes de escucha predeterminados (depurador) y de archivo (texto). Puede configurar agentes de escucha de registro adicionales para el registro de diagnóstico de Unified Service Desk. Para obtener más información acerca de los agentes de escucha predeterminados de .NET, consulte:

MSDN:DefaultTraceListener
MSDN:EventLogTraceListener
MSDN:TextWriterTraceListener

También puede crear escuchas personalizadas para enviar los registros de diagnóstico a la ubicación que elija. Los agentes de escucha personalizados se crean derivando una clase de la clase abstracta MSDN:TraceListener. Puede buscar un tutorial del proceso en CodeGuru.com.

Ver el archivo de registro de diagnóstico

De forma predeterminada, el registro de diagnósticos esté habilitado para la aplicación cliente de Unified Service Desk. Archivo de registro, UnifiedServiceDesk-<date>.log, está disponible en c:\Users\<UserName>\\Roaming\Microsoft\Microsoft Dynamics 365 Unified Service Desk\<Version> en el equipo cliente para registrar errores operativos en la aplicación cliente. El archivo de registro se crea la primera vez que se encuentran errores en la aplicación cliente.

Cuando se produce un error en un control hospedado, la información registrada en los archivos de registro proporciona información detallada sobre la excepción como el control hospedado de origen que produjo la excepción junto con los detalles de la excepción. Tenga en cuenta que no se registra el código JavaScript completo que produjo la excepción. Solo se registra el código defectuoso junto con la descripción de la excepción.

Este es un detalle de excepción de ejemplo que se registra.

Microsoft.Crm.UnifiedServiceDesk.Dynamics   Error   2   12/27/2016 11:54:15 AM  Origin:AppdomianUnhandledException, IsFatal:True  
Source: DemoControl  
Target: Void throwExceptionMethod()  
Exception: Exception in custom control  
StackTrace:   at DemoControl.USDControl.throwExceptionMethod()  
   at System.Threading.ExecutionContext.RunInternal(ExecutionContext executionContext, ContextCallback callback, Object state, Boolean preserveSyncCtx)  
   at System.Threading.ExecutionContext.Run(ExecutionContext executionContext, ContextCallback callback, Object state, Boolean preserveSyncCtx)  
   at System.Threading.ExecutionContext.Run(ExecutionContext executionContext, ContextCallback callback, Object state)  
   at System.Threading.ThreadHelper.ThreadStart()

Proceso de supervisión de Unified Service Desk

El proceso de supervisión de Unified Service Desk (usdmp.exe) es un servicio que vigila continuamente el estado de Unified Service Desk, y finaliza, de forma predeterminada después de 5 segundos, cualquier instancia del proceso del explorador que deje de responder y que haga que Unified Service Desk deje de responder. Si una instancia del proceso de explorador no responde, pero Unified Service Desk sí responde, la instancia del proceso de explorador no será finalizada. Para obtener más información acerca de cómo cambiar la duración de la opción global de ProcessTerminationThreshold para la terminación de procesos del explorador, vea Administrar opciones para Unified Service Desk.

Informes de diagnósticos de error

Disponer de registros e informes completos y detallados que se producen durante un error de componente, aplicación o sistema puede facilitar la identificación de cuándo y cómo apareció el error. Además del registro de diagnóstico estándar, los informes de diagnóstico de errores registran información del estado del sistema y la aplicación en caso de una excepción en el cliente de Unified Service Desk. Para obtener más información acerca de excepciones, consulte Cómo Unified Service Desk controla los errores de aplicaciones y del sistema.

Carpetas y archivos creados durante una excepción

En caso de excepción, los informes de diagnóstico de errores crean una carpeta en el equipo local denominada DiagnosticsLogs_fecha y hora, donde fecha y hora están en formato año-mes-día_hora en, como DiagnosticLogs_20170322_173643. En la carpeta DiagnosticsLogs se crean la carpeta y los archivos siguientes.

Archivo de diagnóstico	Descripción
UnifiedServiceDesk_dateandtime.log	Registro de diagnóstico estándar que se crea y se anexa cuando el cliente de Unified Service Desk se está ejecutando. El archivo contiene información de registro para el cliente de Unified Service Desk (UnifiedServiceDesk.exe). Los archivos actuales se mueven a la carpeta DiagnosticsLogs en caso de excepción.
UnifiedServiceDeskMonitoring_fecha.log	Registro de diagnóstico estándar que se crea y se anexa cuando el cliente de Unified Service Desk se está ejecutando. Contiene información de registro para el proceso de supervisión de Unified Service Desk (usdmp.exe), que es un proceso que controla el estado del cliente de Unified Service Desk. Los archivos actuales se mueven a la carpeta DiagnosticsLogs en caso de excepción. Más información: Proceso de supervisión de Unified Service Desk
Eventlogs (carpeta)	Carpeta creada en caso de excepción grave o no grave. Contiene registros de eventos de aplicaciones y del sistema Windows y archivos de texto de informes de errores.
ExitReport.txt	Registro de salida creado en caso de excepción grave o no grave. Contiene información de estado de procesos, como nombre del equipo, versión de Unified Service Desk, identificador del proceso, código de salida, y hora de salida.
MachineHealthReport.txt	Registro de salida creado en caso de excepción grave o no grave. Contiene información de estado del sistema, como procesador del equipo, sistema operativo, detalles de supervisión, idioma, y la versión del explorador.
ProcessReport.csv	Registro de salida creado en caso de excepción grave o no grave. Proporciona una lista completa de todos los procesos que se ejecutaban en el sistema en el momento de la excepción.
RegistryLog.txt	Registro de salida creado en caso de excepción grave o no grave. Incluye una copia de texto de las subclaves del Registro de Windows para Internet Explorer.
UnifiedServiceDesk_processId_CrashDump_dateandtime.dmp	Creado solo en el caso de una excepción no controlada o cuando se invoca manualmente mediante la combinación de teclado de la opción global de ManualDumpShortcut. Proporciona un archivo de volcado de memoria completo para UnifiedServiceDesk.exe. Tenga en cuenta que para ver el archivo de volcado, necesita Visual Studio u otra herramienta de visualización de archivos de volcado de Windows.

Configurar informe de diagnóstico de errores

Inicie sesión en el Administrador de Unified Service Desk.
Seleccione Auditoría y diagnóstico en Configuración avanzada.
Seleccione + Nuevo y luego seleccione DiagnosticsConfiguration.
Seleccione o especifique los valores que desee, como seguimiento, supervisión de salida y la ubicación de la carpeta de registros de diagnóstico. Más información: Diagnóstico
Seleccione Guardar y cerrar.

Consulte también

Configurar auditoría y diagnóstico en Unified Service Desk

Soporte de depuración en Unified Service Desk para solucionar problemas

Depurar problemas en Unified Service Desk