Konfigurace diagnostického protokolování klienta

Článek
04/19/2023

Existují dva způsoby, jak lze konfigurovat protokolování diagnostiky klienta Unified Service Desk:

Pomocí záznamu Nastavení auditu a diagnostiky, který je vytvořen a spravován v oblasti Unified Service Desk platformy Microsoft Dataverse.
Ručně provedenými změnami v souboru UnifiedServiceDesk.exe.config. Tento soubor musí pak být distribuován na každý stolní počítač, kde chcete provádět protokolování diagnostiky klienta Unified Service Desk.

Navíc můžete konfigurovat protokolování diagnostiky konkrétně pro výjimky, které mohou nastat v klientovi Unified Service Desk.

Konfigurace protokolování diagnostiky klienta v Unified Service Desk

Tato sekce popisuje, jak ručně konfigurovat protokolování diagnostiky v Unified Service Desk. Spíše než používat postup popsaný zde, doporučujeme použít funkci Nastavení auditu a diagnostiky, která poskytuje centralizovanou správu diagnostiky a možnost připojit vlastní naslouchací proces. Další informace: Konfigurace auditování a diagnostiky v Unified Service Desk

Důležité

Ručně konfigurovaná diagnostiku (jak je popsáno zde), nebude po povolení záznamu Nastavení auditu a diagnostiky, který je nakonfigurován pro diagnostiku, nadále fungovat.
Unified Service Desk také poskytuje rozhraní API, které umožňuje konfigurovat diagnostické protokolování ve formátu RTF pro vlastní hostované ovládací prvky. Další informace: Konfigurace rozšířeného protokolování diagnostiky pro vlastní hostované ovládací prvky

Toto téma popisuje, jak změnit vlastnosti protokolování klienta.

Protokolování můžete povolit v souboru UnifiedServiceDesk.exe.config, který je k dispozici v instalačním adresáři klienta Unified Service Desk ve vašem počítači. Konfigurace typu protokolování a umístění souboru protokolu Unified Service Desk:

Otevřete soubor UnifiedServiceDesk.exe.config pro úpravy. Pokud jste nainstalovali klienta Unified Service Desk ve výchozím umístění, tento soubor bude zpravidla k dispozici v cestě C:\Program Files\Microsoft Dynamics 365 Customer Engagement USD\USD.

Přejděte do sekce <switches> v souboru:

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

V části <switches> určete zdroj protokolování (jako například EventTopicSwitch) a pak zadejte hodnotu úrovně protokolování (jako například Error). Část <switches> řídí úroveň protokolování pro různé zdroje. Ve výchozím nastavení je protokolování chyb povoleno pro všechny přepínače.
- Informace o dostupných zdrojích protokolování naleznete v části Dostupné zdroje protokolu dále v tomto tématu.
- Informace o hodnotách, které můžete zadat pro každý zdroj protokolování, naleznete v části Úrovně protokolování dále v tomto tématu.

Chcete-li konfigurovat umístění, maximální velikost souborů a chování výměny, přejděte do sekce <shareListeners> v souboru.

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

Sekce <sharelisteners> určuje umístění a typ protokolů, které jsou generovány pro Unified Service Desk. Ve výchozím nastavení fileListener vytvoří soubor s názvem UnifiedServiceDesk.log v adresáři c:\Users\<UserName>\AppData\Roaming\Microsoft\Microsoft\Microsoft Dynamics 365 Unified Service Desk\<Version> a USDDebugListener vytvoří události na kartě Ladit výstup hostovaného ovládacího prvku Ladicí program.

Pokud chcete změnit umístění souboru UnifiedServiceDesk.log, změňte hodnotu parametru Location.
Ve výchozím nastavení se nový protokol Unified Service Desk vytvoří poté, co velikost aktuálního souboru protokolu překročí 52,42 MB. Ve výchozím nastavení se udržuje až 10 souborů protokolu najednou, než se nejstarší soubor protokolu smaže.
- Chcete-li změnit maximální velikost souboru protokolu Unified Service Desk, změňte hodnotu parametru MaxFileSize (v bajtech).
- Chcete-li změnit počet protokolů, které jsou udržovány, než je smazán nejstarší protokol, změňte hodnotu parametru MaxFileCount. Pokud je použita hodnota nula (0), bude protokolování výměny zakázáno a všechny vytvořené protokoly klientů Unified Service Desk se uloží.
Ve výchozím nastavení je protokolování souboru a ladění povoleno pro všechny zdroje. Pokud chcete přidat nebo odebrat naslouchací proces z diagnostického zdroje, vyhledejte požadovaný zdroj v části <sources> a potom změňte část <listeners> zdroje tak, aby zahrnovala požadovaný naslouchací proces.

Chcete-li například přidat protokolování události pro Unified Service Desk, přidejte naslouchací proces protokolování událostí do zdroje 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>  
```
Nyní bude hlásit události do protokolu událostí Windows se značkou „USD“, kromě souboru a ladicího programu. Další informace o diagnostických naslouchacích procesech naleznete v části Naslouchací procesy diagnostického protokolu dále v tomto tématu.

Zdroje protokolu diagnostiky

Obvyklé zdroje protokolu řešení problémů jsou uvedeny v následující tabulce.

Zdrojový název	Description
EventTopicSwitch	Podrobný zdroj protokolování User Interface Integration (UII) pro sledování přenosu zpráv uvnitř UII.
Microsoft.Uii.Common.Logging	Obecný zdroj protokolu UII pro zprávy vykazované UII.
Microsoft.Xrm.Tooling.CrmConnectControl	Zdroj protokolu pro proces přihlášení. Tento zdroj ohlásí obecné nebo podrobné diagnostické informace o postupu přihlášení.
Microsoft.Xrm.Tooling.Connector.CrmServiceClient	Zdroj protokolu pro všechny interakce na úrovni dat Dataverse. Tento zdroj bude hlásit všechny interakce s Dataverse, výjimky a časování.
Microsoft.Xrm.Tooling.WebResourceUtility	Zdroj protokolu pro žádosti o data webového zdroje prostřednictvím odkazu rozhraní Dataverse.
Microsoft.Crm.UnifiedServiceDesk	Zdroj protokolu pro základní funkce Unified Service Desk. Tento zdroj protokolu ohlásí akce a události, které jsou klíčové pro Unified Service Desk.
Microsoft.Crm.UnifiedServiceDesk.Dynamics	Zdroj protokolu pro samozaváděcí a načítací procesor Unified Service Desk. Tento zdroj ohlásí akce a události, které jsou součástí inicializace a spuštění UII a Unified Service Desk.
Microsoft.Crm.UnifiedServiceDesk.CommonUtility.UserProfileManager	Zdroj protokolu pro akce, které spolupracují se systémem uživatelského profilu. Jedná se o součást systému ukládání do mezipaměti. Další informace: Konfigurace klienta pro ukládání do mezipaměti pro aplikaci agenta

Můžete přepínat každý z těchto zdrojů protokolu nezávisle, a tím napomoci odstraňování potíží a izolaci problémů nebo informací uvnitř Unified Service Desk.

Úrovně diagnostického protokolování

K dispozici je několik úrovní protokolování. Čím vyšší úroveň protokolování, tím více dat je generováno a uloženo v souborech protokolu.

Úroveň protokolu	Popis
Vypnuto	Zakáže všechny události z tohoto zdroje.
Chyba	Hlásí pouze chybové události.
Upozornění	Hlásí chyby a upozornění.
Informace	Hlásí chyby, upozornění a informační události.
Podrobné	Hlásí chyby, upozornění, informační události a podrobné události.
ActivityTracing	Hlásí chyby, upozornění, informační a podrobné události a trasování aktivity (názvy metod). Poznámka: Nástroj ActivityTracing je k dispozici pouze u některých zdrojů.
Všechna	Hlásí všechny události vyvolané systémem.

Naslouchací procesy diagnostického protokolu

Naslouchací procesy diagnostického protokolu se používají k zaměření výstupu diagnostického protokolu do souborů, protokolu událostí a jiných zdrojů. Standardně jsou všechny diagnostické zdroje propojeny s výchozími (ladicí program) a souborovými (text) naslouchacími procesy. Můžete nakonfigurovat další naslouchací procesy protokolu pro diagnostické protokolování pro Unified Service Desk. Další informace o výchozích naslouchacích procesech .NET naleznete v tématu:

MSDN: DefaultTraceListener
MSDN:EventLogTraceListener
MSDN:TextWriterTraceListener

Můžete také vytvořit vlastní naslouchací procesy a odesílat diagnostické protokoly do umístění dle vašeho výběru. Vlastní naslouchací procesy se vytváří odvozením od třídy z abstraktní třídy MSDN:TraceListener. Návod k procesu lze najít na webu CodeGuru.com.

Zobrazení souboru protokolu pro diagnostiku

Ve výchozím nastavení je protokolování diagnostiky povoleno pro klientskou aplikaci Unified Service Desk. Soubor protokolu UnifiedServiceDesk-<datum>.log je k dispozici na adrese c:\Users\<UserName>\\Roaming\Microsoft\Microsoft Dynamics 365 Unified Service Desk\<Version> v klientském počítači, aby zaznamenával provozní chyby v klientské aplikaci. Soubor protokolu je vytvořen, když v klientské aplikaci poprvé narazíte na jakékoli chyby.

Dojde-li k chybě v hostovaném ovládacím prvku, informace v souborech protokolů poskytnou podrobné informace o výjimce, jako je hostovaný ovládací prvek původu, který způsobil výjimku, a podrobnosti o výjimce. Všimněte si, že není protokolován celý kód jazyka JavaScript, který způsobil výjimku. Je protokolován pouze chybný kód a popis výjimky.

Zde je vzor podrobností o výjimce, které se protokolují.

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

Monitorovací proces aplikace Unified Service Desk

Monitorovací proces aplikace Unified Service Desk (usdmp.exe) je služba, která neustále monitoruje stav aplikace Unified Service Desk a ve výchozím nastavení po 5 sekundách ukončuje všechny instance procesu prohlížeče, které nereagují a způsobují to, že aplikace Unified Service Desk přestane odpovídat. Pokud instance procesu prohlížeče nereaguje, ale Unified Service Desk reaguje, instance procesu prohlížeče nebude ukončena. Další informace o tom, jak změnit dobu ukončení globální možnosti ProcessTerminationThreshold pro ukončení procesu prohlížeče, najdete v části Správa možností pro Unified Service Desk.

Zasílání zpráv o diagnostice chyb

Podrobné a komplexní protokolování a zasílání zpráv, k němuž dochází během poruch součásti, aplikace nebo systému, může pomoci určit, kdy a jak došlo k chybě. Kromě standardního diagnostického protokolování zaznamenává zasílání zpráv o diagnostice chyb informace o stavu aplikace a systému v případě výjimky v klientovi Unified Service Desk. Další informace o výjimkách najdete v části Jak aplikace Unified Service Desk zpracovává chyby aplikace a systému.

Složky a soubory vytvořené během výjimky

V případě výjimky zasílání zpráv diagnostiky chyb vytvoří složku v místním počítači s názvem DiagnosticsLogs_datum a čas, kde datum a čas má podobu rok-měsíc-den_čas, například DiagnosticLogs_20170322_173643. Ve složce DiagnosticsLogs se vytvoří následující složky a soubory.

Soubor diagnostiky	Popis
UnifiedServiceDesk_datumačas.log	Standardní diagnostický protokol, který je vytvořen a přidán, když je spuštěn klient Unified Service Desk. Soubor obsahuje informace o protokolování pro klienta Unified Service Desk (UnifiedServiceDesk.exe). V případě výjimky se aktuální soubory přesunou do složky DiagnosticsLogs.
UnifiedServiceDeskMonitoring_datum.log	Standardní diagnostický protokol, který je vytvořen a přidán, když je spuštěn klient Unified Service Desk. Obsahuje informace o protokolování pro proces monitorování aplikace Unified Service Desk (usdmp.exe), což je proces, který sleduje stav klienta Unified Service Desk. V případě výjimky se aktuální soubory přesunou do složky DiagnosticsLogs. Více informací: Proces monitorování Unified Service Desk
Eventlogs (složka)	Složka vytvořená v případě závažné nebo nezávažné výjimky. Obsahuje protokoly událostí aplikací a systému Windows a textové soubory zasílání zpráv o chybách.
ExitReport.txt	Ukončovací protokol vytvořený v případě závažné nebo nezávažné výjimky. Obsahuje informace o stavu procesu, jako je například název počítače, verze aplikace Unified Service Desk, id procesu, ukončovací kód a čas ukončení.
MachineHealthReport.txt	Ukončovací protokol vytvořený v případě závažné nebo nezávažné výjimky. Obsahuje informace o stavu systému, jako je procesor počítače, operační systém, podrobnosti monitorování, jazyk a verze prohlížeče.
ProcessReport.csv	Ukončovací protokol vytvořený v případě závažné nebo nezávažné výjimky. Poskytuje úplný seznam všech procesů, které byly spuštěny v systému v době výjimky.
RegistryLog.txt	Ukončovací protokol vytvořený v případě závažné nebo nezávažné výjimky. Obsahuje textovou kopii podklíčů registru systému Windows pro Internet Explorer.
UnifiedServiceDesk_processId_CrashDump_datumačasdmp	Vytvořeno pouze v případě neošetřené závažné výjimky nebo při ručním vyvolání pomocí kombinace kláves globální možnosti ManualDumpShortcut. Poskytuje soubor s úplným výpisem stavu paměti pro UnifiedServiceDesk.exe. Všimněte si, že pokud chcete zobrazit soubor s výpisem stavu paměti, potřebujete Visual Studio nebo jiný nástroj pro zobrazení souboru s výpisem stavu paměti systému Windows.

Konfigurace zasílání zpráv o diagnostice chyb

Přihlaste se k aplikaci Unified Service Desk Administrator.
V části Upřesnit nastavení vyberte Auditování a diagnostika.
Vyberte Nový a poté vyberte možnost DiagnosticsConfiguration.
Vyberte nebo zadejte požadované hodnoty, například sledování, monitorování ukončení a umístění adresáře s protokoly diagnostiky. Více informací: Diagnostika
Zvolte Uložit a zavřít.

Viz také

Konfigurace auditování a diagnostiky v Unified Service Desk

Podpora ladění v Unified Service Desk pro řešení potíží

Problémy s laděním v Unified Service Desk