IBM Rational DOORS での アプリケーション・メッセージ・ロギング

IBM® Rational® DOORS® では、 アプリケーション・メッセージを使用して、トラブルシューティング用に診断ログを制御できます。

バージョン 9.4 では、Apache log4cxx ロギング・サービスに基づくアプリケーション・メッセージ・ロギングが導入されました。 ログ・ファイル・サイズを制限すること、古いファイルの自動クリーンアップをセットアップすること、 出力ログ・ファイルの形式を選択すること、およびログ・レベルやログ構成を変更することを、 サーバーを再始動せずに実行できます。 構成ファイルは、変更を検出するために 60 秒ごとにモニターされます。

ロギング・モードには、低い順に、Debug、Info、Warn、Error、および Fatal の 5 つがあります。 各レベルでは、そのレベルと、それより上のすべてのレベルに関して情報がログに記録されます。 例えば、Warn レベルには、Warn モード、Error モード、および Fatal モードからの情報が含まれます。

Rational DOORS データベース・サーバーでは、 以前のロギング・スタイルが引き続きサポートされます。 これを有効にするには、-logfile コマンド行スイッチを使用します。 詳しくは、『データベース・サーバー用のコマンド・ライン・スイッチ』を参照してください。

ログ・ファイルに渡される情報は、XML ベースの構成ファイルによって制御されます。 以下の 2 つの構成ファイルが提供されています。

デフォルトでは、これらの ファイルは Rational DOORS ルート・パス (例: C:¥Program Files¥IBM¥Rational¥DOORS¥9.version) にあります。

.xml ファイル構成ファイル

アプリケーション・メッセージ・ロギングを制御するパラメーターは、構成ファイルの 2 つのセクションにあります。
  • アペンダー・パラメーターは、ログ・ファイルごとに、ログ・ファイル・パス、ログ・レベル、最大ファイル・サイズ、最大バックアップ索引、 および形式について設定を指定します。
  • ロガー・パラメーターは、ログ・モード全体に関する設定と、ロギング用に有効にできるアペンダーのセットを指定します。
表 1. アペンダー・パラメーター
名前 説明
appender name このパラメーターはアペンダーの名前であり、有効にするアペンダーを記述するために使用されます。 任意の値。例えば、SystemOutAppender。
file このパラメーター値は、作成されるログ・ファイルの名前とロケーションを指定します。 ご使用のシステム上のアクセス可能なロケーション。例えば、C:¥IBM¥DOORS¥log¥SystemError.log
append このパラメーターが true に設定されている場合は、file パラメーターで指定されているファイルに情報が追加されます。 このパラメーターが false に設定されている場合は、file パラメーターで指定されているファイルが上書きされます。 true または false
Threshold このパラメーターはログ・モードを設定します。 off、fatal、error、warn、info、または debug
threshold が fatal に設定されている場合は、致命的エラー情報のみがログ・ファイルに記録されます。 fatal
threshold が error に設定されている場合は、致命的エラー情報およびエラー情報がログ・ファイルに記録されます。 error
threshold が warn に設定されている場合は、致命的エラー情報、エラー情報、および警告情報がログ・ファイルに記録されます。 warn
threshold が info に設定されている場合は、致命的エラー情報、エラー情報、警告情報、および通知情報がログ・ファイルに記録されます。 info
threshold が debug に設定されている場合は、すべての情報がログ・ファイルに記録されます。 debug
threshold が off に設定されている場合は、ロギングは無効になります。 off
MaxFileSize このパラメーターは、ログ・ファイルの最大サイズを設定します。 ログ・ファイルが最大サイズに達すると、別のログ・ファイルが作成されます。 新規ファイルの名前には増分番号が含まれます。 単位を持つ任意の値。例えば、1000 KB。
MaxBackupIndex このパラメーターは、ロガーに対して作成されるファイルの最大数を設定します。 最大数に達すると、最も古いファイルに戻って、そのファイルが上書きされます。 任意の整数。
Conversion Pattern このパラメーターは、情報がログ・ファイルに記録されるときの形式を指定します。日時、ログ・モード、 およびログに記録される情報の要約を含めることができます。 この順序は、必要に応じて変更できます。 日付で始まる値: %d{dd MMM yyyy HH:mm:ss:SSS} [%p] %m%n
ログ・モードで始まる値: [%p] %m%n %d{dd MMM yyyy HH:mm:ss:SSS}
表 2. ロガー・パラメーター
パラメーター名 説明
priority このパラメーターは、ロギング全体に対するロギング・モード・レベルを設定します。 デフォルト設定は「all」です。 ロギングを無効にするには、このパラメーター値を「off」に設定します。 all、debug、error、fatal、info、off、または warn
appender-ref ref の値に、アペンダー・セクションで定義したアペンダーの名前が含まれます。 ロギング用に有効にしなければならないアペンダーに応じて、アペンダー名を指定する必要があります。 <appender-ref ref="DOORSConsoleAppender"/>
複数のアペンダーを有効にするには、複数の <appender-ref> タグを作成します。 <appender-ref ref="SystemOutAppender"/>

フィードバック