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

 

公開日: 2016年11月

対象: Dynamics 365 (online)、Dynamics 365 (on-premises)、Dynamics CRM 2013、Dynamics CRM 2015、Dynamics CRM 2016

Unified Service Desk クライアント診断ログを構成できる方法は 2 つあります。

• Microsoft Dynamics 365 の Unified Service Desk 領域で作成され管理される [監査と診断の設定] レコードを使用する方法と、

• UnifiedServiceDesk.exe.config ファイルを手動で変更する方法です。 このファイルはその後、Unified Service Desk クライアント診断ログが必要なすべてのデスクトップに配布する必要があります。

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

このトピックの内容

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

診断ログのソース

診断ログのレベル

診断ログ リスナー

診断ログ ファイルの表示

Unified Service Desk 監視プロセス

エラー診断レポート

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

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

重要

• 診断用に構成された [監査と診断の設定] レコードを有効にすると、(ここで説明するように) 手動で構成された診断は機能しなくなります。

• Unified Service Desk はカスタムのホストされたコントロールの豊富な診断ログを構成できる API も提供します。 詳細: MSDN: カスタムのホストされたコントロールの拡張診断ログを構成する

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

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

1. UnifiedServiceDesk.exe.config ファイルをオープンして編集します。Unified Service Desk クライアントを既定の場所にインストールした場合、このファイルは通常 C:\Program Files\Microsoft Dynamics 365 USD\USD で利用可能です。

2. ファイル内の <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>
   

3. <switches> セクションで、ログ ソース (EventTopicSwitch など) を指定し、次にログ レベルの値 (Error など) を指定します。<switches>セクションは、さまざまなソースのログ レベルをコントロールします。 既定では、エラー ログはすべてのスイッチで有効です。

   • 使用可能なログ ソースの詳細は、このトピックの後半の 診断ログのソース を参照してください。

   • ログ ソースごとに指定できる値の詳細は、このトピックの後半の「診断ログのレベル」を参照してください。

4. ログファイルの場所、最大ファイル サイズ、およびロールオーバー動作を設定するには、ファイルの [<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] は、[UnifiedServiceDesk.log] という名前のファイルを [c:\Users\<ユーザー名>\AppData\Roaming\Microsoft\UnifiedServiceDesk\<バージョン>] ディレクトリに作成し、および [USDDebugListener] は、イベントをデバッガーのホストされたコントロールの [MSDN: デバッグ出力タブ] に作成します。

5. UnifiedServiceDesk.log ファイルの場所を変更する場合、Location パラメーターの値を変更します。

6. 既定では、現在のログ ファイルのファイル サイズが 52.42 MB を超えると、新しい Unified Service Desk ログが作成されます。 既定では、最も古いログ ファイルが削除される前に、最大 10 個のログ ファイルが一度に保持されます。

   • 最大 Unified Service Desk ログ ファイル サイズを変更するには、[MaxFileSize] パラメータの値をバイト単位で変更します。

   • 最も古いログが削除される前に保持されるログの数を変更するには、[MaxFileCount] パラメーターの値を変更します。 ゼロ (0) を使用すると、ロールオーバー ロギングが無効になり、作成されたすべての Unified Service Desk クライアント ログが保存されます。

7. 既定では、すべてのソースでファイルおよびデバッガーのログが有効です。 診断ソースに対してリスナーを追加または削除する場合、必要なソースを <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 内のメッセージング トラフィックを監視する詳細 User Interface Integration (UII) ログ ソースです。
Microsoft.Uii.Common.Logging	UII によって報告されたメッセージの全般 UII のログ ソースです。
Microsoft.Xrm.Tooling.CrmConnectControl	Dynamics 365 に対するサインイン プロセスのログ ソースです。 このソースは、サインイン手順に関する全般または詳細な診断情報を報告します。
Microsoft.Xrm.Tooling.Connector.CrmServiceClient	すべての Dynamics 365 データ レベルの相互作用のためのログ ソースです。 このソースは、Dynamics 365 とのすべての相互作用、例外とタイミングを報告します。
Microsoft.Xrm.Tooling.WebResourceUtility	Dynamics 365 インターフェイス リンクを介した Web リソース データの要求に対するログ ファイルです。
Microsoft.Crm.UnifiedServiceDesk	コア Unified Service Desk 機能のログ ソースです。 このログ ソースは、Unified Service Desk の中核のアクションとイベントを報告します。
Microsoft.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 の既定のリスナーの詳細については、以下を参照してください。

• DefaultTraceListener

• EventLogTraceListener

• TextWriterTraceListener

診断ログを選択した任意の場所に送信する、カスタム リスナーを作成することもできます。 カスタム リスナーは、クラスを TraceListener 抽象クラスから派生して作成されます。 そのプロセスのチュートリアルは、CodeGuru.com にあります。

診断ログ ファイルの表示

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

ホストされたコントロールでエラーが発生した場合、ログ ファイルに記録された情報で、例外の詳細とともに例外が発生した元となっているホストされたコントロールなどの例外に関する詳細情報を確認できます。 例外が発生した JavaScript コードのすべてが記録されないことに注意してください。 例外の説明とともに欠陥のあるコードのみ記録されます。

注意

下記に示すエラー処理およびログ記録は、Unified Service Desk 2.2.1 で最初に導入されました。

記録されるサンプル例外の詳細を示します。

Microsoft.Crm.UnifiedServiceDesk.Dynamics	エラー	2	12/27/2016 11:54:15 AM 発生元:AppdomianUnhandledException、IsFatal:True ソース: DemoControl ターゲット: Void throwExceptionMethod() 例外: カスタム コントロールでの例外 StackTrace:   DemoControl.USDControl.throwExceptionMethod() にて System.Threading.ExecutionContext.RunInternal(ExecutionContext executionContext, ContextCallback コールバック, オブジェクトの状態, ブール値 preserveSyncCtx) にて System.Threading.ExecutionContext.Run(ExecutionContext executionContext、ContextCallback コールバック、オブジェクトの状態, ブール値 preserveSyncCtx) にて System.Threading.ExecutionContext.Run(ExecutionContext executionContext, ContextCallback コールバック, オブジェクトの状態) にて System.Threading.ThreadHelper.ThreadStart() にて

Unified Service Desk 監視プロセス

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

エラー診断レポート

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

注意

下記に示すエラー診断レポートは、Unified Service Desk 2.2.2 で最初に導入されました。

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

例外の場合、エラー診断レポートはフォームの year-month-date_time にある DiagnosticLogs_20170322_173643 などの DiagnosticsLogs日時 という名前のローカル コンピュータ上にフォルダを作成します。 DiagnosticsLogs フォルダ内には、以下のフォルダとファイルが作成されます。

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

エラー診断レポートの構成

1. Web アプリケーションで、[設定] > [Unified Service Desk] > [オプション] の順に移動します。

2. [新規] をクリックし、次に [DiagnosticsConfiguration] を選択します。

3. セミコロン (;) で区切って次の表に示す 1 つ以上の値を入力します。詳細:エラー診断報告オプション値

   たとえば、この構成では、ログ ファイル ディレクトリが変更され、最大診断ログ フォルダ サイズが 2 GB に縮小され、CRTL+ALT+D へのオンデマンド クラッシュ ダンプを呼び出すようにショートカット キーの組み合わせが変更されます。

   

4. [保存して閉じる] をクリックします。

エラー診断報告オプション値

エラー診断のレポート設定は、DiagnosticsConfiguration グローバル オプションを使用して構成します。 使用可能な DiagnosticsConfiguration 値は次のとおりです。

値の名前	値の種類	内容
EnableExitMonitoring	true / false	既定は true で、診断ログと終了ログの両方が例外発生時に収集されます。 false に設定すると、Unified Service Desk クライアントの例外時に診断ログと終了ログの両方が収集されません。
EnableCrashMonitoring	true / false	既定は true であり、ダンプ ファイルは Unified Service Desk クライアントの致命的な例外時に収集されます。 false に設定すると、Unified Service Desk クライアント例外時にダンプ ファイルは収集されません。 EnableCrashMonitoring が false に設定され、EnableExitMonitoring が true に設定されている場合、診断ログと終了ログの両方が収集されますが、ダンプ ファイルは収集されません。
LogsDirectory	文字列	例外の診断ファイルが保存されるフォルダのフル パスを指定します。 パスが無効またはアクセスできない場合、Unified Service Deskは既定のフォルダを使用します。 既定では、フォルダーは %APPDATA%\Roaming\Microsoft\Microsoft Dynamics® 365 Unified Service Desk\<version>\Diagnostics\ です。
MaxDiagnosticLogsSize	integer	診断ファイルが保存されるフォルダの最大サイズをメガバイト単位で指定します。 既定のサイズは 5 GB (5000 MB) です。 MaxDiagnosticLogsSize を超えると、MaxDiagnosticLogsSize が超過されなくなるまで、最も古いログフォルダが削除されます。 最新のログ フォルダは、MaxDiagnosticLogsSize を超えても削除されないことに注意してください。
ManualDumpShortcut	文字列	ダンプ ファイルの手動作成を呼び出すために使用されるショートカット キーを指定します。 既定のキーの組み合わせは、CTRL+ALT+a です。 既定を変更するには、key1+key2+key3 のフォームを使用します。

関連項目

Unified Service Desk で監査と診断を構成する
Unified Service Desk のトラブルシューティング
MSDN: Unified Service Desk の問題をデバッグする

Unified Service Desk 2.0

© 2016 Microsoft. All rights reserved. 著作権