Comment configurer la journalisation des diagnostics clients ?

Article
04/19/2023

Deux méthodes s’offrent à vous pour configurer la journalisation des diagnostics du client Unified Service Desk :

En utilisant un enregistrement Paramètres d’audit et de diagnostics créé et géré dans la zone Unified Service Desk de Microsoft Dataverse.
En effectuant les modifications apportées manuellement au fichier UnifiedServiceDesk.exe.config. Ce fichier doit être distribué sur chaque ordinateur où vous souhaitez effectuer une journalisation des diagnostics du client Unified Service Desk.

En outre, vous pouvez configurer la journalisation des diagnostics spécifiquement pour les exceptions qui peuvent se produire dans le client Unified Service Desk.

Configurer la journalisation des diagnostics du client Unified Service Desk

Cette section décrit comment configurer manuellement la journalisation des diagnostics dans Unified Service Desk. Plutôt que d’utiliser la procédure décrite ici, nous vous recommandons d’utiliser la fonctionnalité Paramètres d’audit et de diagnostics qui fournit une administration centralisée des diagnostics et la capacité de connecter un écouteur personnalisé. Plus d’informations : Configurer l’audit et le diagnostic dans Unified Service Desk

Important

Les diagnostics configurés manuellement (comme décrit ici) s’arrêteront après avoir activé un enregistrement Paramètres d’audit et de diagnostics configuré pour les diagnostics.
Unified Service Desk fournit également une API qui permet de configurer la journalisation des diagnostics enrichie pour les contrôles hébergés personnalisés. Plus d’informations : Configurer la journalisation améliorée des diagnostics pour les contrôles hébergés personnalisés

Cette rubrique décrit comment modifier les fonctionnalités de journalisation cliente.

Vous pouvez activer la journalisation en utilisant le fichier UnifiedServiceDesk.exe.config, accessible dans le répertoire d’installation du client Unified Service Desk sur votre ordinateur. Pour configurer le type de journalisation et l’emplacement du fichier journal Unified Service Desk :

Ouvrez le fichier UnifiedServiceDesk.exe.config pour modification. Si vous avez installé le client Unified Service Desk à l’emplacement par défaut, ce fichier est généralement disponible dans C:\Program Files\Microsoft Dynamics 365 Customer Engagement USD\USD.

Accédez à la section <switches> du fichier :

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

Dans la section <switches>, spécifiez une source de journalisation (par exemple EventTopicSwitch), puis spécifiez une valeur de niveau de journalisation (par exemple Error). La section <switches> contrôle les niveaux de journalisation pour plusieurs sources. Par défaut, la journalisation des erreurs est activée pour tous les commutateurs :
- Pour plus d’informations sur les sources de journalisation disponibles, voir Sources de journal disponibles plus loin dans cette rubrique.
- Pour plus d’informations sur les valeurs que vous pouvez spécifier pour chaque source de journalisation, voir Niveaux de journalisation plus loin dans cette rubrique.

Pour configurer l’emplacement, la taille de fichier maximale et le comportement de substitution des fichiers journaux, accédez à la section <shareListeners> du fichier.

<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 section <sharelisteners> contrôle l’emplacement et le type de journaux générés pour Unified Service Desk. Par défaut, fileListener crée un fichier appelé UnifiedServiceDesk.log dans le répertoire c:\Users\<UserName>\AppData\Roaming\Microsoft\Microsoft\Microsoft Dynamics 365 Unified Service Desk\<Version>, et USDDebugListener crée des événements dans l’onglet Résultat du débogage du contrôle hébergé du débogueur.

Pour modifier l’emplacement du fichier UnifiedServiceDesk.log, modifiez la valeur du paramètre Location.
Par défaut, un journal Unified Service Desk est créé une fois que la taille du fichier journal actuel dépasse 52,42 Mo. Par défaut, jusqu’à 10 fichiers journaux sont conservés en même temps avant que le fichier journal le plus ancien soit supprimé.
- Pour modifier la taille maximale du fichier journal Unified Service Desk, modifiez la valeur, en octets, du paramètre MaxFileSize.
- Pour modifier le nombre de journaux conservés avant que le journal le plus ancien soit supprimé, modifiez la valeur du paramètre MaxFileCount. Si la valeur zéro (0) est utilisée, la journalisation de substitution est désactivée et tous les journaux d’activité du client Unified Service Desk créés sont enregistrés.
Par défaut, la journalisation des fichiers et du débogueur est activée pour toutes les sources. Pour ajouter ou supprimer un écouteur d’une source de diagnostic, identifiez la source voulue dans la section <sources>, puis modifiez la section <listeners> de la source de manière à ce qu’elle inclut l’écouteur souhaité.

Par exemple, pour ajouter la journalisation des événements pour Unified Service Desk, ajoutez l’écouteur de journalisation des événements à la source 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>  
```
Les événements seront désormais rapportés au journal des événements Windows avec la balise « USD », en plus du fichier et du débogueur. Pour plus d’informations sur les écouteurs de diagnostic, voir Écouteurs des journaux de diagnostic plus loin dans cette rubrique.

Sources des journaux de diagnostics

Le tableau suivant répertorie les sources des journaux de résolution des problèmes les plus courantes.

Nom de la source	Description
EventTopicSwitch	Source de journalisation détaillée User Interface Integration (UII) pour le contrôle du trafic de messagerie au sein d’UII.
Microsoft.Uii.Common.Logging	Source de journal UII générale pour les messages rapportés par UII.
Microsoft.Xrm.Tooling.CrmConnectControl	Source de journal pour le processus de connexion. Cette source rapportera des informations de diagnotics générales ou détaillées sur la procédure de connexion.
Microsoft.Xrm.Tooling.Connector.CrmServiceClient	Source de journal pour toutes les interactions Dataverse qui ont lieu au niveau des données. Cette source rapportera toutes les interactions avec Dataverse, les exceptions et les horaires.
Microsoft.Xrm.Tooling.WebResourceUtility	Source de journal pour les demandes de données de ressources Web via le lien d’interface Dataverse.
Microsoft.Crm.UnifiedServiceDesk	Source de journal pour la fonctionnalité de base de Unified Service Desk. Cette source de journal rapporte les actions et les événements qui sont essentiels à Unified Service Desk.
Microsoft.Crm.UnifiedServiceDesk.Dynamics	Source de journal du processeur de démarrage et de chargement de Unified Service Desk. Cette source rapporte les actions et les événements qui font partie de l’initialisation et du démarrage de l’UII et de Unified Service Desk.
Microsoft.Crm.UnifiedServiceDesk.CommonUtility.UserProfileManager	Source de journal pour les actions qui interagissent avec le système de profil utilisateur ; Elle fait partie du système de mise en cache. Plus d’informations : Configurer la mise en cache du client pour votre application agent

Vous pouvez activer chacune de ces sources de journal indépendamment pour résoudre et isoler des problèmes ou des informations au sein de Unified Service Desk.

Niveaux de journalisation des diagnostics :

Il existe différents niveaux de journalisation. Toutefois, plus le niveau de journalisation est élevé, plus il y a de données générées et enregistrées dans les fichiers journaux.

Niveau de journalisation	Description
Désactivé	Désactive les événements de cette source.
Erreur	Rapporte uniquement les événements d’erreur.
Avertissement	Rapporte les événements d’erreur et d’avertissement.
Informations	Rapporte les des événements d’erreur, d’avertissement et d’information.
Commentaires	Rapporte les événements d’erreur, d’avertissement, d’information et de commentaire.
ActivityTracing	Rapporte les événements d’erreur, d’avertissement, d’information, de commentaire, et le suivi d’activité (noms des méthodes). Remarque : ActivityTracing est disponible uniquement pour certaines sources.
Tous	Rapporte tous les événements déclenchés par le système.

Écouteurs des journaux de diagnostics

Les écouteurs des journaux de diagnostics servent à cibler le résultat des journaux de diagnostics dans les fichiers, le journal des événements ou d’autres sources. Par défaut, toutes les sources de diagnostics sont reliées aux écouteurs par défaut (débogueur) et fichier (texte). Vous pouvez configurer des écouteurs supplémentaires pour la journalisation des diagnostics pour Unified Service Desk. Pour plus d’informations sur les écouteurs par défaut .NET, voir :

MSDN : DefaultTraceListener
MSDN : EventLogTraceListener
MSDN : TextWriterTraceListener

Vous pouvez également créer des auditeurs personnalisés pour envoyer des journaux de diagnostics à un emplacement de votre sélection. Les écouteurs personnalisés sont créés en dérivant une classe à partir de la classe abstraite MSDN : TraceListener. Vous pouvez accéder à un guide pas-à-pas du processus sur CodeGuru.com.

Afficher le fichier journal des diagnostics

Par défaut, la journalisation des diagnostics est activée pour l’application cliente Unified Service Desk. Un fichier journal, UnifiedServiceDesk-<date>.log, est disponible à l’adresse c:\Users\<UserName>\\Roaming\Microsoft\Microsoft Dynamics 365 Unified Service Desk\<Version> sur l’ordinateur client pour enregistrer les erreurs opérationnelles dans l’application cliente. Le fichier journal est créé la première fois que vous rencontrez une erreur dans l’application cliente.

Lorsqu’une erreur se produit dans un contrôle hébergé, les données enregistrées dans les fichiers journaux fournissent des informations détaillées sur l’exception, par exemple le contrôle hébergé à l’origine de l’exception ainsi que les détails de l’exception. Notez que l’intégralité du code JavaScript à l’origine de l’exception n’est pas enregistrée. Seul le code erroné avec la description de l’exception sont enregistrés.

Voici un exemple des détails d’exception qui ont été enregistrés.

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

Processus de surveillance d’Unified Service Desk

Le processus de surveillance de Unified Service Desk (usdmp.exe) est un service qui surveille en continu l’intégrité de Unified Service Desk, et interrompt, par défaut au bout de 5 secondes, toutes les instances de processus de navigateur qui ne répondent pas et bloquent Unified Service Desk. Si une instance de processus du navigateur ne répond pas, mais que Unified Service Desk répond, l’instance de processus du navigateur n’est pas terminée. Pour plus d’informations sur la modification de la durée de l’option globale ProcessTerminationThreshold pour l’interruption du processus de navigateur, voir Gérer les options pour Unified Service Desk.

Génération de rapports de diagnostics d’erreur

La journalisation et la génération de rapports détaillés et complets lorsqu’une erreur de composant, d’application ou de système se produit permettent d’identifier quand et comment l’erreur s’est produite. Outre la journalisation standard des diagnostics, la fonctionnalité de génération de rapports de diagnostics d’erreur enregistre les informations d’état du système et de l’application lorsqu’une exception se produit dans le client Unified Service Desk. Vous trouverez des informations complémentaires sur les exceptions dans Comment Unified Service Desk gère les erreurs d’application et de système.

Dossiers et fichiers créés pendant une exception

Lorsqu’une exception se produit, la fonctionnalité de génération de rapports de diagnostics d’erreur crée un dossier sur l’ordinateur local appelé DiagnosticsLogs_date et heure, où la date et l’heure se présentent au format année-mois-date_heure, par exemple DiagnosticLogs_20170322_173643. Dans le dossier DiagnosticsLogs, les dossiers et les fichiers suivants sont créés.

Fichier de diagnostic	Description
UnifiedServiceDesk_dateetheure.log	Journal de diagnostic standard créé et ajouté lorsque le client Unified Service Desk est en cours d’exécution. Le fichier contient les informations de journalisation pour le client Unified Service Desk (UnifiedServiceDesk.exe). Les fichiers actuels sont déplacés vers le dossier DiagnosticsLogs lorsqu’une exception se produit.
UnifiedServiceDeskMonitoring_date.log	Journal de diagnostic standard créé et ajouté lorsque le client Unified Service Desk est en cours d’exécution. Contient les informations de journalisation pour le processus de surveillance de Unified Service Desk (usdmp.exe), qui est un processus qui surveille l’intégrité du client Unified Service Desk. Les fichiers actuels sont déplacés vers le dossier DiagnosticsLogs lorsqu’une exception se produit. Plus d’informations : Processus de surveillance de Unified Service Desk
Eventlogs (dossier)	Dossier créé lorsqu’une exception irrécupérable ou récupérable se produit. Contient les journaux des événements du système Windows et de l’application et les fichiers texte de rapports d’erreur.
ExitReport.txt	Journal de sortie créé lorsqu’une exception irrécupérable ou récupérable se produit. Contient les informations d’état du processus telles que le nom de l’ordinateur, la version de Unified Service Desk, l’ID de processus, le code de sortie et l’heure de sortie.
MachineHealthReport.txt	Journal de sortie créé lorsqu’une exception irrécupérable ou récupérable se produit. Contient les informations d’état du système telles que le processeur de l’ordinateur, le système d’exploitation, les détails de surveillance, la langue et la version du navigateur.
ProcessReport.csv	Journal de sortie créé lorsqu’une exception irrécupérable ou récupérable se produit. Fournit une liste détaillée de tous les processus en cours d’exécution sur le système au moment de l’exception.
RegistryLog.txt	Journal de sortie créé lorsqu’une exception irrécupérable ou récupérable se produit. Inclut une copie texte des sous-clés du Registre Windows pour Internet Explorer.
UnifiedServiceDesk_processId_CrashDump_dateetheure.dmp	Créé uniquement lorsqu’une exception irrécupérable non gérée se produit ou lors d’un appel manuel à l’aide d’une combinaison du clavier via l’option globale ManualDumpShortcut. Fournit un fichier de vidage mémoire complet pour UnifiedServiceDesk.exe. Notez que, pour afficher le fichier de vidage, Visual Studio ou un autre outil d’affichage de fichiers de vidage Windows est requis.

Configurer la fonctionnalité de génération de rapports de diagnostics d’erreur

Connectez-vous à l’administrateur de Unified Service Desk.
Sous Paramètres avancés, sélectionnez Audits et diagnostics.
Cliquez sur + Nouveau, puis sélectionnez DiagnosticsConfiguration.
Sélectionnez ou entrez les valeurs souhaitées, par exemple l’emplacement du dossier de suivi, de surveillance de la sortie et des journaux de diagnostic. Plus d’informations : Diagnostics
Cliquez sur Enregistrer et fermer.

Voir aussi

Configurer l’audit et le diagnostic dans Unified Service Desk

Prise en charge du débogage dans Unified Service Desk pour résoudre les problèmes

Problèmes de débogage dans Unified Service Desk