Como pode configurar o registo de diagnóstico do cliente

Artigo
04/19/2023

Existem duas formas de configurar o registo de diagnósticos do cliente Unified Service Desk:

Utilizar um registo de Definições de Auditoria e Diagnóstico criado e gerido na área do Unified Service Desk do Microsoft Dataverse.
Efetuar alterações manualmente no ficheiro UnifiedServiceDesk.exe.config. Este ficheiro tem de ser distribuído para cada ambiente de trabalho em que pretenda efetuar o registo de diagnósticos do cliente Unified Service Desk.

Além disso, é possível configurar o registo de diagnósticos especificamente para exceções que possam ocorrer no cliente Unified Service Desk.

Configurar o registo de diagnósticos de clientes do Unified Service Desk

Esta secção descreve como configurar manualmente o registo de diagnósticos no Unified Service Desk. Em vez de utilizar o procedimento descrito aqui, recomendamos que utilize a funcionalidade Definições de Auditoria e Diagnóstico, que fornece a administração centralizada do diagnóstico e a capadidade de ligar a um serviço de escuta personalizado. Mais informações: Configurar auditoria e diagnóstico no Unified Service Desk

Importante

O diagnóstico configurado manual (descrito aqui) deixará de funcionar depois de ativar um registo de Definições de Auditoria e Diagnóstico configurado para diagnóstico.
O Unified Service Desk também fornece uma API que permite configurar o registo de diagnósticos avançado para controlos alojados personalizados. Mais informações: Configurar o registo de diagnósticos avançado para controlos alojados personalizados

Este tópico descreve como alterar as funcionalidades de registo do cliente.

Pode ativar o registo com o ficheiro UnifiedServiceDesk.exe.config, disponível no diretório de instalação do cliente Unified Service Desk no computador. Para configurar o tipo de registo e a localização do ficheiro de registo do Unified Service Desk:

Abra o ficheiro de UnifiedServiceDesk.exe.config para edição. Se tiver instalado o cliente Unified Service Desk na localização predefinida, normalmente este ficheiro estará disponível em C:\Programas\Microsoft Dynamics 365 Customer Engagement USD\USD.

Aceda à secção <switches> no ficheiro:

<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>

Na secção de <switches>, especifique um tipo de registo (tal como EventTopicSwitch) e especifique um valor de nível de registo (como Error). A secção de <switches> controla os níveis de registo para várias origens. Por predefinição, o registo de erros está ativado para todos os parâmetros.
- Para obter informações sobre as origens de registo disponíveis, consulte Origens de Registo Disponíveis posteriormente neste tópico.
- Para obter informações sobre os valores que pode especificar para cada tipo de registo, consulte Níveis de Registo posteriormente neste tópico.

Para configurar a localização, o tamanho máximo de ficheiro ou os ficheiros de registo, aceda à secção <shareListeners> no ficheiro.

<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>

A secção <sharelisteners> controla o local e o tipo de registos gerados para o Unified Service Desk. Por predefinição, fileListener criará um ficheiro denominado UnifiedServiceDesk.log em c:\Users\<UserName>\AppData\Roaming\Microsoft\Microsoft\Microsoft Dynamics 365 Unified Service Desk\<Version> e USDDebugListener criará eventos no separador Saída de depuração do controlo alojado Depurador.

Se pretender alterar o nome do ficheiro de UnifiedServiceDesk.log, altere o valor do parâmetro de Location.
Por predefinição, é criado um novo registo do Unified Service Desk quando o tamanho do ficheiro do ficheiro de registo atual exceder 52,42 MB. Por predefinição, são mantidos até 10 ficheiros de registo de cada vez antes de o ficheiro de registo mais antigo ser eliminado.
- Para alterar o tamanho máximo do ficheiro de registo do Unified Service Desk, altere o valor, em bytes, do parâmetro MaxFileSize.
- Para alterar o número de registos mantidos antes de o registo mais antigo ser eliminado, altere o valor do parâmetro MaxFileCount. Se for utilizado zero (0), o registo de rollover será desativado e todos os registos de cliente do Unified Service Desk criados serão guardados.
Por predefinição, o registo de ficheiros e do depurador está ativado para todas as origens. Se pretender adicionar ou remover um serviço de escuta de uma origem de diagnóstico, localize a origem na secção de <sources> e modifique a secção de <listeners> da origem para incluir o serviço de escuta pretendido.

Por exemplo, para adicionar o registo de eventos para o Unified Service Desk, adicione o serviço de escuta do registo de eventos à origem 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>  
```
Isto reporta eventos no registo de eventos do Windows com a etiqueta “USD”, além do ficheiro e do Depurador. Para mais informações sobre os serviços de escuta de diagnóstico, consulte Serviços de escuta de registo de diagnóstico posteriormente neste tópico.

Origens de registo de diagnóstico

As origens de registo comuns de resolução de problemas estão listadas na tabela.

Nome de Origem	Description
EventTopicSwitch	Origem de registo detalhada da User Interface Integration (UII) para monitorizar o tráfego de mensagens na UII.
Microsoft.Uii.Common.Logging	Origem do Registo do UII geral para mensagens reportadas pelo UII.
Microsoft.Xrm.Tooling.CrmConnectControl	Origem de registo para o processo de início de sessão. Esta origem reporta informações de diagnóstico gerais ou detalhadas sobre o procedimento de início de sessão.
Microsoft.Xrm.Tooling.Connector.CrmServiceClient	Origem do registo para todas as interações de nível de dados do Dataverse. Esta origem reporta todas as interações com Dataverse, exceções e temporizações.
Microsoft.Xrm.Tooling.WebResourceUtility	Origem de registo para pedidos de Recurso Web através da hiperligação da interface do Dataverse.
Microsoft.Crm.UnifiedServiceDesk	Origem de registo para a funcionalidade central do Unified Service Desk. Esta origem de registo reporta ações e eventos principais do Unified Service Desk.
Microsoft.Crm.UnifiedServiceDesk.Dynamics	Origem de registo para o programa de arranque do sistema e processador de carregamento do Unified Service Desk. Esta origem reporta ações e eventos que fazem parte da inicialização e início da UII e Unified Service Desk.
Microsoft.Crm.UnifiedServiceDesk.CommonUtility.UserProfileManager	Origem de registo para ações que interagem com o sistema UserProfile; é uma parte do sistema de colocação em cache. Mais informações: Configurar colocação em cache do cliente para a sua aplicação do agente

Pode alternar cada uma destas origens de registo independentemente para suportar a resolução de problemas e o isolamento de problemas ou de informações no Unified Service Desk.

Níveis de registo de diagnóstico

Existem vários níveis distintos de registo disponíveis para utilização. No entanto, à medida que aumentar o nível de registo, são gerados mais dados e armazenados nos ficheiros de registo.

Nível do registo	Descrição
Desativado	Desativar todos os eventos desta origem.
Erro	Reportar apenas eventos de erro.
Aviso	Reporta eventos de erro e aviso.
Informação	Reportar eventos de erro, aviso e informações.
Verboso	Reportar erros, avisos, informações e eventos verbosos.
ActivityTracing	Reportar erros, avisos, informações, eventos verbosos e rastreio de atividades (nomes de método). Nota: ActivityTracing só está disponível em algumas das origens.
Tudo	Reporta todos os eventos acionados pelo sistema.

Serviços de escuta de registo de diagnóstico

Os serviços de escuta do registo de diagnóstico são utilizados para direcionar enviar o registo de diagnóstico para ficheiros, o registo de eventos ou outras origens. Por predefinição, todas as origens de diagnóstico estão associadas aos serviços de escuta predefinido (Depurador) e o ficheiro (texto). Pode configurar serviços de escuta de registo adicionais para o registo de diagnósticos do Unified Service Desk. Para mais informações sobre serviços de escuta predefinidos do.NET, consulte:

MSDN:DefaultTraceListener
MSDN:EventLogTraceListener
MSDN:TextWriterTraceListener

Também pode criar serviços de scuta personalizados para enviar registos de diagnóstico para uma localização à escolha. Os serviços de escuta personalizados são criados derivando uma classe da classe abstrata MSDN:TraceListener. Pode encontrar procedimentos detalhados do processo em CodeGuru.com.

Ver o ficheiro de registo de diagnóstico

Por predefinição, o registo de diagnósticos está ativado para a aplicação cliente do Unified Service Desk. Um ficheiro de registo UnifiedServiceDesk-<date>.log, está disponível em c:\Users\<UserName>\\Roaming\Microsoft\Microsoft Dynamics 365 Unified Service Desk\<Version> no computador cliente para registar erros operacionais na aplicação cliente. O ficheiro de registo é criado pela primeira vez que encontrar erros na aplicação cliente.

Quando ocorre um erro num controlo alojado, as informações registadas nos ficheiros de registo fornecem informações detalhadas sobre a exceção, tal como o controlo alojado de origem que causou a exceção juntamente com os detalhes da exceção. Tenha em atenção que todo o código JavaScript que causou a exceção não está registado. Só é registado o código da falha, juntamente com a descrição da exceção.

Segue-se um exemplo de detalhe de exceção registado.

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()

Processo de Monitorização do Unified Service Desk

O Processo de Monitorização do Unified Service Desk (usdmp.exe) é um serviço que monitoriza continuamente o estado de funcionamento do Unified Service Desk e cessa, por predefinição, após 5 segundos, quaisquer instâncias de processos do browser que não estejam a responder e que façam com que o Unified Service Desk deixe de responder. Se uma instância do processo de browser não estiver a responder, mas o Unified Service Desk estiver a responder, a instância do processo do browser não será terminada. Para mais informações sobre como alterar a duração da opção global ProcessTerminationThreshold para a cessão de processos do browser, consulte Gerir Opções para o Unified Service Desk.

Relatórios de diagnóstico de erros

A existência de registos e relatórios exaustivos e detalhados das ocorrências durante uma falha de componente, aplicação ou sistema pode ajudar a identificar quando e como a falha ocorreu. Além do registo de diagnósticos padrão, os relatórios de diagnóstico de erros registam as informações de estado do sistema e da aplicação na eventualidade de uma exceção no cliente Unified Service Desk. Poderá encontrar mais informações sobre exceções em Como o Unified Service Desk lida com os erros de aplicação e sistema.

Pastas e ficheiros criados durante uma exceção

Na eventualidade de uma exceção, os relatórios de diagnósticos de erros criam uma pasta no computador local denominada DiagnosticsLogs_data e hora, onde a data e a hora estão no formato ano-mês-data_hora, como, por exemplo, DiagnosticLogs_20170322_173643. É criada a seguinte pasta e os seguintes ficheiros na pasta DiagnosticsLogs.

Ficheiro de diagnóstico	Descrição
UnifiedServiceDesk_dataehora.log	O registo de diagnósticos padrão criado é anexado quando o cliente Unified Service Desk está em execução. O ficheiro contém informações de registo para o cliente Unified Service Desk (UnifiedServiceDesk.exe). Os ficheiros atuais são movidos para a pasta DiagnosticsLogs na eventualidade de uma exceção.
UnifiedServiceDeskMonitoring_data.log	O registo de diagnósticos padrão criado é anexado quando o cliente Unified Service Desk está em execução. Contém informações de registo para o processo de monitorização do Unified Service Desk (usdmp.exe), que é um processo que monitoriza o estado de funcionamento do cliente Unified Service Desk. Os ficheiros atuais são movidos para a pasta DiagnosticsLogs na eventualidade de uma exceção. Mais informações: Processo de Monitorização do Unified Service Desk
Eventlogs (pasta)	Pasta criada na eventualidade de uma exceção fatal ou não fatal. Contém ficheiros de texto de relatórios de erros, bem como registos de eventos e de sistema do Windows.
ExitReport.txt	Registo de saída na eventualidade de uma exceção fatal ou não fatal. Contém informações de estado do processo, como, por exemplo, um nome de computador, versão do Unified Service Desk, ID do processo, código de saída e hora de saída.
MachineHealthReport.txt	Registo de saída na eventualidade de uma exceção fatal ou não fatal. Contém informações de estado de sistema, como, por exemplo, processador do computador, sistema operativo, detalhes do monitor, idioma e versão do browser.
ProcessReport.csv	Registo de saída na eventualidade de uma exceção fatal ou não fatal. Fornece uma lista completa de todos os processos que estavam em execução no sistema no momento da exceção.
RegistryLog.txt	Registo de saída na eventualidade de uma exceção fatal ou não fatal. Inclui uma cópia baseada em texto das subchaves do Registo do Windows para o Internet Explorer.
UnifiedServiceDesk_processId_CrashDump_dataehora.dmp	Criado apenas na eventualidade de uma exceção fatal não processada ou quando invocado manualmente através da combinação de teclas da opção global ManualDumpShortcut. Fornece um ficheiro de informação de falha de sistema de memória completa para UnifiedServiceDesk.exe. Tenha em atenção que, para ver o ficheiro de informação de falha de sistema, precisa do Visual Studio ou de outra ferramenta de visualização de ficheiros de informação de falha de sistema do Windows.

Configurar relatórios de diagnóstico de erros

Iniciar sessão no Administrador do Unified Service Desk.
Selecione Auditoria e Diagnóstico em Definições avançadas.
Selecione + Novo e selecione DiagnosticsConfiguration.
Selecione ou introduza os valores pretendidos, como a monitorização, monitorização de saída e a localização da pasta de registos de diagnóstico. Mais informações: Diagnóstico
Selecione Guardar e Fechar.