診断プロバイダーを使用すると、診断ドメインの開始構成、現在の構成、および現在の状態を照会することができます。
また、診断プロバイダーでは、診断ドメインから入手可能なあらゆる自己診断テストに
アクセスすることもできます。
始める前に
この作業を完了するには、ご使用のシステムのプログラミングに関する知識および以下のステップを実行するための適切な権限が必要です。
このタスクについて
以下のステップでは、診断プロバイダー (DP) の作成に関する一般的なプロセスを概説します。
プロシージャー
- 診断ドメインを決定します。
同一コンポーネント内で類似のドメインを制御する構成 MBean を探します。
現存の構成 MBean を DP インターフェースで拡張すると、新規 MBean が急増しないようにすることができます。
また、これにより、診断 MBean から構成 MBean にマッピングする場合に追加情報が不要になります。
- 公開する構成属性を決定します。
構成 MBean からコンポーネントを構成する際に使用される情報を含めるようにします。
- 公開する状態の属性を決定します。
ここでは、トラブルシューティングに関する、コンポーネントの状態について知りたいことを何でも聞くことができます。
- 公開する自己診断テストを決定します。
- 各自己診断に戻すテスト属性を決定します。
- DP 登録 Extensible Markup Language (XML) ファイルを作成します。
- DP 実装を作成します。
- 例については、診断プロバイダーのインプリメント
を参照してください。
また、診断プロバイダーで行う必要があることは、ほとんどすでに DiagnosticProviderHelper クラスで完了していることに
留意してください。
- 不要なデータが収集されていないことを確認するには、DiagnosticConfig オブジェクトを使用して、
状態データを収集する必要のあるコンポーネント・コードでフックを追加します。
- 保管する必要のあるコンポーネント・コードでフックを追加
するか、または構成データにアクセスできるようにします。
- コードを追加して、DP 実装を登録します。 通常、
これを行うのに最適な場所は、コンポーネントを初期化した場所です。
- 記録済みメッセージに、診断プロバイダー ID (DPID) を追加します。
DPID をロガーと共に登録すると、このロガーと共に記録されたどのメッセージによっても、情報が使用可能になります。
これにより、DP ユーティリティーでファースト・パスが使用可能になり、この特定の診断プロバイダーで機能します。
- ロガー (単一 DPID とのみ関連付ける任意のロガー) で DPID を登録します。
- 同一のロガーで複数の DPID を使用する場合は、(単一 DPID をロガーと共に登録する代わりに)
parm[0] の位置にある個々のロギング・コールに DPID を追加することができます。
対応するローカライズされたメッセージに、{0} を書き込まないでください。DPID は静的に割り当てられた DPID があるロガーからのメッセージと矛盾するため、DPID をメッセージに印刷しないようにしてください。