Configurar registro de diagnóstico do cliente no Unified Service Desk

Artigo
05/15/2017

Publicado: novembro de 2016

Aplicável a: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2013, Dynamics CRM 2015, Dynamics CRM 2016

Há duas maneiras de configurar o log de diagnóstico do cliente da Unified Service Desk:

Usando um log de Configurações de Auditoria e Diagnóstico que é criado e gerenciado na área da Unified Service Desk do Microsoft Dynamics 365.
Fazendo alterações manualmente no arquivo UnifiedServiceDesk.exe.config. Este arquivo deve ser distribuído a cada área de trabalho na qual você deseja o log de diagnóstico do cliente da Unified Service Desk.

Além disso, você pode configurar o registro de diagnóstico especificamente para as exceções que podem ocorrer no cliente do Unified Service Desk.

Neste tópico

Configurar o log de diagnóstico do cliente Unified Service Desk

Fontes de log diagnóstico

Níveis do log de diagnóstico

Ouvintes de log diagnóstico

Vendo o arquivo de log de diagnóstico

Processo de Monitoramento do Unified Service Desk

Relatório de diagnóstico de erro

Configurar o log de diagnóstico do cliente Unified Service Desk

Esta seção descreve como configurar manualmente o log de diagnóstico no Unified Service Desk. Em vez de usar o procedimento descrito aqui, recomendamos usar o recurso de Configurações de Auditoria e Diagnóstico que fornece administração centralizada de diagnósticos e a capacidade de conectar-se a um ouvinte personalizado.Para obter mais informações:Configurar auditoria e diagnósticos no Unified Service Desk

Importante

O diagnóstico configurado manualmente (conforme descrito aqui), não funcionará mais depois que você ativar um registro de Configurações de Diagnóstico e Auditoria que foi configurado para diagnóstico.
O Unified Service Desk também fornece uma API que permite configurar um log de diagnóstico avançado para controles hospedados personalizados. Mais informações: MSDN: Configurar log de diagnóstico avançado para controles hospedados personalizados

Este tópico descreve como alterar as características do log do cliente.

Você pode habilitar o registro usando o arquivo UnifiedServiceDesk.exe.config, disponível no diretório de instalação do cliente Unified Service Desk do computador. Para configurar o tipo de log e o local do arquivo de log Unified Service Desk:

Abra o arquivo UnifiedServiceDesk.exe.config para edição. Se você instalou o cliente Unified Service Desk na localização padrão, o arquivo normalmente estará disponível em C:\Program Files\Microsoft Dynamics 365 USD\USD.

Vá até a seção <switches> no arquivo:

<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 seção <switches>, especifique uma origem de log (como EventTopicSwitch) e especifique um valor do nível de log (como Error). A seção <switches> controla os níveis de log de várias origens. Por padrão, o log de erros está habilitado para todas as opções:
- Para obter informações sobre as origens de log disponíveis, consulte Fontes de log diagnóstico mais adiante neste tópico.
- Para obter informações sobre os valores que você pode especificar para cada origem de registro, consulte Níveis do log de diagnóstico mais adiante neste tópico.

Para configurar o local, tamanho máximo de arquivo e comportamento de substituição dos arquivos de log, vá para a seção <shareListeners> do arquivo.

<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 seção <sharelisteners> controla o local e tipos de logs gerados gerados para Unified Service Desk. Por padrão o, fileListener criará um arquivo chamado UnifiedServiceDesk.log no diretório c:\Users\<UserName>\AppData\Roaming\Microsoft\UnifiedServiceDesk\<Version> e o USDDebugListener criará eventos na guia MSDN: Saída de depuração do controle hospedado do Depurador.

Se desejar alterar a localização do arquivo UnifiedServiceDesk.log, altere o valor do parâmetro Location.
Por padrão, um novo log do Unified Service Desk é criado depois que o tamanho do arquivo de log atual exceder 52.42 MB. Por padrão, até 10 arquivos de log são mantidos simultaneamente antes do arquivo de log mais antigo ser excluído.
- Para alterar o tamanho do arquivo de log do Unified Service Desk, altere o valor, em bytes do parâmetro MaxFileSize.
- Para alterar o número de logs mantidos antes que o log mais antigo seja excluído, altere o valor do parâmetro MaxFileCount. Se zero (0) for usado, o registro de substituição será desativado e todos os logs do cliente do Unified Service Desk serão salvos.
Por padrão, o arquivo e o depurador de log estão habilitados para todas as origens. Se quiser adicionar ou remover um ouvinte de uma origem diagnóstica, localize a origem necessária na seção <sources> e modifique a seção <listeners> da origem para incluir o ouvinte desejado.

Por exemplo, para adicionar o log de evento para o Unified Service Desk, adicione o ouvinte do log de evento à 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 relatará eventos para o log de evento Windows com a marca “USD”, além do arquivo e depurador. Para obter mais informações sobre ouvintes diagnósticos, consulte Ouvintes de log diagnóstico mais adiante neste tópico.

Fontes de log diagnóstico

As origens comuns de log para solução de problemas estão listadas na tabela a seguir.

Nome da Origem	Descrição
EventTopicSwitch	Origem detalhada de log User Interface Integration (UII) para monitorar o tráfego de mensagens dentro do UII.
Microsoft.Uii.Common.Logging	Fonte do Log Geral do UII geral para mensagens relatadas pelo UII.
Microsoft.Xrm.Tooling.CrmConnectControl	Origem de log para o processo de entrada para Dynamics 365. Esta origem relatará informações gerais ou detalhadas de diagnósticos sobre o procedimento de entrada.
Microsoft.Xrm.Tooling.Connector.CrmServiceClient	Origem de log para todas as interações no nível de dados Dynamics 365. Esta origem relatará todas as interações com Dynamics 365, exceções e controles de tempo.
Microsoft.Xrm.Tooling.WebResourceUtility	Origem do log para solicitações de dados de recurso de Web pelo link da interface Dynamics 365.
Microsoft.Crm.UnifiedServiceDesk	Origem de log para a funcionalidade Unified Service Desk principal. Esta origem de log relatará as ações e os eventos fundamentais para Unified Service Desk.
Microsoft.Crm.UnifiedServiceDesk.Dynamics	Origem de log para o processador de correia e de carga de bota Unified Service Desk. Esta origem relatará ações e eventos que fazem parte da inicialização e começo do UII e Unified Service Desk.
Microsoft.Crm.UnifiedServiceDesk.CommonUtility.UserProfileManager	Origem de log para ações que interagem com o sistema do perfil do usuário; isto faz parte do sistema do cache.Para obter mais informações:Configurar o cache do cliente no Unified Service Desk

Você pode alternar cada uma dessas origens de log de forma independente para oferecer suporte à solução de problemas e ao isolamento de problemas ou informações dentro do Unified Service Desk.

Níveis do log de diagnóstico

Há vários níveis de diferentes log disponíveis para uso. Entretanto, conforme você aumenta o nível de log, mais dados serão gerados e armazenados nos arquivos de log.

Nível de log	Descrição
Desligado	Desabilitar todos os eventos desta fonte.
Erro	Reportar somente eventos de erro.
Aviso	Reportar erros e eventos de aviso.
Informações	Relatar erros, avisos e eventos de informações.
Modo detalhado	Relatar erros, avisos, informações e eventos de informações detalhadas.
ActivityTracing	Relatar erros, avisos, informações e eventos de informações detalhadas e atividade de rastreamento (nomes dos métodos). Dica ActivityTracing está disponível somente em algumas origens.
Tudo	Reportar todos os eventos levantados pelo sistema.

Ouvintes de log diagnóstico

Os ouvintes de log diagnósticos são usados para identificar a saída do log diagnóstico para os arquivos, o log de eventos ou outras origens. Por padrão, as origens diagnósticas são presas aos ouvintes padrão (depurador) e arquivo (texto). Você pode configurar ouvintes de log adicionais para o log diagnóstico Unified Service Desk. Para obter mais informações sobre os ouvintes padrão .NET, consulte:

Você também pode criar ouvintes personalizados para enviar logs de diagnóstico a um local de sua escolha. Os ouvintes personalizados são criados ao derivar uma classe a partir da classe abstrata TraceListener. Você pode encontrar um passo a passo do processo em CodeGuru.como processo.

Vendo o arquivo de log de diagnóstico

Por padrão, o registro de diagnóstico está habilitado para o aplicativo cliente Unified Service Desk. Um arquivo de log, UnifiedServiceDesk-<data>.log, está disponível em c:\Users\<nome do usuário>\AppData\Roaming\Microsoft\Microsoft Dynamics 365 Unified Service Desk\<Versão> no computador cliente para registro de erros operacionais no aplicativo cliente. O arquivo de log é criado na primeira vez que você encontra qualquer problemas no aplicativo cliente.

Quando ocorre um erro em um controle hospedado, as informações registradas nos arquivos de log fornecem detalhes sobre a exceção, como o controle hospedado que causou a exceção e os detalhes da exceção. Observe que o código Javascript inteiro que causou a exceção não é registrado em log. Apenas o código com defeito e a descrição da exceção são registrados em log.

Dica

O tratamento de erro e o log descritos aqui foram introduzidos pela primeira vez no Unified Service Desk 2.2.1.

Estes são os detalhes de uma exceção de amostra que são registrados em log.

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 Monitoramento do Unified Service Desk

O Processo de Monitoramento (usdmp.exe) do Unified Service Desk é um serviço que monitora continuamente a integridade do Unified Service Desk e encerra, por padrão após 5 segundos, quaisquer instâncias do processo do navegador que não estão respondendo e que tornam o Unified Service Desk não responsivo. Se uma instância de processo de navegador não estiver respondendo, mas Unified Service Desk estiver, a instância de processo de navegador não será fechada. Para obter mais informações sobre como alterar a duração da opção global ProcessTerminationThreshold para encerramento do processo do navegador, consulte Gerenciar opções do Unified Service Desk.

Relatório de diagnóstico de erro

Ter o registro e o relatório detalhado e abrangente do que ocorre durante uma falha do componente, aplicativo ou sistema pode ajudar a identificar quando e como ocorreu a falha. Além do registro de diagnóstico padrão, o relatório de diagnóstico de erro registra informações de estado do aplicativo e do sistema, no caso de uma exceção no cliente do Unified Service Desk. Mais informações sobre exceções podem ser encontradas em Como o Unified Service Desk trata erros do sistema e do aplicativo.

Dica

Os recursos do relatório de diagnóstico de erro descritos aqui foram introduzidos pela primeira vez no Unified Service Desk 2.2.2.

Arquivos e pastas criados durante uma exceção

No caso de uma exceção, o relatório de diagnósticos de erro cria uma pasta no computador local chamada DiagnosticsLogs_data e hora, na qual data e hora está no formato ano-mês-data_hora, como por exemplo, DiagnosticLogs_20170322_173643. Na pasta DiagnosticsLogs os seguintes arquivos e pastas são criados.

Arquivo de diagnóstico	Descrição
UnifiedServiceDesk_dateandtime.log	O log de diagnóstico padrão que é criado e anexado quando o cliente do Unified Service Desk está sendo executado. O arquivo contém informações de registro do cliente do Unified Service Desk (UnifiedServiceDesk.exe). Os arquivos atuais são movidos para a pasta DiagnosticsLogs, no caso de uma exceção.Para obter mais informações:Configure client diagnostic logging in Unified Service Desk
UnifiedServiceDeskMonitoring_date.log	O log de diagnóstico padrão que é criado e anexado quando o cliente do Unified Service Desk está sendo executado. Contém as informações de registro do processo de monitoramento do Unified Service Desk (usdmp.exe), que é um processo que monitora a integridade do cliente do Unified Service Desk. Os arquivos atuais são movidos para a pasta DiagnosticsLogs, no caso de uma exceção.Para obter mais informações:Processo de Monitoramento do Unified Service Desk
Eventlogs (pasta)	Pasta criada no caso de uma exceção fatal ou não fatal. Contém o sistema Windows e os logs de evento do aplicativo e os arquivos de texto do relatório de erros.
ExitReport.txt	Log de saída criado no caso de uma exceção fatal ou não fatal. Contém as informações de estado do processo como, o nome do computador, a versão do Unified Service Desk, a ID do processo, o código de saída e o horário de saída.
MachineHealthReport.txt	Log de saída criado no caso de uma exceção fatal ou não fatal. Contém as informações de estado do sistema, como o processador do computador, o sistema operacional, os detalhes do monitoramento, o idioma e a versão do navegador.
ProcessReport.csv	Log de saída criado no caso de uma exceção fatal ou não fatal. Fornece uma ampla lista com todos os processos que estiverem em execução no sistema no momento da exceção.
RegistryLog.txt	Log de saída criado no caso de uma exceção fatal ou não fatal. Contém uma cópia com base no texto das subchaves do Registro do Windows para o Internet Explorer.
UnifiedServiceDesk_processId_CrashDump_dateandtime.dmp	Criado somente no caso de uma exceção fatal não tratada ou quando chamado manualmente, usando a combinação global da opção do teclado ManualDumpShortcut. Fornece um arquivo de despejo de memória completo de UnifiedServiceDesk.exe. Observe que, para exibir o arquivo de despejo, você precisa do Microsoft Visual Studio ou outra ferramenta de exibição do arquivo de dump do Windows.

Configurar o relatório de diagnóstico de erro

No aplicativo Web, vá para Configurações > Unified Service Desk > Opções.
Clique em Novo e, em seguida, selecione DiagnosticsConfiguration.
Insira um ou mais valores que estão listados na seguinte tabela separados por ponto-e-vírgula (;).Para obter mais informações:Valores da opção do diagnóstico do relatório de erros

Por exemplo, esta configuração altera o diretório dos arquivos de log, reduz o tamanho máximo da pasta do log de diagnóstico para 2 GB e altera a combinação de teclas de atalho para chamar um despejo de memória por demanda para CRTL+ALT+D.
Clique em Salvar e Fechar.

Valores da opção do diagnóstico do relatório de erros

As definições do relatório de diagnóstico de erro são configuradas usando a opção global DiagnosticsConfiguration. Os valores de DiagnosticsConfiguration disponíveis são descritos aqui.

Nome do valor	Tipo de valor	Descrição
EnableExitMonitoring	verdadeiro/falso	O padrão é verdadeiro e os logs de diagnóstico e os logs de saída são coletados, no caso de uma exceção. Se definido como falso, os logs de diagnóstico e os logs de saída não serão coletados durante uma exceção do cliente do Unified Service Desk.
EnableCrashMonitoring	verdadeiro/falso	O padrão é verdadeiro e os arquivos de dump são coletados durante uma exceção fatal do cliente do Unified Service Desk. Se definido como falso, os arquivos de despejo não serão coletados durante uma exceção do cliente do Unified Service Desk. Se EnableCrashMonitoring for definido como falso e EnableExitMonitoring for definido como verdadeiro, os logs de diagnóstico e os logs de saída são coletados, mas os arquivos de despejo não.
LogsDirectory	string	Especifica o caminho completo da pasta em que os arquivos de diagnóstico das exceções são mantidos. Se o arquivo for inválido ou inacessível, o Unified Service Desk usará a pasta padrão. Por padrão, a pasta é %APPDATA%\Roaming\Microsoft\Microsoft Dynamics® 365 Unified Service Desk\<version>\Diagnostics\.
MaxDiagnosticLogsSize	integer	Especifica o tamanho máximo da pasta em megabytes onde os arquivos de diagnóstico são mantidos. O tamanho padrão é 5 GB (5000 MB). Quando MaxDiagnosticLogsSize for excedido, as pastas de log mais antigas serão excluídas até o MaxDiagnosticLogsSize não ser mais excedido. Observe que, a pasta de log mais recente não é excluída, mesmo se exceder o MaxDiagnosticLogsSize.
ManualDumpShortcut	string	Especifica a tecla de atalho usada para chamar a criação manual de um arquivo de despejo. A combinação de teclas padrão é CTRL+ALT+a. Para alterar o padrão, use o formato key1+key2+key3.

Confira Também

Configurar auditoria e diagnósticos no Unified Service Desk
Solucionar problemas do Unified Service Desk
MSDN: Depurar problemas no Unified Service Desk

Unified Service Desk 2.0

Compartilhar via

Configurar registro de diagnóstico do cliente no Unified Service Desk

Neste tópico

Configurar o log de diagnóstico do cliente Unified Service Desk

Fontes de log diagnóstico

Níveis do log de diagnóstico

Ouvintes de log diagnóstico

Vendo o arquivo de log de diagnóstico

Processo de Monitoramento do Unified Service Desk

Relatório de diagnóstico de erro

Arquivos e pastas criados durante uma exceção

Configurar o relatório de diagnóstico de erro

Valores da opção do diagnóstico do relatório de erros

Confira Também

Recursos adicionais