IBM® FileNet® Workplace XT では、Apache log4j 製品を使用してロギングを管理します。ロギング時には、アプリケーション・アクティビティーに関する情報がコンソールやファイルなどの出力場所に書き込まれます。サポート担当者や開発担当者はログ・エントリーの情報を使用して、アプリケーション・アクティビティーの分析、問題の診断および解決を行います。ロギングは診断のみを目的としており、セキュリティー情報や監査証跡情報は記録されません。
log4j 製品は、Workplace XT インストール時にインストールされます。デフォルトでは、インストール時にロギングが無効になっています。
ロギングを有効化または無効化するには:
ロギング設定の構成
サンプルの log4j.properties ファイルには、キーワード=値 のペアで指定された一連のデフォルト・オプションがあります。デフォルトを変更するには、テキスト・エディターで log4j.properties を開き、必要な変更を加えて、ファイルを保存します。ロギング設定の構成は、インストール後いつでも行うことができます。 ロギング構成ファイルに加えた変更内容は自動的に認識されるため、アプリケーションやアプリケーション・サーバーを再始動する必要はありません。
以下の各トピックで、このファイルに含まれる一部のロギング構成オプションについて説明します。 ロギング・オプションについて詳しくは、Apache Web サイト (http://apache.org) の「Logging」プロジェクト、および Apache ロギングの Web サイト (http://logging.apache.org/log4j/) を参照してください。
ロガー
ロガーは有効にされたロギング要求をアペンダーに書き込みます。 log4j.properties ファイル内で最初のキーワードは、ルート・ロガーを示します。 ルート・ロガーは階層内で最上位のロガーであり、グローバル・デフォルトを提供します。オプションが明示的に設定されていない子ロガーは、ルート・ロガーの動作を継承します。
アペンダー
ログ・データが書き込まれる場所は、アペンダーを構成することで指定できます。アペンダーは、フォーマットされたログ・エントリーを指定の出力先に送信します。宛先タイプには、ファイルまたはコンソールを指定できます。 出力を Windows イベント・ログにリダイレクトしたり、リモート log4j サーバーに転送したりすることができます。 (すべての出力先オプションおよびフォーマット・オプションについては、Apache log4j の資料を参照してください。) 1 つのロガーが複数のアペンダーを持つことができます。例えば、出力をコンソールとファイルに同時に書き込むことができます。出力先の数を増やすと、パフォーマンスに影響を与える可能性があります。
Workplace XT では、デフォルトで 2 つのアペンダーが構成されます。一方のアペンダーは、 ログ・データを IBM Common Base Event (CBE) フォーマットで書き込みます。CBE は、IBM Support Assistant ツールがログを処理する際に使用されるフォーマットです。もう一方のアペンダーは、ユーザーが読みやすいフォーマットで書き込みます。後者のアペンダーは、出力量を減らすように変更したり、完全にオフにしたりすることができます。
レベル
指定するロギング・レベルによって、収集される情報のタイプと量が決まります。収集される情報の量とシステムに及ぼすパフォーマンスの影響には、直接的な相関があります。
Workplace XT アプリケーション・ログでは、標準の INFO、WARN、ERROR、FATAL の各レベルに加え、ALL レベルと OFF レベルもサポートしています。 以下の表で、標準のレベルについて概説します。レベルについて詳しくは、Apache log4j の資料を参照してください。
レベル | 説明 |
---|---|
INFO | アプリケーションの進捗を大まかなレベルで示す通知メッセージを要求します。 |
WARN | 潜在的なエラーのロギングを要求します。 |
ERROR | アプリケーション内からスローされたロギング例外を要求します。 |
FATAL | アプリケーションの障害を引き起こす可能性が高い、非常に深刻なエラー・イベントのみのロギングを要求します。 |
指定するレベルによって、収集される情報の量が決まります。収集される情報の量とシステムに及ぼすパフォーマンスの影響には、直接的な相関があります。
出力ファイル・フォーマット
アペンダーの構成時には、layout キーワードを使用して、データの書き込みフォーマットを指定することができます。PatternLayout と ConversionPattern を選択します。PatternLayout はログ・エントリーの特定のパターンを指定します。ConversionPattern はアペンダーに書き込まれるエレメントのパターンを特定するもので、これによりパターンが定義されます。以下に例を示します。
log4j.appender.ErrorOutputFile=org.apache.log4j.RollingFileAppender log4j.appender.ErrorOutputFile.layout=org.apache.log4j.PatternLayout log4j.appender.ErrorOutputFile.layout.ConversionPattern=%d [%t] - %-5p %m¥r¥n
この場合、ログ・エントリーのフォーマットは以下のようになります。
2007-05-31 17:36:12:801 [cwrap] - Document/Checkin ConnectionWrapper.send send.before
フォーマット・オプションについて詳しくは、Apache log4j の資料を参照してください。
出力の分析
サポート担当者は、ログ・ファイル内のエントリーを検査して、アプリケーション・アクティビティーの分析や、アプリケーション内で発生した問題の診断を行うことができます。さらに、IBM Support Assistant (ISA) ツールを使用すると、分析フェーズを自動化できます。ISA ツールは、log4j からのロギング出力の CBE エントリーを利用します。
また、Apache Chainsaw (非 CBE ログ・エントリーをユーザー自身で検査できる GUI ベースのログ・ビューアー) のようなツールを使用することもできます。