Логирование и профилирование

Логирование

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

Примечание. Для всех следующих процедур вы должны войти в систему как пользователь с глобальными правами администратора JIRA.

Расположение файла журнала

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

Информация, связанная с безопасностью (например, логин, выход из системы, создание / уничтожение сеанса, отказ в безопасности) записывается в 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». Каждый уровень ведения журналов предоставляет дополнительную информацию о регистрации, которую имеет уровень перед ним:

• ‘ОТЛАДКА’
• ‘ИНФОРМАЦИЯ’
• ‘ПРЕДУПРЕЖДЕНИЕ’
• ‘ОШИБКА’
• ‘FATAL’

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

(предупреждение). Помните: установка «DEBUG» может привести к регистрации паролей пользователей.

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

 

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

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

 

Временное изменение уровня ведения журнала

Выберите шестеренка> Система.

Выберите «Поддержка системы»> «Регистрация и профилирование», чтобы открыть страницу «Ведение журнала», в которой перечислены все определенные категории log4j (как имена пакетов) и их текущие уровни ведения журнала.

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

Постоянное изменение уровня ведения журнала

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

Найдите раздел:

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

 

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

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

 

Перезапустите JIRA.

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

Профилирование

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

[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.

Временное включение профилирования

Выберите шестеренка со стрелкой> Система.

Выберите «Поддержка системы»> «Регистрация и профилирование», чтобы открыть страницу «Ведение журнала», в которой перечислены все определенные категории log4j (как имена пакетов) и их текущие уровни ведения журнала.

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

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

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

В каталоге установки 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 “true” –>
<param-name>autostart</param-name>
<param-value>false</param-value>
</init-param>
</filter>

Измените параметр автозапуска как истинный, а не 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.