Merge pull request #1370 from jacol84/fixLog4j2

#1367 change log4j-1.2.17 to log4j-2.17.1
playframework · Feb 4, 2022 · d30db81 · d30db81
2 parents ed2368b + e599bac
commit d30db81
Show file tree

Hide file tree

Showing 19 changed files with 367 additions and 294 deletions.
diff --git a/.github/workflows/build-test.yml b/.github/workflows/build-test.yml
@@ -37,4 +37,5 @@ jobs:
           distribution: 'adopt'
 
       - name: Build with Ant
-        run: ant -buildfile ./framework/build.xml test
+        working-directory: ./framework
+        run: ant test
diff --git a/documentation/manual/logs.textile b/documentation/manual/logs.textile
@@ -1,6 +1,6 @@
 h1. Logging configuration
 
-The Play logger is built on "Log4j":http://logging.apache.org/log4j/1.2/index.html. Since most Java libraries use Log4j or a wrapper able to use Log4j as a backend, you can easily configure logging that is well-suited to your application.
+The Play logger is built on "Log4j":https://logging.apache.org/log4j/2.x. Since most Java libraries use Log4j or a wrapper able to use Log4j as a backend, you can easily configure logging that is well-suited to your application.
 
 
 h2. <a name="logging">Logging from your application</a>
@@ -30,14 +30,19 @@ If you need to fully configure Log4j, create a @log4j.properties@ file in the @c
 
 The default Log4j configuration is the following:
 
-bc. log4j.rootLogger=ERROR, Console
-
-log4j.logger.play=INFO
-
-# Console
-log4j.appender.Console=org.apache.log4j.ConsoleAppender
-log4j.appender.Console.layout=org.apache.log4j.PatternLayout
-log4j.appender.Console.layout.ConversionPattern=%d{ABSOLUTE} %-5p ~ %m%n
+bc. # appender Console
+appender.console.type = Console
+appender.console.name = STDOUT
+appender.console.layout.type = PatternLayout
+appender.console.layout.pattern = %d [%t] %p %c - %m%n
+appender.console.filter.threshold.type = ThresholdFilter
+appender.console.filter.threshold.level = INFO
+# play logger
+logger.app.name = play
+logger.app.level = INFO
+# root logger
+rootLogger.level = INFO
+rootLogger.appenderRef.console.ref = STDOUT
 
 Copy this file and update it for your specifics needs!
 

diff --git a/documentation/manual/production.textile b/documentation/manual/production.textile
@@ -46,17 +46,26 @@ For production it’s a good idea to use rolling log files. Do not send logging
 
 Create a custom @log4j.properties@ in the @conf/@ directory:
 
-bc. log4j.rootLogger=ERROR, Rolling
-
-log4j.logger.play=INFO
-
-# Rolling files
-log4j.appender.Rolling=org.apache.log4j.RollingFileAppender
-log4j.appender.Rolling.File=application.log
-log4j.appender.Rolling.MaxFileSize=1MB
-log4j.appender.Rolling.MaxBackupIndex=100
-log4j.appender.Rolling.layout=org.apache.log4j.PatternLayout
-log4j.appender.Rolling.layout.ConversionPattern=%d{ABSOLUTE} %-5p ~ %m%n
+bc. # appender Console
+appender.fileLogger.type = RollingFile
+appender.fileLogger.name = fileLogger
+appender.fileLogger.fileName= logs/application.log
+appender.fileLogger.filePattern= logs/application%i.log
+appender.fileLogger.layout.type = PatternLayout
+appender.fileLogger.layout.pattern = %d [%t] %p %c - %m%n
+appender.fileLogger.policies.type = Policies
+appender.fileLogger.policies.size.type = SizeBasedTriggeringPolicy
+appender.fileLogger.policies.size.size = 1MB
+appender.fileLogger.strategy.type = DefaultRolloverStrategy
+appender.fileLogger.strategy.max = 100
+appender.fileLogger.filter.threshold.type = ThresholdFilter
+appender.fileLogger.filter.threshold.level = ERROR
+# play logger
+logger.app.name = play
+logger.app.level = ERROR
+# root logger
+rootLogger.level = ERROR
+rootLogger.appenderRef.fileLogger.ref = fileLogger
 
 h2. <a name="server">Front-end HTTP server</a>
 

diff --git a/documentation/manual_ja/logs.textile b/documentation/manual_ja/logs.textile
@@ -1,6 +1,6 @@
 h1. ログの設定
 
-Play のロガーは組み込みの "Log4j":http://logging.apache.org/log4j/1.2/index.html です。ほとんどの Java ライブラリが Log4j か、または Log4j をバックエンドとして使えるラッパを使用するので、アプリケーションに適合するよう、容易にロギングを設定することができます。
+Play のロガーは組み込みの "Log4j":https://logging.apache.org/log4j/2.x/ です。ほとんどの Java ライブラリが Log4j か、または Log4j をバックエンドとして使えるラッパを使用するので、アプリケーションに適合するよう、容易にロギングを設定することができます。
 
 h2. <a name="logging">アプリケーションからのロギング</a>
 

diff --git a/framework/dependencies.yml b/framework/dependencies.yml
@@ -19,7 +19,7 @@ require:    &allDependencies
     - com.google.code.gson -> gson 2.8.9
     - com.jamonapi -> jamon 2.82
     - com.ning -> async-http-client 1.9.40
-    - commons-beanutils 1.9.4 
+    - commons-beanutils 1.9.4
     - commons-codec 1.15
     - org.apache.commons -> commons-email 1.5
     - commons-fileupload 1.4
@@ -38,7 +38,8 @@ require:    &allDependencies
     - org.hamcrest -> hamcrest-all 1.3
     - junit 4.13.2
     - jregex 1.2_01
-    - log4j 1.2.17
+    - log4j-api 2.17.1
+    - log4j-core 2.17.1
     - net.sf.ehcache -> ehcache 2.10.9.2
     - net.sf.ezmorph -> ezmorph 1.0.6
     - net.sf.jsr107cache -> jsr107cache 1.1
@@ -69,8 +70,8 @@ require:    &allDependencies
     - org.javassist -> javassist 3.28.0-GA
     - io.netty -> netty 3.10.6.Final
     - org.postgresql -> postgresql 42.3.1
-    - org.slf4j -> slf4j-api 1.7.33
-    - org.slf4j -> slf4j-log4j12 1.7.33
+    - org.slf4j -> slf4j-api 1.7.35
+    - org.apache.logging.log4j -> log4j-slf4j-impl 2.17.1
     - org.yaml -> snakeyaml 1.30
     - net.spy -> spymemcached 2.12.3
     - com.thoughtworks.xstream -> xstream 1.4.19

diff --git a/framework/lib/log4j-1.2.17.jar b/framework/lib/log4j-1.2.17.jar
diff --git a/framework/lib/log4j-api-2.17.1.jar b/framework/lib/log4j-api-2.17.1.jar
diff --git a/framework/lib/log4j-core-2.17.1.jar b/framework/lib/log4j-core-2.17.1.jar
diff --git a/framework/lib/log4j-slf4j-impl-2.17.1.jar b/framework/lib/log4j-slf4j-impl-2.17.1.jar
diff --git a/framework/lib/slf4j-api-1.7.33.jar → framework/lib/slf4j-api-1.7.35.jar b/framework/lib/slf4j-api-1.7.33.jar → framework/lib/slf4j-api-1.7.35.jar
diff --git a/framework/lib/slf4j-log4j12-1.7.33.jar b/framework/lib/slf4j-log4j12-1.7.33.jar
diff --git a/framework/src/log4j.properties b/framework/src/log4j.properties
@@ -1,23 +1,28 @@
-log4j.rootLogger=INFO, Console
+# appender Console
+appender.console.type = Console
+appender.console.name = ConsoleName
+appender.console.layout.type = PatternLayout
+appender.console.layout.pattern = %d [%t] %p %c - %m%n
+appender.console.filter.threshold.type = ThresholdFilter
+appender.console.filter.threshold.level = INFO
+# play logger
+logger.app.name = play
+logger.app.level = INFO
+logger.quartz.level=WARN
+logger.quartz.level.name=logger.org.quartz
+logger.hibernate.level=WARN
+logger.hibernate.level.name=logger.org.hibernate
+logger.DataNucleus.level=WARN
+logger.DataNucleus.level.name=logger.DataNucleus
+logger.httpclient.level=ERROR
+logger.httpclient.level.name=logger.org.apache.commons.httpclient=
+logger.internal.level=ERROR
+logger.internal.level.name=logger.net.sf.oval.internal=
+logger.springframework.level=WARN
+logger.springframework.level.name=logger.org.springframework
+logger.mchange.level=WARN
+logger.mchange.level.name=logger.com.mchange
 
-log4j.logger.play=INFO
-log4j.logger.org.quartz=WARN
-log4j.logger.org.hibernate=WARN
-log4j.logger.DataNucleus=WARN
-log4j.logger.org.apache.commons.httpclient=ERROR
-log4j.logger.net.sf.oval.internal=ERROR
-log4j.logger.org.springframework=WARN
-log4j.logger.com.mchange=WARN
-
-# Console
-log4j.appender.Console=org.apache.log4j.ConsoleAppender
-log4j.appender.Console.layout=org.apache.log4j.PatternLayout
-log4j.appender.Console.layout.ConversionPattern=%d{ABSOLUTE} %-5p ~ %m%n
-
-# Rolling files
-# log4j.appender.Rolling=org.apache.log4j.RollingFileAppender
-# log4j.appender.Rolling.File=${application.path}/logs/application.log
-# log4j.appender.Rolling.MaxFileSize=1MB
-# log4j.appender.Rolling.MaxBackupIndex=100
-# log4j.appender.Rolling.layout=org.apache.log4j.PatternLayout
-# log4j.appender.Rolling.layout.ConversionPattern=%d{DATE} %-5p ~ %m%n
+# root logger
+rootLogger.level = INFO
+rootLogger.appenderRef.console.ref = ConsoleName