Confluence ログを使用する
Confluence uses Apache's log4j 2 logging service. This allows administrators to control the logging behavior and the log output file. There are six log4j logging levels.
アトラシアン サポートにサポートを依頼すると、ほとんどの場合、Confluence のアプリ ログの提出を求められます。これらのログを最も簡単な方法で取得するには、[管理] メニュー > [一般設定] > [トラブルシューティングとサポート ツール] の順に選択し、指示に従ってサポート zip を作成します。
Confluence 11.0 and later: logging is configured in log4j2.xml. The Log4j 1 log4j.properties file is no longer read.
If you customised log4j.properties in an earlier version, you must recreate those changes in log4j2.xml. Confluence does not convert custom configuration automatically.
アプリケーション ログ ファイル
既定では、アプリケーション ログ ファイルは <local-home>/logs ディレクトリにあります。この場所は設定可能であるため、場所のログ設定を確認しなければならない場合があります。
問題のトラブルシューティングを容易にするために、アプリケーション ログはいくつかの異なるログ ファイルに分割されます。
- atlassian-confluence.log
メインのアプリ ログ ファイルであり、ほとんどのエントリがここに書き込まれます。Confluence を起動すると、コンソールに書き込まれたログ エントリも、このログで繰り返されます。 - atlassian-confluence-index.log
このファイルには、検索インデックスに関連するエントリが含まれます。 - atlassian-confluence-outgoing-mail.log
このファイルには、通知など、送信メールに関連するエントリが含まれます。 - atlassian-confluence-security.log
このファイルには、ユーザーおよびユーザー ディレクトリに関連するエントリが含まれます。 - atlassian-synchrony.log
このファイルには、共同編集を可能にする Synchrony 関連するエントリが含まれます。 - atlassian-diagnostics.log
このファイルには、ディスク容量やメモリ不足などの警告を提供する実験的な診断機能のエントリが含まれます。 - atlassian-confluence-jmx.log
このファイルには、インスタンスのステータスをリアルタイムに監視できる Java Management Extensions API メトリックのエントリが含まれます。 atlassian-confluence-app-monitoring.log
このファイルには、スケジュールに従って毎分収集されるアプリ関連の Java Management Extensions (JMX) API データのエントリが含まれています。- atlassian-confluence-ipd-monitoring.log
このファイルには、データベース接続や HTTP 接続メトリックなどの製品内診断用のエントリが含まれ、インフラストラクチャのパフォーマンスの問題を特定するのに役立ちます。 - atlassian-confluence-migrations.log
このファイルには、Cloud への移行に関連するエントリが含まれます。 atlassian-confluence-health-checks.log
このファイルには、Confluence インスタンスの起動中に検出され、解決する必要がある問題やエラーに関する詳細が含まれます。
ドキュメントでは、「アプリケーション ログ」を参照するときに、これらのファイルのいずれかを参照しています。
To see which classes or packages are logged to each file, open log4j2.xml and look at the <Logger> elements in the <Loggers> section. Each logger's <AppenderRef> names the appender, and so the file, that it writes to.
ログ ファイルの設定を変更する
Confluence および Synchrony でのログ記録の挙動は、以下のプロパティ ファイルで定義されています。
<CONFLUENCE-INSTALL>/confluence/WEB-INF/classes/log4j2.xml
This file is a standard log4j 2 XML configuration file, as described in the Apache log4j 2 documentation.
ログ ファイルの出力先を変更する
In log4j 2, an output destination is called an “appender”. To change the destination of the log files, you need to stop Confluence and then change the settings in the 'Logging Location and Appender' section of the log4j2.xml file.
Each Confluence log file uses Confluence's ConfluenceHomeRollingFile appender. It is configured like the standard Log4j 2 RollingFile appender, with fileName , filePattern , <Policies> , a rollover strategy, a layout, and filters. It also keeps early startup messages until the log directory is known, and responds to the Rollover log files option on the Logging and Profiling screen. To keep this behaviour, continue to use ConfluenceHomeRollingFile when you move a log, rather than replacing it with a standard RollingFile appender.
It handles file paths like this:
- Relative paths in
fileNameandfilePatternare resolved under<local-home>/logs. This is the default. - Absolute paths are used as they are.
To write a log to another location, stop Confluence and change both fileName and filePattern to absolute paths. The two attributes are resolved separately. If you change only fileName, the rotated files stay in <local-home>/logs. For example, to move the main application log to /var/log/confluence:
<ConfluenceHomeRollingFile name="confluencelog"
fileName="/var/log/confluence/atlassian-confluence.log"
filePattern="/var/log/confluence/atlassian-confluence.log.%i">
<ThresholdFilter level="DEBUG" onMatch="ACCEPT" onMismatch="DENY"/>
<Policies>
<SizeBasedTriggeringPolicy size="20480KB"/>
</Policies>
<DefaultRolloverStrategy max="5"/>
<PatternLayout alwaysWriteExceptions="false" pattern="%d %p [%t] [%c{4}] %M %enc{%m}{JSON}%n%loggingcontext%stacktrace"/>
</ConfluenceHomeRollingFile>
Synchrony ログファイルの出力先は、ファイルと同じ方法で変更できます。
Confluence ships with the full suite of appenders offered by log4j 2. Read more about appenders in the log4j 2 documentation.
詳細は、ナレッジ ベースの「別のログ ファイルに特定のエントリを送信するための、Confluence での log4j の設定」を参照してください。
注: ログ ファイルの場所を変更する場合、サポートの zZip を生成する際にログ ファイルは含まれなくなります。つまり、サポート リクエストにログを手動で添付する必要があります。
ログ ファイルのサイズと数を変更する
既定では、Confluence は 5 つのログ ファイルを保持します。これらのファイルは 20 MB に到達すると上書きされます。
<CONFLUENCE-INSTALL>/confluence/WEB-INF/classes/log4j2.xml ファイルで次の値を編集し、既定のログ サイズと保持するログ ファイルの数を変更できます。
<ConfluenceHomeRollingFile name="confluencelog" fileName="atlassian-confluence.log" filePattern="atlassian-confluence.log.%i">
...
<Policies>
<SizeBasedTriggeringPolicy size="20480KB"/> <!-- maximum size of each file -->
</Policies>
<DefaultRolloverStrategy max="5"/> <!-- number of rotated files to keep -->
...
</ConfluenceHomeRollingFile>
ログ レベルを変更する
これは Confluence UI で行うことができます。Confluence のログ設定を変更する方法の説明については、「ログ作成の設定」を参照してください。
特定の Confluence ロギング オプション
トラブルシューティングの際に必要となる可能性がある具体的なログ設定をいくつか紹介します。
データベースに対する SQL リクエストの詳細のログ記録
データベースに送信される個々の SQL リクエストを記録できるように、Confluence のログを増やすことができます。これは特定の問題のトラブルシューティングに役立ちます。「詳細な SQL ログの有効化」を参照してください。
各 Confluence ページにアクセスしているユーザーの詳細を記録する
Tomcat Valve を使用したアクセス ログは、既定で Confluence 7.11 から有効になっています。これらのログはアプリケーション ログの一部ではなく、<install directory>/logs/conf_access_log.<date>.log にあります。
ただし、どのユーザーが Confluence 内のどのページにアクセスしているか示すようアプリケーション ログを設定できます。ナレッジ ベースの「内部のみ - ユーザー アクセスのログ取得を有効化する方法」を参照してください。
既知の問題についてのログ ファイルのスキャン
アトラシアンのトラブルシューティングおよびサポート ツールには、Confluence ログのエラーを確認し、それがナレッジ ベースや課題トラッカーの既知の問題と一致するかどうかを照合するログ アナライザーが含まれます。
ログ ファイルの定期スキャンの設定方法については、「問題のトラブルシューティングおよび技術サポートの依頼」を参照してください。
問題をトラブルシューティングする際にログにマーク付け
アプリケーション ログ ファイルにマークを付けるには、次の手順を実行します。
- [管理] メニュー に移動して、[一般設定] > [ログとプロファイルの作成] の順に選択します。
- Confluence をクラスタで実行する場合は、クラスタ ノードを選択します。
- たとえば、「ディレクトリ同期の課題が再現します」というメッセージを入力します。
- マークを使用して新しいログ ファイルを開始する場合は、[Rollover log files (ログ ファイルのロールオーバー)] を選択します (これにより、最も古いログ ファイルが削除されます)。
- [マーク] を選択します。
スクリーンショット: クラスターのログとプロファイル画面
メッセージは、すべてのアプリケーション ログ ファイル (atlassian-confluence.log や atlassian-confluence-security.log など) に追加されます。ログには、必要な頻度でマークを付けることができます。
例:
...
2021-01-04 13:21:47,421 INFO [http-nio-8090-exec-5
[impl.admin.actions.MarkAllLogsAction] execute
***********************************************
Reproduce directory sync issue
************************************************
2021-01-04 13:25:23,901 ERROR [test error] [atlassian.confluence.test] This
is a sample error java.lang.RuntimeException: Unable to find sample error
for testuser
...
Tomcat ログ
Confluence のインストール ディレクトリには、Confluence サイトに関する課題をトラブルシューティングする際に役立つ追加のログがいくつかあります。
<install directory>/logs/catalina-<date>.log
このログは、アプリケーション サーバーの起動や停止などの Tomcat 操作を記録します。<install directory>/logs/conf_access_log.<date>.log
Confluence のアクセス ログはここにあります。これらのログは、server.xmlで設定されます。設定オプションの詳細については、「Tomcat アクセス ログ バルブ」のドキュメントを参照してください<install directory>/logs/gc.<date>.log
ガベージ コレクションのログがここにあります。これらのログは、GC の一時停止が長くなる場合に役立つ情報を提供します。
