From d05c282baa6640c94a45fa0f2673b0f82c484017 Mon Sep 17 00:00:00 2001 From: Greg Wilkins Date: Fri, 17 Jun 2016 23:32:37 +1000 Subject: [PATCH] Issue #644 Modules for enabling logging Improved descriptions --- jetty-util/src/main/config/modules/jcl-slf4j.mod | 3 ++- jetty-util/src/main/config/modules/jcl.mod | 3 ++- jetty-util/src/main/config/modules/jetty-jul.mod | 3 ++- jetty-util/src/main/config/modules/jetty-logging.mod | 3 ++- jetty-util/src/main/config/modules/jetty-slf4j.mod | 3 ++- jetty-util/src/main/config/modules/log4j-log4j2.mod | 4 +++- jetty-util/src/main/config/modules/log4j.mod | 3 ++- jetty-util/src/main/config/modules/log4j2-api.mod | 6 +++--- jetty-util/src/main/config/modules/log4j2-core.mod | 3 ++- jetty-util/src/main/config/modules/log4j2-slf4j.mod | 5 +++-- jetty-util/src/main/config/modules/slf4j-api.mod | 3 --- jetty-util/src/main/config/modules/slf4j-jcl.mod | 4 +++- jetty-util/src/main/config/modules/slf4j-log4j.mod | 4 +++- jetty-util/src/main/config/modules/slf4j-simple.mod | 3 ++- 14 files changed, 31 insertions(+), 19 deletions(-) diff --git a/jetty-util/src/main/config/modules/jcl-slf4j.mod b/jetty-util/src/main/config/modules/jcl-slf4j.mod index 2b2f7d2cd33..fa82ef4dea3 100644 --- a/jetty-util/src/main/config/modules/jcl-slf4j.mod +++ b/jetty-util/src/main/config/modules/jcl-slf4j.mod @@ -1,5 +1,6 @@ [description] -Provides JCL implementation that routes logs into slf4j +Provides a Java Commons Logging implementation that logs to the SLF4J API. +Requires another module that provides and SLF4J implementation. [depends] slf4j-api diff --git a/jetty-util/src/main/config/modules/jcl.mod b/jetty-util/src/main/config/modules/jcl.mod index 95ce66d163b..f3640a1b71c 100644 --- a/jetty-util/src/main/config/modules/jcl.mod +++ b/jetty-util/src/main/config/modules/jcl.mod @@ -1,5 +1,6 @@ [description] -Provides Apache Java Commons Logging API and implementation +Provides a Java Commons Logging implementation. +To receive jetty logs the jetty-slf4j and slf4j-jcl must also be enabled. [depends] diff --git a/jetty-util/src/main/config/modules/jetty-jul.mod b/jetty-util/src/main/config/modules/jetty-jul.mod index 80792d70c40..ed7340af74c 100644 --- a/jetty-util/src/main/config/modules/jetty-jul.mod +++ b/jetty-util/src/main/config/modules/jetty-jul.mod @@ -1,5 +1,6 @@ [description] -Enables Java util logging +Provides a Jetty Logging implementation that logs to the Java Util Logging API. +Requires another module that provides a Java Util Logging implementation. [provide] logging diff --git a/jetty-util/src/main/config/modules/jetty-logging.mod b/jetty-util/src/main/config/modules/jetty-logging.mod index 9ee296e8ede..3b46e5954ca 100644 --- a/jetty-util/src/main/config/modules/jetty-logging.mod +++ b/jetty-util/src/main/config/modules/jetty-logging.mod @@ -1,5 +1,6 @@ [description] -Enables Java util logging +Enables the Jetty Logging implementation and installs a template +configuration in ${jetty.base} resources/jetty-logging.properties. [depends] resources diff --git a/jetty-util/src/main/config/modules/jetty-slf4j.mod b/jetty-util/src/main/config/modules/jetty-slf4j.mod index 25a4063d4b6..3836363748d 100644 --- a/jetty-util/src/main/config/modules/jetty-slf4j.mod +++ b/jetty-util/src/main/config/modules/jetty-slf4j.mod @@ -1,5 +1,6 @@ [description] -Configure Jetty logging to use SLF4J +Provides a Jetty Logging implementation that logs to the SLF4J API. +Requires another module that provides and SLF4J implementation. [depend] slf4j-api diff --git a/jetty-util/src/main/config/modules/log4j-log4j2.mod b/jetty-util/src/main/config/modules/log4j-log4j2.mod index f299f10135d..7f8b2246c6d 100644 --- a/jetty-util/src/main/config/modules/log4j-log4j2.mod +++ b/jetty-util/src/main/config/modules/log4j-log4j2.mod @@ -1,5 +1,7 @@ [description] -Provides Apache Log4j 1.2 bridge to Log4j 2. +Provides a Log4j v1.2 implementation that logs to the Log4j v2 API. +Requires another module that provides and Log4j v2 implementation. +To receive jetty logs the jetty-slf4j and slf4j-log4j must also be enabled. [depends] log4j2-impl diff --git a/jetty-util/src/main/config/modules/log4j.mod b/jetty-util/src/main/config/modules/log4j.mod index 3e002bd1f0e..b94aebe0e78 100644 --- a/jetty-util/src/main/config/modules/log4j.mod +++ b/jetty-util/src/main/config/modules/log4j.mod @@ -1,5 +1,6 @@ [description] -Provides Apache Log4j 1.2 +Provides a Log4j v1.2 API and implementation. +To receive jetty logs enable the jetty-slf4j and slf4j-log4j modules. [depends] resources diff --git a/jetty-util/src/main/config/modules/log4j2-api.mod b/jetty-util/src/main/config/modules/log4j2-api.mod index 66a6b8c5b5f..9a5dae7d9dc 100644 --- a/jetty-util/src/main/config/modules/log4j2-api.mod +++ b/jetty-util/src/main/config/modules/log4j2-api.mod @@ -1,7 +1,7 @@ [description] -Provides Apache Log4j 2 API. -Requires a log4j 2 implementation module -Use slf4j-log4j module to link jetty logging +Provides the Log4j v2 API +Requires another module that provides an Log4j v2 implementation. +To receive jetty logs enable the jetty-slf4j, slf4j-log4j and log4j-log4j2 modules. [files] maven://org.apache.logging.log4j/log4j-api/2.6.1|lib/log4j/log4j-api-2.6.1.jar diff --git a/jetty-util/src/main/config/modules/log4j2-core.mod b/jetty-util/src/main/config/modules/log4j2-core.mod index 6f94fdb82a2..e5bbc41a137 100644 --- a/jetty-util/src/main/config/modules/log4j2-core.mod +++ b/jetty-util/src/main/config/modules/log4j2-core.mod @@ -1,5 +1,6 @@ [description] -Provides Apache Log4j 2 Core. +Provides a Log4j v2 implementation. +To receive jetty logs enable the jetty-slf4j, slf4j-log4j and log4j-log4j2 modules. [depends] log4j2-api diff --git a/jetty-util/src/main/config/modules/log4j2-slf4j.mod b/jetty-util/src/main/config/modules/log4j2-slf4j.mod index 1c5f55aa8a1..9e7490019ad 100644 --- a/jetty-util/src/main/config/modules/log4j2-slf4j.mod +++ b/jetty-util/src/main/config/modules/log4j2-slf4j.mod @@ -1,6 +1,7 @@ [description] -Provides Apache Log4j 2 implementation that routes -logs into slf4j +Provides a Log4j v2 implementation that logs to the SLF4J API. +Requires another module that provides and SLF4J implementation. +To receive jetty logs enable the jetty-slf4j module. [depends] log4j2-api diff --git a/jetty-util/src/main/config/modules/slf4j-api.mod b/jetty-util/src/main/config/modules/slf4j-api.mod index a4b06b7e2ca..0d8bb6b7372 100644 --- a/jetty-util/src/main/config/modules/slf4j-api.mod +++ b/jetty-util/src/main/config/modules/slf4j-api.mod @@ -2,9 +2,6 @@ Provides SLF4J API. Requires a slf4j implementation (eg slf4j-simple) otherwise a noop implementation is used. -[provides -logging - [files] maven://org.slf4j/slf4j-api/1.7.21|lib/slf4j/slf4j-api-1.7.21.jar diff --git a/jetty-util/src/main/config/modules/slf4j-jcl.mod b/jetty-util/src/main/config/modules/slf4j-jcl.mod index 538d601d8ae..35e82788630 100644 --- a/jetty-util/src/main/config/modules/slf4j-jcl.mod +++ b/jetty-util/src/main/config/modules/slf4j-jcl.mod @@ -1,5 +1,7 @@ [description] -Provides SLF4J bridge to apache java commons logging +Provides a SLF4J implementation that logs to the Java Commons Logging API. +Requires another module that provides an JCL implementation. +To receive jetty logs enable the jetty-slf4j module. [depend] slf4j-api diff --git a/jetty-util/src/main/config/modules/slf4j-log4j.mod b/jetty-util/src/main/config/modules/slf4j-log4j.mod index b37877789c3..887b0a88c4f 100644 --- a/jetty-util/src/main/config/modules/slf4j-log4j.mod +++ b/jetty-util/src/main/config/modules/slf4j-log4j.mod @@ -1,5 +1,7 @@ [description] -Provides SLF4J Log4j implementation. +Provides a SLF4J implementation that logs to the Log4j v1.2 API. +Requires another module that provides a Log4j implementation. +To receive jetty logs enable the jetty-slf4j module. [depend] slf4j-api diff --git a/jetty-util/src/main/config/modules/slf4j-simple.mod b/jetty-util/src/main/config/modules/slf4j-simple.mod index 0cc6a54d601..06f75723ec2 100644 --- a/jetty-util/src/main/config/modules/slf4j-simple.mod +++ b/jetty-util/src/main/config/modules/slf4j-simple.mod @@ -1,5 +1,6 @@ [description] -Provides SLF4J simple logging +Provides SLF4J simple logging implementation. +To receive jetty logs enable the jetty-slf4j module. [depend] slf4j-api