ログ作成の設定

用語: log4j で、"logger" は、名前を持つエンティティです。logger 名では大文字と小文字が区別され、階層的な命名基準に従います。たとえば、com.foo という名前の logger は、com.foo.bar という名前の logger の親です。

Confluence 動作中にログ作成動作を一時的に変更する

問題のトラブルシューティングを行う場合、Confluence の実行中にログ作成動作を一時的に変更できます。これらの変更は log4j.properties ファイルには書き込まれないため、Confluence を次回停止したときに破棄されます。

既存のクラスまたはパッケージのログ レベルを変更する

これを実行するには、システム管理者グローバル権限が必要です。特定のレベルについては、「4j ログ作成レベル 」を参照してください。 

既存のクラスまたはパッケージのログ レベルを変更するには、次の手順を実行します。

1. Go to Administration then General Configuration > Logging and Profiling.
2. Confluence をクラスタで実行する場合は、クラスタ ノードを選択します。
3. 関連するクラスまたはパッケージを探し、[New Level (新しいレベル)] ドロップダウンから値を選択します。
4. 変更を [保存] します。

または、特定のクラスまたはパッケージのログ作成を停止する場合は、[削除] を選択します。

変更は log4j.properties ファイルには書き込まれないため、Confluence を次回停止したときに破棄されます。

追加のクラスまたはパッケージのログ作成を追加する

Atlassian のサポート チームは、特定の問題のトラブルシューティングを行う際、追加のログ作成を有効にするように依頼する場合があります。これを実行するには、システム管理者グローバル権限が必要です。 

新しいクラスまたはパッケージのログ レベルを設定するには、次の手順を実行します。

1. Go to Administration then General Configuration > Logging and Profiling.
2. Confluence をクラスタで実行する場合は、クラスタ ノードを選択します。
3. [クラス/パッケージ名] フィールドに名前を入力します。これは com.atlassian.confluence.example のようになります。
4. [エントリの追加] を選択して、新しいクラスまたはパッケージをリストに追加します。
5. 関連するクラスまたはパッケージを探し、[New Level (新しいレベル)] ドロップダウンから値を選択します。
6. 変更を保存します。

ページ プロファイル作成のオンまたはオフ

ページ プロファイリングの使用タイミングと使用方法の詳細は、「ページ リクエスト プロファイリングを使用してパフォーマンス低下をトラブルシューティングする」を参照してください。 

詳細な SQL ログ作成のオンまたはオフ

詳細な SQL ログ作成の使用タイミングと使用方法の詳細は、「詳細 SQL ログ作成の有効化」を参照してください。

事前設定されたログ作成構成

Confluence では、事前設定された 2 つのログ構成方法を提供します。

• 本番環境
  これは推奨されるデフォルト設定で、ログをフラッディングすることなく最も重要な情報を提供することを目的としています。 
• 診断
  これは、ほとんどのパッケージのログ レベルをデバッグに変更します。トラブルシューティング時には便利ですが、パフォーマンスが低下し、ログファイルがより迅速にいっぱいになります。

ログ作成構成をデフォルトにリセットする場合は、[本番環境] を選択します。

スクリーンショット: ログレベルの変更とプロファイル作成 

プロパティ ファイルのログ レベルを永続的に変更する

これを行うには、インストール ディレクトリにアクセスする必要があります。 

log4j.properties ファイルには、すべてのデフォルトのクラスとパッケージ、および有効にするように選択できる追加のパッケージが一覧表示されます。 

 クラスまたはパッケージのログ レベルを永続的に変更するには、次の手順を実行します。

1. Confluence を停止します。
2. <CONFLUENCE-INSTALL>/confluence/WEB-INF/classes/log4j.properties ファイルを編集します。
3. [ログ レベル] で、変更するパッケージを見つけます。必要に応じて、# 記号を削除して、パッケージのコメントを解除します。

4. ログ レベルを [デバッグ]、[情報]、[警告]、[エラー]、または [重大] に変更します。許容値については、log4j ログ レベルを参照してください。例:
   
   

   log4j.logger.com.atlassian.confluence.cache=DEBUG

5. ファイルを保存し、Confluence を再起動して変更を有効にします。

Confluence をクラスタで実行している場合は、すべてのノードで変更を繰り返す必要があります。各ノードを 1 つずつ下げることができます。クラスタ全体を停止する必要はありません。

まだ一覧されていないクラスまたはパッケージを記録する場合は、単にファイルに追加します。詳細については、log4j のドキュメントを参照してください。 

ログの場所、番号、サイズを変更する場合は、「Confluence ログを使用する」を参照してください。

logging.properties で java.util.logging のレベルを設定する

Confluence では、log4j や slf4j ではなく java.util.logging を使用するライブラリをいくつか使用しています。該当するライブラリは以下のとおりです。

• com.sun.jersey
• org.apache.shindig

Confluence の logging.properties ファイルは、特定のレベルの java.util.logging を slf4j 経由で log4j にリダイレクトするように設定されています。

これらのライブラリのログ レベルを上げるには、まず <CONFLUENCE-INSTALL>/confluence/WEB-INF/classes/ にある logging.properties ファイルを設定する必要があります。ログ レベルは log4j とは異なります。詳細な手順については、Java 11 ドキュメントの java.util.logging を参照してください。

たとえば、shindig のログ レベルを上げるには、logging.properties ファイル内の次の行を変更します。

org.apache.shindig.level = INFO

to

org.apache.shindig.level = FINE

その後、同様に上述のいずれかの方法を使用して log4j レベルを設定します。

ロガーのバースト制限を設定する

Confluence では、log4j2 BurstFilter 実装を使用してロガーのバースト制限が可能です。このメカニズムの詳細をご覧ください。

特定のロガーにバースト制限を追加するには、次の手順を実行します。

1. Confluence を停止します。
2. \<CONFLUENCE-INSTALL>/confluence/WEB-INF/classes/burstFilterConfiguration.properties ファイルを編集します。

3. 次の設定を例にして、ファイルを設定します。

   1. loggerId は、フィルターをアタッチするロガーの任意の ID です。

   2. loggerName はロガーのクラス名です。
   3. level は、ログをフィルタリングするログ レベルです。このレベル以下のものはすべてフィルタリングの対象となります。
   4. rate は、1 秒間に許可されるイベントの平均数です。

   5. maxBurst は、フィルタリングが開始される前に発生する可能性のあるイベントの最大数です。 

      burstFilter.{loggerId}={loggerName}  
      burstFilter.{loggerId}.maxBurst=5  
      burstFilter.{loggerId}.rate=0.5F  
      burstFilter.{loggerId}.level=WARN

      例: 

      burstFilter.analyticsLogger=com.atlassian.analytics.client.pipeline.PipelineExecutionService  
      burstFilter.analyticsLogger.maxBurst=5  
      burstFilter.analyticsLogger.rate=0.5F  
      burstFilter.analyticsLogger.level=WARN

4. ファイルを保存し、Confluence を再起動して変更を有効にします。