How-To: Настройте Tomcat 9 для входа через Log4j2

Question

Как вы можете перенаправить внутреннюю регистрацию Tomcat 9 (catalina и localhost) в Log4j2?

Несмотря на то, что существует множество руководств для более старых версий Tomcat и Log4j, я не смог найти ничего «полного» относительно Tomcat 9 и Log4j2; документация Apache Tomcat 9 указывает на "инструкции, предоставляемые альтернативной структурой ведения журнала", а документация Apache Log4j указывает (исправлены имена jar в 2.):

Log4j может использоваться в качестве каркаса ведения журнала для Apache Tomcat. это поддержка реализуется автоматически, включая log4j-api, jar log4j-core и log4j-appserver в пути загрузки класса. Файл с именем log4j2-tomcat.xml, log4j2-tomcat.json, log4j2-tomcat.yaml, log4j2-tomcat.yml или log4j2-tomcat.properties также должны быть помещены в путь к классу загрузки. Это проще всего сделать:

1. Создание набора каталогов в доме catalina с именами log4j2 / lib и log4j2 / conf.
2. Размещение log4j-api-2.12.0.jar, log4j-core-2.12.0.jar и log4j-appserver-2.12.0.jar в каталоге log4j2 / lib.
3. Создание файла с именем log4j2-tomcat.xml, log4j2-tomcat.json, log4j2-tomcat.yaml, log4j2-tomcat.yml или log4j2-tomcat.properties в каталог log4j2 / conf.
4. Создайте или измените файл setenv.sh в каталоге bin tomcat, включив в него CLASSPATH=$CATALINA_HOME/log4j2/lib/*:$CATALINA_HOME/log4j2/conf

Но что поместить в этот файл конфигурации log4j2-tomcat. *?

Answer 1

Я нашел образец файла свойств в документации Apache Tomcat 7 , но поскольку он предназначен для использования с Log4j 1.x, мне пришлось адаптировать его к синтаксису файла свойств Log4j2.Вот результат:

# 'status' refers to log messages from Log4j2 itself
monitorInterval = 30
status = warn

property.loglevel.catalina = info
property.loglevel.localhost = info

property.layoutPattern.catalina = %d %-5p [%t] %-22.22c{1} %m%n
property.layoutPattern.localhost = %d %-5p [%t] %-30.30c{1} %m%n

# Roll-over the logs once per month using CronTriggerPolicy.

property.fileDatePattern.catalina = %d{yyyy-MM}
property.fileDatePattern.localhost = %d{yyyy-MM}

property.cronTriggerSchedule.catalina = 0 0 0 1 * ?
property.cronTriggerSchedule.localhost = 0 0 0 1 * ?

## Appenders

# N.B.: - No need to specify 'appenders = CATALINA, LOCALHOST, CONSOLE'
#         since these identifiers don't contain '.' characters.
#       - The sub-component identifiers 'policies' and 'cron' are arbitrarily
#         chosen; the actual type is specified via the 'type' attribute.
#       - 'DirectWriteRolloverStrategy' is used automatically since no 'fileName' specified.

appender.CATALINA.type = RollingFile
appender.CATALINA.name = RollingFile-CATALINA
appender.CATALINA.filePattern = ${sys:catalina.base}/logs/catalina.${fileDatePattern.catalina}.log
appender.CATALINA.layout.type = PatternLayout
appender.CATALINA.layout.pattern = ${layoutPattern.catalina}
appender.CATALINA.policies.type = Policies
appender.CATALINA.policies.cron.type = CronTriggeringPolicy
appender.CATALINA.policies.cron.schedule = ${cronTriggerSchedule.catalina}
appender.CATALINA.policies.cron.evaluateOnStartup = true
appender.CATALINA.filePermissions = rw-r-----
appender.CATALINA.fileOwner = tomcat
appender.CATALINA.fileGroup = adm

appender.LOCALHOST.type = RollingFile
appender.LOCALHOST.name = RollingFile-LOCALHOST
appender.LOCALHOST.filePattern = ${sys:catalina.base}/logs/localhost.${fileDatePattern.localhost}.log
appender.LOCALHOST.layout.type = PatternLayout
appender.LOCALHOST.layout.pattern = ${layoutPattern.localhost}
appender.LOCALHOST.policies.type = Policies
appender.LOCALHOST.policies.cron.type = CronTriggeringPolicy
appender.LOCALHOST.policies.cron.schedule = ${cronTriggerSchedule.localhost}
appender.LOCALHOST.policies.cron.evaluateOnStartup = true
appender.LOCALHOST.filePermissions = rw-r-----
appender.LOCALHOST.fileOwner = tomcat
appender.LOCALHOST.fileGroup = adm

# Uncomment if you want to keep logging to catalina.out after Log4j2 takes over.

#appender.CONSOLE.type = Console
#appender.CONSOLE.name = STDOUT
#appender.CONSOLE.layout.type = PatternLayout

## Configure which loggers log to which appenders

rootLogger.level = ${loglevel.catalina}
rootLogger.appenderRef.CATALINA.ref = RollingFile-CATALINA
#rootLogger.appenderRef.stdout.ref = STDOUT

# Here, the identifier does contain '.' characters, so we must specify the list.
loggers = org.apache.catalina.core.ContainerBase.[Catalina].[localhost]

logger.org.apache.catalina.core.ContainerBase.[Catalina].[localhost].name = LOCALHOST
logger.org.apache.catalina.core.ContainerBase.[Catalina].[localhost].level = ${loglevel.localhost}
logger.org.apache.catalina.core.ContainerBase.[Catalina].[localhost].appenderRef.LOCALHOST.ref = RollingFile-LOCALHOST

Основная причина для меня использовать Log4j2 состояла в том, чтобы иметь возможность получать ротацию журнала ежемесячно, но вы можете легко настроить все, как вам нравится, даже без перезапуска Tomcat.