クライアント診断ログを構成する方法

2025-05-22

Unified Service Desk クライアント診断ログを構成するには、次の 2 つの方法があります。

Microsoft Dataverse の Unified Service Desk 領域で作成および管理される監査と診断設定レコードを使用します。
UnifiedServiceDesk.exe.config ファイルを手動で変更する。このファイルは、Unified Service Desk クライアント診断ログが必要なすべてのデスクトップに配布する必要があります。

さらに、Unified Service Desk クライアントで発生する可能性のある例外に対して、診断ログを特別に構成できます。

Unified Service Desk クライアント診断ログの構成

このセクションでは、Unified Service Desk で診断ログを手動で構成する方法について説明します。ここで説明する手順を使用するのではなく、診断の一元管理とカスタムリスナーの接続機能を提供する Audit & Diagnostics Settings 機能を使用することをお勧めします。詳細: Unified Service Desk での監査と診断の構成

重要

手動で設定された診断 (ここで説明) は、診断用に構成された Audit & Diagnostics Settings レコードを有効にすると機能しなくなります。
Unified Service Desk は、カスタムのホストされたコントロールの豊富な診断ログを構成できる API も提供します。詳細: カスタムのホストされたコントロールの拡張診断ログを構成する

このトピックでは、クライアントのログ記録特性を変更する方法について説明します。

コンピューターの Unified Service Desk クライアントのインストールディレクトリにある UnifiedServiceDesk.exe.config ファイルを使用して、ログ記録を有効にすることができます。ログ記録の種類と Unified Service Desk ログファイルの場所を構成するには:

編集する UnifiedServiceDesk.exe.config ファイルを開きます。 Unified Service Desk クライアントを既定の場所にインストールした場合、このファイルは通常、C:\Program Files\Microsoft Dynamics 365 Customer Engagement USD\USD で使用できます。

ファイルの <switches> セクションに移動します。

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

<switches> セクションで、ログソース (EventTopicSwitch など) を指定し、ログレベル値 (Error など) を指定します。 <switches>セクションでは、さまざまなソースのログレベルを制御します。デフォルトでは、エラーロギングはすべてのスイッチで有効になっています。
- 使用可能なログ・ソースについては、このトピックで後述する「使用可能なログ・ソース」を参照してください。
- 各ログソースに指定できる値については、このトピックで後述する「ログレベル」を参照してください。

ログファイルの場所、最大ファイルサイズ、およびロールオーバー動作を設定するには、ファイル内の <shareListeners> セクションに移動します。

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

<sharelisteners> セクションは、Unified Service Desk に対して生成されるログの場所と種類を制御します。既定では、fileListener は c:\Users\<UserName>\AppData\Roaming\Microsoft\Microsoft\Microsoft Dynamics 365 Unified Service Desk\<Version> ディレクトリに UnifiedServiceDesk.log というファイルを作成し、USDDebugListener はデバッガーのホストされたコントロールのデバッグ出力タブでイベントを作成します。

UnifiedServiceDesk.log ファイルの場所を変更する場合は、Location パラメーターの値を変更します。
既定では、現在のログファイルのファイルサイズが 52.42 MB を超えた後に、新しい Unified Service Desk ログが作成されます。デフォルトでは、最も古いログファイルが削除される前に、一度に最大 10 個のログファイルが保持されます。
- Unified Service Desk ログファイルの最大サイズを変更するには、 MaxFileSize パラメーターの値をバイト単位で変更します。
- 最も古いログが削除される前に保持されるログの数を変更するには、 MaxFileCount パラメーターの値を変更します。ゼロ (0) を使用すると、ロールオーバーログは無効になり、作成されたすべての Unified Service Desk クライアントログが保存されます。
既定では、ファイルとデバッガーのログ記録はすべてのソースで有効になっています。診断ソースにリスナーを追加または削除する場合は、 <sources> セクションで必要なソースを見つけてから、ソースの <listeners> セクションを変更して、必要なリスナーを含めます。

たとえば、Unified Service Desk のイベントログを追加するには、イベントログリスナーを 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>  
```
これにより、ファイルとデバッガーに加えて、タグ "USD" が付いた Windows イベントログにイベントが報告されるようになりました。診断リスナーの詳細については、このトピックで後述する「診断ログリスナー」を参照してください。

診断ログのソース

一般的なトラブルシューティングログソースを次の表に示します。

ソース名	説明
EventTopicSwitch	UII 内のメッセージングトラフィックを監視するための詳細なユーザーインターフェイス統合 (UII) ログソース。
Microsoft.Uii.Common.Logging	UII によって報告されたメッセージの一般的な UII ログソース。
Microsoft.Xrm.Tooling.CrmConnectControl	サインインプロセスのログソース。このソースは、サインイン手順に関する一般的または詳細な診断情報を報告します。
Microsoft.Xrm.Tooling.Connector.CrmServiceClient (英語)	すべての Dataverse データレベルのインタラクションのログ元。このソースは、Dataverse とのすべての対話、例外、タイミングを報告します。
Microsoft.Xrm.Tooling.WebResourceUtility	Dataverse インターフェイスリンクを介した Web リソースデータの要求のログソース。
Microsoft.Crm.UnifiedServiceDesk (英語)	Unified Service Desk のコア機能のログソース。このログソースは、Unified Service Desk の中核となるアクションとイベントを報告します。
マイクロソフト.Crm.UnifiedServiceDesk.Dynamics	Unified Service Desk ブートストラップと読み込みプロセッサのログソース。このソースは、UII と Unified Service Desk の初期化と開始の一部であるアクションとイベントを報告します。
Microsoft.Crm.UnifiedServiceDesk.CommonUtility.UserProfileManager	UserProfile システムと対話するアクションのログ記録元。この機能はキャッシュシステムの一部です。詳細: エージェントアプリケーションのクライアントキャッシュの構成

これらの各ログソースを個別に切り替えて、Unified Service Desk 内の問題または情報のトラブルシューティングと分離をサポートできます。

診断ログレベル

使用できるログ記録レベルはいくつかあります。ただし、ログ記録のレベルを上げると、より多くのデータが生成され、ログファイルに格納されます。

ログレベル	説明
オフ	このソースからのすべてのイベントを無効にします。
エラー	エラー・イベントのみを報告します。
警告	エラーと警告イベントを報告します。
情報	エラー、警告、および情報イベントを報告します。
詳細	エラー、警告、情報、および詳細イベントを報告します。
ActivityTracing	エラー、警告、情報、詳細イベント、およびアクティビティトレース (メソッド名) を報告します。手記： ActivityTracing は、一部のソースでのみ使用できます。
全て	システムによって発生したすべてのイベントを報告します。

診断ログリスナー

診断ログ・リスナーは、診断ログ出力をファイル、イベント・ログ、またはその他のソースにターゲット設定するために使用されます。デフォルトでは、すべての診断ソースはデフォルト (デバッガー) リスナーとファイル (テキスト) リスナーの両方に配線されます。 Unified Service Desk の診断ログ用に追加のログリスナーを構成できます。 .NET の既定のリスナーの詳細については、以下を参照してください。

MSDN:DefaultTraceListener
MSDN:EventLogTraceListener
MSDN:TextWriterTraceListener

また、カスタムリスナーを作成して、選択した場所に診断ログを送信することもできます。カスタムリスナーは、 MSDN:TraceListener 抽象クラスからクラスを派生させることによって作成されます。プロセスのウォークスルーは、CodeGuru.com で見つけることができます。

診断ログ・ファイルの表示

既定では、診断ログは Unified Service Desk クライアントアプリケーションに対して有効になっています。ログファイル UnifiedServiceDesk-<date>.log は、クライアントコンピューターの c:\Users\<UserName>\\Roaming\Microsoft\Microsoft Dynamics 365 Unified Service Desk\<Version> で使用でき、クライアントアプリケーションの操作エラーを記録します。ログファイルは、クライアントアプリケーションで初めてエラーが発生したときに作成されます。

ホストされたコントロールでエラーが発生した場合、ログファイルに記録された情報は、例外の原因となった元のホストされたコントロールや例外の詳細など、例外に関する詳細情報を提供します。例外の原因となった JavaScript コード全体がログに記録されていないことに注意してください。エラーのあるコードと例外の説明のみがログに記録されます。

次に、ログに記録される例外の詳細の例を示します。

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

Unified Service Desk 監視プロセス

Unified Service Desk 監視プロセス (usdmp.exe) は、Unified Service Desk の正常性を継続的に監視するサービスであり、既定では、応答せず、Unified Service Desk が応答しなくなる原因となったブラウザープロセスインスタンスを 5 秒後に終了します。ブラウザープロセスインスタンスが応答していないが、Unified Service Desk が応答している場合、ブラウザープロセスインスタンスは終了しません。ブラウザープロセスの終了の ProcessTerminationThreshold グローバルオプションの期間を変更する方法の詳細については、「 Unified Service Desk のオプションを管理する」を参照してください。

エラー診断レポート

コンポーネント、アプリケーション、またはシステムの障害発生時に発生する詳細で包括的なログ記録とレポート作成を行うことで、障害がいつ、どのように発生したかを特定できます。標準の診断ログに加えて、エラー診断レポートは、Unified Service Desk クライアントで例外が発生した場合のシステムとアプリケーションの状態情報を記録します。例外の詳細については、「 Unified Service Desk がアプリケーションおよびシステムエラーを処理する方法」を参照してください。

例外中に作成されたフォルダーとファイル

例外が発生した場合、エラー診断レポートでは、ローカルコンピューター上に DiagnosticsLogs_日付と時刻 (日付と時刻は DiagnosticLogs_20170322_173643 などの年-月-date_time の形式) という名前のフォルダーが作成されます。 DiagnosticsLogs フォルダ内には、次のフォルダとファイルが作成されます。

診断ファイル	説明
UnifiedServiceDesk_日付と時刻.log	Unified Service Desk クライアントの実行中に作成および追加される標準診断ログ。このファイルには、Unified Service Desk クライアント (UnifiedServiceDesk.exe) のログ情報が含まれています。例外が発生した場合、現在のファイルは DiagnosticsLogs フォルダに移動されます。
UnifiedServiceDeskMonitoring_日付.ログ	Unified Service Desk クライアントの実行中に作成および追加される標準診断ログ。 Unified Service Desk クライアントの正常性を監視するプロセスである Unified Service Desk 監視プロセス (usdmp.exe) のログ情報が含まれます。例外が発生した場合、現在のファイルは DiagnosticsLogs フォルダに移動されます。詳細: Unified Service Desk 監視プロセス
イベントログ (フォルダ)	致命的な例外または致命的でない例外が発生した場合に作成されたフォルダー。 Windows システムおよびアプリケーションのイベントログとエラー報告テキストファイルが含まれます。
ExitReport.txt	致命的な例外または致命的でない例外が発生した場合に作成される終了ログ。コンピューター名、Unified Service Desk のバージョン、プロセス ID、終了コード、終了時刻などのプロセス状態情報が含まれます。
MachineHealthReport.txt	致命的な例外または致命的でない例外が発生した場合に作成される終了ログ。コンピュータプロセッサ、オペレーティングシステム、モニタの詳細、言語、ブラウザのバージョンなどのシステム状態情報が含まれます。
ProcessReport.csv	致命的な例外または致命的でない例外が発生した場合に作成される終了ログ。例外の発生時にシステム上で実行されていたすべてのプロセスの包括的な一覧を提供します。
RegistryLog.txt	致命的な例外または致命的でない例外が発生した場合に作成される終了ログ。 Internet Explorer の Windows レジストリサブキーのテキストベースのコピーが含まれています。
UnifiedServiceDesk_processId_CrashDump_dateandtime.dmp	未処理の致命的な例外が発生した場合、または ManualDumpShortcut グローバルオプションキーボードの組み合わせを使用して手動で呼び出された場合にのみ作成されます。 UnifiedServiceDesk.exeのフルメモリダンプファイルを提供します。ダンプファイルを表示するには、Visual Studio またはその他の Windows ダンプファイル表示ツールが必要であることに注意してください。

エラー診断レポートを構成する

Unified Service Desk 管理者にサインインします。
[詳細設定] で [監査と診断] を選択します。
[+ 新規] を選択し、 [DiagnosticsConfiguration] を選択します。
追跡、終了監視、診断ログフォルダーの場所など、必要な値を選択または入力します。詳細: 診断
保存して閉じる を選択します。

こちらも参照ください

Unified Service Desk での監査と診断の構成

問題のトラブルシューティングのための Unified Service Desk でのデバッグサポート

Unified Service Desk での問題のデバッグ