ログおよびトレース・アナライザーのロギング設定

「ロギング設定 (Logging preferences)」ウィンドウ (「ウィンドウ」>「設定」>「ロギング (Logging)」) により、 製品のプラグインが書き込むログ・ファイル CommonBaseEvents.xml (workspace/.metadata ディレクトリーにあります) に記録されるメッセージのレベル設定を指定できます。 また、これにより、 アーカイブ・ログ・ファイルが削除されるまでの日数も設定することができます。

通常、このログ・ファイルはプラグイン開発者に関連します。 ワークベンチを開始するたびに新しい CommonBaseEvents.xml ファイルが作成され、 それまでの CommonBaseEvents.xml ファイルはアーカイブされます。

ロギング設定ページは、「一般」タブと「ロガー (Loggers)」タブで構成されます。

一般」ロギング設定タブ

このタブには、ワークベンチのデフォルト・ロギング・オプションが表示され、 以下のフィールドがあります。

デフォルトのロギング・レベル (Default logging level)

ロガー (Loggers)」タブで特定のロギング・レベルが設定 (以下を参照) されていない場合、 すべてのロガーにデフォルトでこのロギング・レベルが適用されます。 デフォルト・レベルは、com.ibm.etools.common.logging.commonLoggingDefaultOptions 拡張ポイントによって指定され、 「NONE」に初期設定されます。

選択されたロギング・レベルと同じかそれ以上のメッセージだけが、CommonBaseEvents.xml ファイルに記録されます。 「NONE」が選択されていると、メッセージはログに記録されません。 詳しくは、ロギング・レベル設定のロギング・レベル情報の順序を参照してください。

アーカイブ・ファイルの日数 (Archived file days)
アーカイブされたログ・ファイルを削除するまでの日数を設定します。 デフォルトは 7 日です。日数を 0 に指定すると、アーカイブされたファイルは削除されません。 アーカイブ・ログ・ファイルは、ワークベンチが開始されるたびに作成され、 前のセッションからのロギング情報を保管します。
 
アーカイブ・ファイル名の形式は、CommonBaseEventstimestamp.xml です。 ここで、timestamp は、標準の JavaTM タイム・スタンプ (1970 年 1 月 1 日の午前 0 時 (UTC) から ファイルがアーカイブされた時刻までの正確な時間をミリ秒で表したもの) です。 例えば、2002 年 6 月 6 日における東部夏時間の午前 11 時 30 分 20 秒にアーカイブされたファイル名は、CommonBaseEvents1023377420784.xml になります。

「ロガー (Loggers)」ロギング設定タブ

ロガー (Loggers)」タブには、com.ibm.etools.common.logging プラグインに よって定義されている com.ibm.etools.common.logging.commonLoggingOptions 拡張ポイントを 実装するプラグインが表示されます。

テーブルには以下の列があります。

ロガー名 (Logger Name)
commonLoggingOptions 拡張ポイントが指定するロガーの名前。 名前が指定されていない場合は、com.ibm.etools.common.logging.commonLoggingDefault 拡張ポイント が定義したデフォルトのロギング名が使用されます。
 
ロギング・レベル (Logging Level)
commonLoggingOptions 拡張ポイントが指定するロギング・レベル。 ロギング・レベルとは、ある一定の詳細度以下のメッセージをログ・ファイルに記録する、そのレベルのことです。つまり、 ロギング・レベルが高くなるほど、ログに記録される情報量は少なくなります。 選択された (つまり、loggingOptions 拡張ポイントで指定された) ロギング・レベルと 同じかそれ以上のメッセージだけが、CommonBaseEvents.xml ファイルに記録されます。 選択されたレベルが NONE である場合、メッセージはログに記録されません。

ロギング・レベル設定を変更する場合、セルをクリックしてドロップダウン・リストから新規の値を選択するか、 変更したい行を選択して「編集」をクリックします。

ロギング・レベルの順序は、次のとおりです。

  1. ALL (すべて) (すべての情報がログに記録されます)
        ALL (すべて) は、すべてのメッセージをログに記録することを示します。
  2. FINEST (最も詳細) (最低レベル: ほとんどの情報がログに記録されます)
        FINEST (最も詳細) は、非常に詳細なトレース・メッセージを示します。
  3. FINER (より詳細)
        FINER (より詳細) は、かなり詳細なトレース・メッセージを示します。
  4. FINE (詳細)
        FINE (詳細) は、トレース情報を提供するメッセージ・レベルです。
  5. CONFIG (構成)
        CONFIG (構成) は静的構成メッセージ用のメッセージ・レベルです。
  6. INFO (通知)
        INFO (通知) は通知メッセージ用のメッセージ・レベルです。
  7. WARNING (警告)
        WARNING (警告) は潜在的な問題を示すメッセージ・レベルです。
  8. SEVERE (重大) (最高レベル: 最も少ない情報がログに記録されます)
        SEVERE (重大) は、重大な失敗を示すメッセージ・レベルです。
  9. NONE (なし) (ロギングなし)
        NONE (なし) は、ロギングをオフにするために使用する特殊なレベルです。

たとえば、「WARNING (警告)」を選択すると、 「SEVERE (重大)」メッセージは組み込まれますが、 「INFO (通知)」メッセージは組み込まれません。

注:

関連タスク
「ロギング設定 (Logging preferences)」ウィンドウを使用したプラグイン・ロギングの構成
plugin.xml ファイルを使用したプラグイン・ロギングの構成