Протоколирование и настройка параметров протоколирования

Протоколирование

JIRA использует мощный модуль протоколирования log4j для ведения журналов протоколирования.

Расположение файла журналов протоколирования.

Журналы записываются в подкаталог журнала вашего домашнего каталога JIRA (или в другом месте, если вы настроили другое местоположение). Вы можете просмотреть расположение atlassian-jira.log в разделе «Пути файлов» (File Paths) на странице «Сведения о системе».

Информация, связанная с безопасностью (например, логин, выход из системы, создание / уничтожение сеанса, отказ в безопасности) записывается в atlassian-jira-security.log.

Изменение местоположения журнала

В файле log4j.properties (расположенном в каталоге установки JIRA):

Измените следующую строку:


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

на следующую


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

Измените следующую строку, чтобы указать на новое местоположение файла журнала:


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

Уровни протоколирования

В log4j доступно пять уровней ведения журнала: «DEBUG», «INFO», «WARN», «ERROR» и «FATAL». Каждый уровень ведения журналов предоставляет дополнительную информацию о регистрации, которую имеет уровень перед ним:

'DEBUG'
'INFO'
'WARN'
'ERROR'
'FATAL'

«DEBUG» обеспечивает наиболее подробное ведение журнала, а «FATAL» обеспечивает наименьшее подробное ведение журнала. Уровень по умолчанию WARN, обозначает, что отображаются предупреждения и ошибки. Иногда полезно настроить этот уровень, чтобы увидеть больше деталей.(предупреждение). Помните: установка «DEBUG» может привести к регистрации паролей пользователей.

Уровни регистрации по умолчанию могут быть изменены либо

временно - ваше изменение уровня ведения журнала не будет сохраняться после следующего перезапуска JIRA или
навсегда - ваше изменение уровня ведения журнала будет сохраняться даже после перезапуска JIRA.

Например, при устранении неполадок вы можете временно изменить уровень ведения журнала с «ПРЕДУПРЕЖДЕНИЕ» (WARNING) на «ИНФО», чтобы получить более подробное сообщение об ошибке или трассировку стека. Если вы не уверены в том, какие категории журналов настраиваются, наиболее полезная информация обычно поступает из категории log4j.rootLogger и категорий log4j <category> .com.atlassian.

Для того чтобы произвести временное изменение уровня протоколирования, необходимо выполнить следующие шаги:

Войдите в систему как пользователь с глобальным разрешением «Системные администраторы JIRA».
Выберите > «Система» (System). Выберите «Устранение неполадок и поддержка» (Troubleshooting and Support)> «Регистрация и профилирование» (Logging & Profiling), чтобы открыть страницу ведения журнала, в которой перечислены все определенные категории log4j (как имена пакетов) и их текущие уровни ведения журнала.

Комбинация клавиш: 'g' + 'g' + начало ввода 'logging & profiling'

Чтобы изменить уровень ведения журнала в категории, щелкните связанный уровень ведения журнала, связанный с соответствующим именем пакета. Чтобы отключить ведение журнала категории, нажмите ссылку «ВЫКЛ» (OFF), связанную с соответствующим именем пакета.

Постоянное изменение уровня протоколирования

Отредактируйте (Edit) файл log4j.properties (расположенный в каталоге установки JIRA).
Найдите (Locate ) раздел:


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

и внесите необходимые изменения (например, измените WARN на DEBUG).

Файл log4j.properties, который поставляется с JIRA, имеет указанные уровни ведения журнала по умолчанию. Для получения дополнительной информации о log4j (например, о том, как определить новые категории ведения журнала) и о формате файла log4j.properties, обратитесь к документации на сайте log4j.

(Только если вы используете JIRA WAR) Перестройте и переустановите веб-приложение.
Перезапустите (Restart) JIRA.

Обратите внимание: если ваш сервер приложений настраивает сам журнал, вам может потребоваться удалить файл log4j.properties. Вам также может потребоваться удалить весь файл log4j.jar, чтобы получить доступ к журналу.

Настройка параметров протоколирования

Если у вас возникают проблемы с производительностью с JIRA, часто бывает полезно увидеть, где происходят замедление. Для этого вы можете включить настройку параметров протоколирования, как описано ниже, а затем проанализировать трассировки производительности, которые JIRA будет производить для каждого запроса. Ниже приведен пример трассировки профилирования:


[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

Настройка параметров протоколирования может быть включена либо

временно - настройка параметров протоколирования будет включена до следующего перезапуска JIRA или
постоянно - настройка параметров протоколирования останется включенной даже после перезапуска JIRA.

Чтобы произвести временное включение настройки параметров протоколирования, выполните следующие шаги:

Войдите в систему как пользователь с глобальным разрешением «Системные администраторы JIRA».
Выберите > «Система» (System). Выберите «Устранение неполадок и поддержка» (Troubleshooting and Support)> «Регистрация и настройка параметров протоколирования» (Logging & Profiling), чтобы открыть страницу ведения журнала, в которой перечислены все определенные категории log4j (как имена пакетов) и их текущие уровни ведения журнала.

Комбинация клавиш: 'g' + 'g' + начало ввода 'logging & profiling'

Прокрутите до раздела «Профилирование» (Profiling) в конце страницы. В этом разделе вы узнаете, включена ли в настоящее время настройка параметров протоколирования «ВКЛЮЧЕНО» (Disable) или «ВЫКЛ» (Enable) и предоставит вам «Отключить» или «Включить» профилирующие ссылки соответственно.

Чтобы включить профилирование «ВКЛ», нажмите ссылку «Включить настройку параметров протоколирования» (Enable profiling). JIRA начнет генерировать трассировку профилей в своем журнале.
Чтобы отключить настройку параметров протоколирования «ВЫКЛ», нажмите ссылку «Отключить профилирование» (Disable profiling).

Постоянное включение настройки параметров протоколирования

В каталоге установки JIRA отредактируйте файл atlassian-jira / WEB-INF / web.xml (или если вы используете дистрибутив JIRA WAR, файл webapp / 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 "true" -->
                autostart</param-name>
                <param-value>false</param-value>
            </init-param>
        </filter>

Измените параметр автозапуска как true, а не false. Это:


<init-param>
                <!-- specify the whether to start the filter automatically -->
                <!-- if not specified - defaults to "true" -->
                <param-name>autostart</param-name>
                <param-value>true</param-value>
</init-param>

Сохраните файл. Настройка параметров протоколирования будет включена при перезапуске JIRA.

Если вы используете JIRA WAR, повторно постройте и повторно разверните веб-приложение JIRA, используя скрипт сборки и инструкции для вашего сервера приложений (например, Apache Tomcat).

По материалам Atlassian JIRA Administrator's Guide: Logging and Profiling