Identity Manager ゲートウェイのオブジェクトとアクティビティーのトレース

ここでは、Sun Identity Manager Gateway のオブジェクトとアクティビティーのトレース方法について説明します。この内容は、次のように構成されています。

• 「「ゲートウェイデバッグ」ページからトレースを設定する方法」

• 「PowerShellExecutor.dll アドオンのトレースを設定する方法」

• 「ワトソン博士のログを取り込む用法」

• ゲートウェイのトレースファイルを表示したり編集するときは、メモ帳を使用してファイル制限を回避します。

• ゲートウェイを起動すると、エントリを削除せずに、プログラムがトレースファイルに新しいトレースエントリを追加します。ゲートウェイのトレースエントリ開始点を探すには、Gateway version 文字列を探します。

• ゲートウェイバージョンは、ゲートウェイ起動時にトレースに自動的に出力されます。このバージョンを表示するには、コマンドラインから gateway -v と入力することもできます。

「ゲートウェイデバッグ」ページからトレースを設定する方法

Identity Manager で Windows アカウントの問題をデバッグするには、「ゲートウェイデバッグ」ページ(Gateway.jsp) またはコマンドラインから有効にします。

次に、この手順について説明していきます。

• 「「ゲートウェイデバッグ」ページから」

• 「コマンドラインから」

「ゲートウェイデバッグ」ページから

ゲートウェイにアクセスできない場合は、「ゲートウェイデバッグ」ページ (Gateway.jsp) から、トレースを有効にします。このデバッグページから、ゲートウェイトレースファイルを指定して検索することができます。

トレースを有効にする

1. Identity Manager 管理者インタフェースにログインします。

2. この「ゲートウェイデバッグページ」を開くには、ブラウザに次の URL を入力します。

   http://host :port/idm/debug/Gateway.jsp

3. 「ゲートウェイリソースリスト」から、トレースするリソースを選択します。

4. 必要に応じて、今までの設定を修正します。

   設定を修正するには、次のボタンをクリックします。

   • 「バージョンの取得」。ゲートウェイを実行中のマシンのゲートウェイバージョンとオペレーティングシステムのバージョンを返します。

   • 「トレースファイルの取得」。トレースファイルのコンテンツを返します。

   • 「トレースパラメータの取得」。トレースファイルのパス、トレースレベル、およびトレースファイルの最大サイズを返します。

   • 「トーレスパラメータの設定」。以上のオプションについては、「トレース設定オブジェクトを新規作成する」を参照してください。

   • 「ロードされたモジュールの取得」。ゲートウェイで使用中のモジュール (DLL) のロードアドレスを返します。

   「ロードしたモジュールの取得」リストはロードアドレスから構成され、その後にモジュール名が続き、ロードされたモジュールだけが記載されます。このリストには、呼び出されずに遅延してロードされたモジュールは記載されません。

   「ロードしたモジュールの取得」オプションは、Active Directory と Domino にのみ対応しています。

コマンドラインから

幅広いオプションを使用するには、コマンドラインからのトレースを有効にすると便利です。

トレースを有効にする

1. コマンドウィンドウを開きます。

2. 必要なトレースのコマンド引数を指定して、ゲートウェイを起動します。

   ゲートウェイをトレースするコマンドライン引数は、次の表のとおりです。

   引数	説明
   -f	トレースファイルへのパスを指定します。
   -l	次のトレースレベルを指定します。  レベル 0。トレースを無効にします。(デフォルト) レベル 1。コンポーネント間のコントロールのフローをトレースし、高度な関数的メソッドからのエントリと終了を含む「精度の低い」トレースポイントを通常は定義します。 レベル 2。すべてのメソッドからのエントリと終了を含む「精度の中程度な」トレースポイント、および高度な機能メソッドの情報トレースポイントとデータトレースポイントを通常は定義します。レベル 2 は、各コンポーネント内、主要な決定ポイント内、および情報項目内のフローを追加します。 レベル 3。すべてのメソッドからのエントリと終了を含む「精度の高い」トレースポイント、高度な機能メソッドの情報トレースポイントとデータトレースポイント、および重要なサブルーチンを通常は定義します。レベル 3 は、低度の決定ポイントと情報項目を追加します。 レベル 4。ほかのトレースレベルでトレースされたものすべてを含み、「極めて精度の高い」トレースポイントを通常は定義します。レベル 4 は非常に低度でトレースし、ほとんど必要とされなくても一部のコンポーネントの複雑な動作を特徴付けるには役立つ精度のレベルを表示します。注意: すべてのコンポーネントがレベル 4 をサポートしているわけではありません。 オーバーヘッドが追加されるため、取得メソッドと設定メソッドなどの簡易メソッドには通常、エントリまたは終了トレースポイントがありません。
   -m	トレースファイルの最大サイズを KB 単位で指定します。  トレースファイルが -m KB に到達すると、Identity Manager が現トレースファイルを閉じ、既存のバックアップファイルがあれば削除し、現トレースファイルを -f 引数で指定した名前に変更して .bk を付与し、-f 引数名が付いた新しいトレースファイルを開きます。 たとえば、コマンドラインに -f beeble.trc を指定すると、-m KB が記録されてから以降は次の 2 ファイルが生成されます。 beeble.trc.bk beeble.trc ここで beeble.trc には、最新のトレースが格納されます。

   使用状況: gateway -f name -l -m

   例を示します。

   cd %WSHOME%\bin\winnt gateway -d -p 11319 -f %CD%\gateway.trc -l 2 -m 500

   上記の呼び出しにより、次の特性を備えたゲートウェイが起動します。

   • -d – 通常アプリケーションを使用 (サービス以外)

   • -p 11319 – ポート 11319 を使用

     ゲートウェイリソースには、Identity Manager のリソース設定からこのポートを設定しておく必要があります。たとえば、Active Directory リソースの場合

   • -f %CD%\gateway.trc – トレース出力の書き込み先となるディレクトリ。Identity Manager は、このディレクトリのトレース出力をテキストファイルに書き込みます。

   • -l 2 – ゲートウェイトレースの出力レベル 2。

   • -m – トレースのログファイルの最大サイズ (KB 単位)。

   ---

   注 –

   指定されていれば、次回ゲートウェイをコマンドラインからまたはサービスとして実行したときに同じ値が使用されるように、Identity Manager が -f 値、-l 値、および -m 値をレジストリに保存します。

   Identity Manager はゲートウェイのトレース出力をコンソールおよびトレースファイルに送信します。

   ---

PowerShellExecutor.dll アドオンのトレースを設定する方法

PowerShellExecutor.dll は、ゲートウェイと Microsoft PowerShell 間の通信を実装するアドオンです。この PowerShell は、Exchange Server 2007 アカウントを管理するのに使用します。このアドオンは、残りのゲートウェイとトレース機能を共有せず、残りのゲートウェイと同様のスタンドアロンのトレース機能を備えています。

PowerShellExecutor のトレース設定は、ほかのゲートウェイのレジストリキーとして同じレジストリキーに格納されます。

HKEY_LOCAL_MACHINE\Software\Waveset\Lighthouse\Gateway

このベースキーは、Identity Manager のデバッグページからトレースを設定したり、トレースコマンド引数でゲートウェイを開始すると作成されます。

シャットダウン時に、レジストリにトレースできるようにゲートウェイから現 PowerShellExecutor 設定が書き込まれます。次の設定があります。

• traceFileName

  コンテンツ。 トレース出力用のファイル名 (レジストリ型 REG_SZ)

  「デフォルト」。" "

  PowerShellExecutor トレースに生成するトレースファイル名。このファイル名には、

  • ファイル名などが省略されていないパスを設定できます。

  • スラッシュ (\) で終わることはできません。

    ファイルを除き、traceFileName 内の省略されていないパスが必要です。

    これが設定されている場合、そのファイルがもはやアクティブでなければ、ローテーション後にログのローテーションから設定済みファイル名にタイムスタンプが付与されます。このタイムスタンプは、次の形式で表示されます。

    yyyyMMddHHmmss

• traceLevel

  コンテンツ。 トレースレベル (レジストリ型 REG_DWORD)

  「デフォルト」。0 (トレースなし)

  許容。0–4

  このキーは、残りのゲートウェイと共有されます。ゲートウェイ全体は、常に同じレベルでトレースを行います。

• traceMaxSize

  「内容」。バイト単位の最大ファイルサイズ (レジストリ型 REG_DWORD または REG_QWORD)

  「デフォルト」。100000 バイト

  最小。100000 バイト

  ほかのシステムに移動できるよう、トレーステキストは、バイトオーダーマークが付いた UTF–8 エンコード化テキストで書き込まれます。

• traceMaxFiles

  「内容」。トレースファイル数 (レジストリ型 REG_DWORD )

  「デフォルト」。2

  最小。1

  この設定は、システムで保持するトレースファイル数を制御します。最大ファイル数の設定を 1 にし続けると、最大サイズに達したときにファイルが上書きされてしまいます。最後の書き込み時刻を基にして一番古いファイルは、最大ファイル数に達したときに削除されます。

• traceConfigInterval

  「内容」。ミリ秒単位のタイムアウト (レジストリ型 REG_DWORD)

  「デフォルト」。300000 ms (5 分)

  最小。60000 ミリ秒 (1 分)

すべてのトレース設定は、このタイムアウト値を基にしてレジストリから再読み取りされます。本稼動環境では、オーバーヘッドを最小限に抑えるために、この値を 24 時間などの大きな値に設定するようにしてください。

ワトソン博士のログを取り込む用法

ゲートウェイに深刻な問題が生じて異常終了した場合は、表示されたワトソン博士のログを Sun サポートに送信して解析を依頼することができます。

これらのログを表示するには、そのシステムの管理者権限が必要です。

ワトソン博士のログを取り込む

1. Windows の「イベントビューア」を開きます。

2. アプリケーションログを開きます。

3. DrWatson ソースのイベントを探します。

4. 詳細を表示するには、そのイベントを開きます。

5. 「データ」に「バイト」オプションが選択されていることを確認します。

6. ディスプレイダイアログを右クリックして、メニューから「すべて選択」を選択します。

7. 情報をコピーするには、Ctrl-C キーを押します。

8. この情報をメモ帳に貼り付け、ファイルを保存します。

9. 問題の詳細な説明を記述して、そのファイルを Sun サポートまで電子メールで送信します。実行中の Identity Manager ゲートウェイのバージョンを必ず記載してください。