ロギングとプロファイリング
ログ ファイルの場所
ログは Jira アプリケーションのホーム ディレクトリのlog
サブディレクトリ (別の場所を設定した場合はそのディレクトリ) に書き込まれます。atlassian-jira.log
の場所は、[システム情報] ページの [ファイル パス] セクションで確認できます。- セキュリティ関連情報 (例: ログイン、ログアウト、セッション作成 / 破棄、セキュリティ拒否) が
atlassian-jira-security.log
に書き込まれます。
ログの場所を変更する
log4j2.xml
ファイル (Jira アプリケーションのインストール ディレクトリにある) で、次のセクションを下記のとおり変更します。
<JiraHomeAppender name="filelog"
fileName="atlassian-jira.log"
filePattern="atlassian-jira.log.%i">
<PatternLayout alwaysWriteExceptions="false">
<Pattern>${StackTraceFilteringPattern}</Pattern>
</PatternLayout>
<Policies>
<SizeBasedTriggeringPolicy size="20480 KB"/>
</Policies>
<DefaultRolloverStrategy fileIndex="min" max="10"/>
</JiraHomeAppender>
変更後 (<LOG_PATH>
は目的の場所に置き換える):
<RollingFile name="filelog"
fileName="<YOUR LOGFILE PATH>"
filePattern="<YOUR LOGFILE PATH>.%i">
<PatternLayout alwaysWriteExceptions="false">
<Pattern>${StackTraceFilteringPattern}</Pattern>
</PatternLayout>
<Policies>
<SizeBasedTriggeringPolicy size="20480 KB"/>
</Policies>
<DefaultRolloverStrategy fileIndex="min" max="10"/>
</RollingFile>
アペンダ設定をさらに変更する場合は、「Log4j — Log4j 2 アペンダ」を参照してください。
ログ ファイルの場所を変更する場合、サポート zip を生成する際にログ ファイルは含まれなくなります。つまり、サポート リクエストにログを手動で添付する必要があります。
ログ レベル
log4j には、'DEBUG', 'INFO', 'WARN', 'ERROR'
、および 'FATAL'
の 5 つのログ レベルがあります。各ログ レベルは 1 つ下のログ レベルよりも多くのログ情報を提供します。
- 「DEBUG」
- 「INFO」
- 「WARN」
- 「ERROR」
- 「FATAL」
「DEBUG」は最も詳細なログを提供し、「FATAL」は最低限のログを提供します。既定のレベルは「WARN」です。このレベルでは警告とエラーが表示されます。より詳しい情報を確認する場合は、このレベルを調整すると便利です。
「DEBUG」に設定すると、ユーザのパスワードがログに記録されてしまう可能性があります。
デフォルトのログ レベルは一時的または恒久的に変更することができます。
たとえば、トラブルシューティングの際、ログ レベルを "WARNING" から "INFO" に一時的に変更して、より詳細なエラー メッセージやスタック トレースを取得することができます。調整すべきログ カテゴリが不明な場合、一般に Root ロガーや com.atlassian
ロガーから有用な情報を取得できます。
ログ レベルを一時的に変更する
- 上部のナビゲーション バーから [管理者 ] > [システム] を選択します。
- システム サポート > ロギングとプロファイリング を選択してログページを開くと、定義済みのすべての log4j カテゴリ (パッケージ名として) と現在のログレベルが表示されます。
- カテゴリーのログ レベルを変更するには、該当するパッケージ名に関連付けられたログ レベルのリンクを選択します。カテゴリーのログをオフにするには、該当するパッケージ名に関連付けられている「オフ」リンクを選択します。
リストにない別のパッケージのログ レベルを設定するには、[別のパッケージのログ レベルを設定] を選択します。これによって、パッケージとログ レベルを指定するように求められます。
ログ レベルを恒久的に変更する
log4j2.xml
ファイル (Jira アプリケーションのインストール ディレクトリ) を編集します。該当するセクションを探して変更を加えます (たとえば、
WARN
をDEBUG
に変更します)。<Logger name="com.atlassian" level="WARN" additivity="false"> <AppenderRef ref="filelog"/> </Logger>
Jira に同梱される
log42j.xml
ファイルには、既定のログ レベルが指定されています。Log4j 2 の詳細 (新しいログ カテゴリの定義方法など) と
log4j2.xml
ファイルの形式については、「Log4j — Apache Log4j 2」を参照してください。- Jira を再起動します。
アプリケーション サーバー自体でログが設定されている場合、log4j.properties
ファイルの削除が必要な場合があります。また、ログを機能させるために、log4j.jar
ファイル全体の削除が必要なこともあります。
プロファイリング
Jira でパフォーマンスに関する問題が発生した場合、パフォーマンスの低下がどこで起こっているかを確認することが一般に有用です。このためには、以下に示すようにプロファイリングを有効にした後、リクエストごとに Jira が生成するパフォーマンス トレースを分析します。プロファイリング トレースは、10 分の 1 ミリ秒単位で消費時間をレポートします。
プロファイリング情報は、atlassian-jira-profiler.log ファイルにあります。
プロファイリング トレースの例を示します。
[Filter: profiling] Turning filter on [jira_profile=on]
[116ms] - /secure/Dashboard.jspa
[5ms] - IssueManager.execute()
[5ms] - IssueManager.execute()
[5ms] - Searching Issues
[29ms] - IssueManager.execute()
[29ms] - IssueManager.execute()
[29ms] - Searching Issues
[28ms] - Lucene Query
[23ms] - Lucene Search
プロファイリングは一時的または恒久的に有効化することができます。
一時的にプロファイリングを有効化する
- 上部のナビゲーション バーから [管理者 ] > [システム] を選択します。
- システム サポート > ロギングとプロファイリング を選択してログページを開くと、定義済みのすべての log4j カテゴリ (パッケージ名として) と現在のログレベルが表示されます。
- ページの一番下の "プロファイリング" セクションまでスクロールします。このセクションはプロファイリングが現在 "オン" または "オフ" になっているかどうかを示し、プロファイリングをそれぞれ "無効化" または "有効化" するリンクを提供します。
- プロファイリングを「オン」にするには、「プロファイリングを有効化」リンクを選択します。Jira はプロファイリング トレースを開始して、atlassian-jira-profiler.log ファイルにデータを生成します。
- プロファイリングを「オフ」にするには、「プロファイリングを無効化」リンクを選択します。
恒久的にプロファイリングを有効化する
- Jira のインストール ディレクトリで、
atlassian-jira/WEB-INF/web.xml
ファイルを編集します。 以下のエントリを探します。
<filter> <filter-name>profiling</filter-name> <filter-class>com.atlassian.jira.web.filters.JIRAProfilingFilter</filter-class> <init-param> <!-- specify the which HTTP parameter to use to turn the filter on or off --> <!-- if not specified - defaults to "profile.filter" --> <param-name>activate.param</param-name> <param-value>jira_profile</param-value> </init-param> <init-param> <!-- specify the whether to start the filter automatically --> <!-- if not specified - defaults to "false" --> <param-name>autostart</param-name> <param-value>false</param-value> </init-param> </filter>
autostart
パラメーターを false ではなく true に変更します。<init-param> <!-- specify the whether to start the filter automatically --> <!-- if not specified - defaults to "false" --> <param-name>autostart</param-name> <param-value>true</param-value> </init-param>
- ファイルを保存します。プロファイリングは Jira を再起動すると有効になり、atlassian-jira-profiler.log ファイルでプロファイリング情報を確認できるようになります。