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

ログ レベル

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.
Please be aware: the 'DEBUG' setting may cause user passwords to be logged.

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

• 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. Choose Administration at the top right of your screen. Then choose System > Troubleshooting and Support > Logging & Profiling to open the 'Logging' page, which lists all defined log4j categories (as package names) and their current logging levels.
   Keyboard shortcut: 'g' + 'g' + start typing 'logging & profiling'
3. カテゴリーのログ レベルを変更するには、該当するパッケージ名に関連付けられたログ レベルのリンクをクリックします。カテゴリーのログをオフにするには、該当するパッケージ名に関連付けられた「オフ」リンクをクリックします。

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

1. Edit the log4j.properties file (located in the JIRA Installation 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 WAR) Reduild and redeploy the web application.
4. Jira を再起動します。

Please Note: If your application server configures logging itself, you may need to remove the log4j.properties file. You may also need to remove the entire log4j.jar file to get logging to work.

プロファイリング

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. Choose Administration at the top right of your screen. Then choose System > Troubleshooting and Support > Logging & Profiling to open the 'Logging' page, which lists all defined log4j categories (as package names) and their current logging levels.
   Keyboard shortcut: 'g' + 'g' + start typing 'logging & profiling'
3. ページの一番下の「プロファイリング」セクションまでスクロールします。このセクションはプロファイリングが現在「オン」または「オフ」になっているかどうかを示し、プロファイリングをそれぞれ「無効化」または「有効化」するリンクを提供します。
   
   • プロファイリングを「オン」にするには、「プロファイリングの有効化」リンクをクリックします。JIRA はログにプロファイリングの追跡情報の生成を始めます。
   • プロファイリングを「オフ」にするには、「プロファイリングの無効化」リンクをクリックします。

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

1. In your JIRA installation directory, edit either the atlassian-jira/WEB-INF/web.xml file (or if you are using the JIRA WAR distribution, the webapp/WEB-INF/web.xml file).

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. autostart パラメーターを false ではなく true に変更します。

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

4. Save the file. Profiling will be enabled when you restart JIRA.
   If you are running JIRA WAR, re-build and re-deploy the JIRA web application using the build script and the instructions for your application server (i.e. Apache Tomcat).