ロギングとプロファイリング

On this page:

ログ

JIRA uses a powerful logging module called log4j for runtime logging.

ログ ファイルの場所

The logs are written to your JIRA Home Directory (or the current working directory, if the JIRA home directory is not configured). You can view the location of the atlassian-jira.log (and the current working directory) in the 'File Paths' section of the System Information page.

• セキュリティ関連情報 (例: ログイン、ログアウト、セッション作成 / 破棄、セキュリティ拒否) が atlassian-jira-security.log に書き込まれます。

ログの場所を変更する

In the log4j.properties file (located in the JIRA Home Directory),

1. 以下の行を

   log4j.appender.filelog=com.atlassian.jira.logging.JiraHomeAppender

   以下のように変更します。

   log4j.appender.filelog=org.apache.log4j.RollingFileAppender

2. 以下の行をログファイルの新しい場所を指定するように変更します。

   log4j.appender.filelog.File=atlassian-jira.log

ログ レベル

log4j には、'DEBUG', 'INFO', 'WARN', 'ERROR'、および 'FATAL' の 5 つのログ レベルがあります。各ログ レベルは 1 つ下のログ レベルよりも多くのログ情報を提供します。

• 「DEBUG」
• 「INFO」
• 「WARN」
• 「ERROR」
• 「FATAL」

'DEBUG' provides the most verbose logging and 'FATAL' provides the least verbose logging. The default level is WARN, meaning warnings and errors are displayed. Sometimes it is useful to adjust this level to see more detail.

デフォルトのログ レベルは一時的または恒久的に変更することができます。

• temporarily — your change to the logging level will not persist after you next restart JIRA, or
• permanently — your change to the logging level will persist, even after you restart JIRA.

例えばトラブルシューティングの際、ログ レベルを "WARNING" から "INFO" に一時的に変更して、より詳細なエラー メッセージやスタック トレースを取得することができます。必要なログ カテゴリが不明な場合、一般に log4j.rootLogger カテゴリや log4j<category>.com.atlassian カテゴリで有用な情報を取得できます。

ログ レベルを一時的に変更する

1. Log in as a user with the 'JIRA System Administrators' global permission.
2. Bring up the administration page by clicking either the 'Administration' link on the top bar or the title of the Administration box on the dashboard.
3. Under the 'System' sub-menu in the left-hand navigation column, click the 'Logging & Profiling' link.
4. The 'Logging & Profiling' page will display. This lists all the defined log4j categories and their current logging levels. To edit the logging level of a category, click the 'Edit' link next to the category in the list.
5. Choose the new logging level for the category, then click 'Update'.

ログ レベルを恒久的に変更する

1. Edit the log4j.properties file, which is found in the WEB-INF/classes/ directory under the JIRA web application directory.
2. 以下の部分に移動します。

   log4j.logger.com.atlassian = WARN, console, filelog
   log4j.additivity.com.atlassian = false
   

   and make your desired changes (e.g. change the WARN to DEBUG).

   The log4j.properties file that ships with JIRA has the default logging levels specified. For more information about log4j (e.g. how to define new logging categories), and about the format of the log4j.properties file, please refer to the documentation on the log4j site.

3. (Only if you are running JIRA EAR-WAR) Reduild and redeploy the webapp.
4. Jira を再起動します。

プロファイリング

If you are using JIRA version 4.2.0 or 4.2.1, we strongly recommend that you do not enable profiling as this will cause JIRA to generate an error when the 'Watched Issues' gadget is used on the Dashboard. (See JRA-22623 for details.) To resolve this issue, upgrade to JIRA 4.2.2 or later.

If you are experiencing performance issues with JIRA, it is often helpful to see where the slow-downs occur. To do this you can enable profiling as described below, and then analyse the performance traces that JIRA will produce for every request. An example of a profiling trace is shown below:

[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

プロファイリングは一時的または恒久的に有効化することができます。

• temporarily — profiling will be enabled until you next restart JIRA, or
• permanently — profiling will remain enabled, even after you restart JIRA.

一時的にプロファイリングを有効化する

1. Log in as a user with the 'JIRA System Administrators' global permission.
2. Bring up the administration page by clicking either the 'Administration' link on the top bar or the title of the Administration box on the dashboard.
3. Under the 'System' sub-menu in the left-hand navigation column, click the 'Logging & Profiling' link.
4. The 'Logging & Profiling' page will display. Scroll to the bottom of the screen. The 'Profiling' section will inform you whether profiling is currently turned 'ON' or 'OFF', and will also show or hide the 'Disable profiling' and 'Enable profiling' links respectively.
   • To turn Profiling 'ON', click the 'Enable profiling' link. JIRA will start generating profiling traces in its log.
   • To turn Profiling 'OFF', click the 'Disable profiling' link.

恒久的にプロファイリングを有効化する

1. Edit atlassian-jira/WEB-INF/web.xml (if you are using JIRA Standalone) or webapp/WEB-INF/web.xml in your JIRA installation directory (if you are using JIRA EAR/WAR).
2. 以下のエントリを探します。

           <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 "true" -->
                   <param-name>autostart</param-name>
                   <param-value>false</param-value>
               </init-param>
           </filter>
       

3. Modify the autostart parameter to be true instead of false. That is:

               <init-param>
                   <!-- フィルターを自動的に開始するかどうか指定 -->
                   <!-- 指定しない場合、デフォルトで "true" となります。 -->
                   <param-name>autostart</param-name>
                   <param-value>true</param-value>
               </init-param>
       

4. Save the file. If you are running JIRA Standalone this is all you have to do. Profiling will be enabled when you restart JIRA.
5. If you are running JIRA EAR/WAR, re-build and re-deploy the JIRA web application using the build script and the instructions for your application server.