Logging refactoring (#4825)

* Logging refactoring
* LogConfig for any logging framework - moved to logging/common
* Moved from common to logging
* Simple integration with System.Logger for log4j and slf4j

Author: tomas-langer

CHANGELOG.md

@@ -11,12 +11,16 @@ For Helidon 2.x releases please see [Helidon 2.x CHANGELOG.md](https://github.co
 
 For Helidon 1.x releases please see [Helidon 1.x CHANGELOG.md](https://github.com/oracle/helidon/blob/helidon-1.x/CHANGELOG.md)
 
-## [4.0.0-ALPHA-1]
-
+## [4.0.0]
 We are pleased to announce Helidon 4.0.0 a major release that includes significant new features and fixes. As a major release it also includes some backward incompatible API changes.
 
+## [4.0.0-ALPHA-1]
+
 ### Notable Changes
 
+- `LogConfig` is moved from `helidon-common` to `helidon-logging-common` and uses a service loader to initialize logging implementation; this means that now you can simply add `helidon-logging-log4j` or `helidon-logging-slf4j` to you classpath and these frameworks will be used instead of the default `helidon-logging-jul`; also as we are moving to `System.Logger`, integration will work without additional configuration steps, and all Helidon logs should be seen in `log4j` or `slf4j` as long as the libraries are on classpath
+- `HelidonConsoleHandler` is now available only in `helidon-logging-jul` module
+- `sfl4j` upgraded to version 2.0.0 to support `System.Logger`
 - Java 19 early access (with Loom support) as the minimal Java version
 - Using System.Logger instead of java util logging (incremental change)
 - `HelidonServiceLoader` is now part of `helidon-common` module

archetypes/helidon/src/main/archetype/mp/common/files/src/main/resources/logging.properties

@@ -3,7 +3,7 @@
 # For more information see $JAVA_HOME/jre/lib/logging.properties
 
 # Send messages to the console
-handlers=io.helidon.common.HelidonConsoleHandler
+handlers=io.helidon.logging.jul.HelidonConsoleHandler
 
 # HelidonConsoleHandler uses a SimpleFormatter subclass that replaces "!thread!" with the current thread
 java.util.logging.SimpleFormatter.format=%1$tY.%1$tm.%1$td %1$tH:%1$tM:%1$tS %4$s %3$s !thread!: %5$s%6$s%n

archetypes/helidon/src/main/archetype/se/common/common-se.xml

@@ -51,7 +51,7 @@
                 </map>
             </list>
             <list key="Main-helidon-imports">
-                <value>io.helidon.common.LogConfig</value>
+                <value>io.helidon.logging.common.LogConfig</value>
                 <value>io.helidon.common.reactive.Single</value>
                 <value>io.helidon.config.Config</value>
                 <value>io.helidon.reactive.webserver.Routing</value>

archetypes/helidon/src/main/archetype/se/common/files/src/main/resources/logging.properties.mustache

@@ -2,7 +2,7 @@
 # For more information see $JAVA_HOME/jre/lib/logging.properties
 
 # Send messages to the console
-handlers=io.helidon.common.HelidonConsoleHandler
+handlers=io.helidon.logging.jul.HelidonConsoleHandler
 
 # HelidonConsoleHandler uses a SimpleFormatter subclass that replaces "!thread!" with the current thread
 java.util.logging.SimpleFormatter.format=%1$tY.%1$tm.%1$td %1$tH:%1$tM:%1$tS %4$s %3$s !thread!: %5$s%6$s%n

common/common/src/main/java/io/helidon/common/HelidonConsoleHandler.java

@@ -54,6 +54,10 @@
             <groupId>io.helidon.common</groupId>
             <artifactId>helidon-common-media-type</artifactId>
         </dependency>
+        <dependency>
+            <groupId>io.helidon.logging</groupId>
+            <artifactId>helidon-logging-jul</artifactId>
+        </dependency>
         <dependency>
             <groupId>io.helidon.config</groupId>
             <artifactId>helidon-config-metadata-processor</artifactId>

common/common/src/main/resources/META-INF/native-image/io.helidon/helidon-common/reflect-config.json

@@ -95,8 +95,8 @@
         <version.lib.jgit>5.11.1.202105131744-r</version.lib.jgit>
         <version.lib.junit>5.7.0</version.lib.junit>
         <version.lib.kafka>2.8.1</version.lib.kafka>
-        <version.lib.log4j>2.17.1</version.lib.log4j>
-        <version.lib.logback>1.2.10</version.lib.logback>
+        <version.lib.log4j>2.18.0</version.lib.log4j>
+        <version.lib.logback>1.4.0</version.lib.logback>
         <version.lib.mariadb-java-client>2.6.2</version.lib.mariadb-java-client>
         <version.lib.maven-wagon>2.10</version.lib.maven-wagon>
         <version.lib.micrometer>1.6.6</version.lib.micrometer>
@@ -139,7 +139,7 @@
         <version.lib.parsson>1.0.2</version.lib.parsson>
         <version.lib.postgresql>42.4.1</version.lib.postgresql>
         <version.lib.prometheus>0.9.0</version.lib.prometheus>
-        <version.lib.slf4j>1.7.32</version.lib.slf4j>
+        <version.lib.slf4j>2.0.0</version.lib.slf4j>
         <version.lib.smallrye-openapi>2.1.16</version.lib.smallrye-openapi>
         <version.lib.snakeyaml>1.30</version.lib.snakeyaml>
         <version.lib.typesafe-config>1.4.2</version.lib.typesafe-config>
@@ -776,6 +776,11 @@
                 <artifactId>slf4j-api</artifactId>
                 <version>${version.lib.slf4j}</version>
             </dependency>
+            <dependency>
+                <groupId>org.slf4j</groupId>
+                <artifactId>slf4j-jdk-platform-logging</artifactId>
+                <version>${version.lib.slf4j}</version>
+            </dependency>
             <dependency>
                 <groupId>org.slf4j</groupId>
                 <artifactId>slf4j-jdk14</artifactId>
@@ -786,6 +791,11 @@
                 <artifactId>log4j-api</artifactId>
                 <version>${version.lib.log4j}</version>
             </dependency>
+            <dependency>
+                <groupId>org.apache.logging.log4j</groupId>
+                <artifactId>log4j-jpl</artifactId>
+                <version>${version.lib.log4j}</version>
+            </dependency>
             <dependency>
                 <groupId>io.smallrye</groupId>
                 <artifactId>smallrye-open-api-core</artifactId>

config/config/pom.xml

@@ -636,7 +636,7 @@ Create a `logging.properties` file in `src/main/resources` with
 .Example logging.properties file
 ----
 # Send messages to the console
-handlers=io.helidon.common.HelidonConsoleHandler # <1>
+handlers=io.helidon.logging.jul.HelidonConsoleHandler # <1>
 
 # HelidonConsoleHandler uses a SimpleFormatter subclass that replaces "!thread!" with the current thread
 java.util.logging.SimpleFormatter.format=%1$tY.%1$tm.%1$td %1$tH:%1$tM:%1$tS %4$s %3$s !thread!: %5$s%6$s%n # <2>

dependencies/pom.xml

@@ -19,10 +19,10 @@
 import java.io.IOException;
 import java.util.logging.Logger;
 
-import io.helidon.common.LogConfig;
 import io.helidon.common.reactive.Single;
 import io.helidon.config.Config;
 import io.helidon.health.checks.HealthChecks;
+import io.helidon.logging.common.LogConfig;
 import io.helidon.metrics.serviceapi.MetricsSupport;
 import io.helidon.reactive.health.HealthSupport;
 import io.helidon.reactive.media.jsonp.JsonpSupport;

docs/mp/guides/mp-tutorial.adoc

@@ -16,8 +16,8 @@
 
 package io.helidon.examples.dbclient.jdbc;
 
-import io.helidon.common.LogConfig;
 import io.helidon.config.Config;
+import io.helidon.logging.common.LogConfig;
 import io.helidon.metrics.serviceapi.MetricsSupport;
 import io.helidon.reactive.dbclient.DbClient;
 import io.helidon.reactive.dbclient.health.DbClientHealthCheck;

examples/cors/src/main/java/io/helidon/examples/cors/Main.java

@@ -28,4 +28,6 @@
     requires io.helidon.metrics.serviceapi;
     requires io.helidon.tracing;
     requires io.helidon.examples.dbclient.common;
+    requires io.helidon.logging.common;
+    requires io.helidon.logging.jul;
 }

examples/dbclient/jdbc/src/main/java/io/helidon/examples/dbclient/jdbc/JdbcExampleMain.java

@@ -16,8 +16,8 @@
 
 package io.helidon.examples.dbclient.mongo;
 
-import io.helidon.common.LogConfig;
 import io.helidon.config.Config;
+import io.helidon.logging.common.LogConfig;
 import io.helidon.metrics.serviceapi.MetricsSupport;
 import io.helidon.reactive.dbclient.DbClient;
 import io.helidon.reactive.dbclient.DbStatementType;

examples/dbclient/jdbc/src/main/java/module-info.java

@@ -31,4 +31,6 @@
     requires io.helidon.examples.dbclient.common;
     requires io.helidon.reactive.dbclient.metrics;
     requires io.helidon.reactive.dbclient.tracing;
+    requires io.helidon.logging.common;
+    requires io.helidon.logging.jul;
 }

examples/dbclient/mongodb/src/main/java/io/helidon/examples/dbclient/mongo/MongoDbExampleMain.java

@@ -16,9 +16,9 @@
 
 package io.helidon.examples.dbclient.pokemons;
 
-import io.helidon.common.LogConfig;
 import io.helidon.config.Config;
 import io.helidon.config.ConfigSources;
+import io.helidon.logging.common.LogConfig;
 import io.helidon.metrics.serviceapi.MetricsSupport;
 import io.helidon.reactive.dbclient.DbClient;
 import io.helidon.reactive.dbclient.health.DbClientHealthCheck;

examples/dbclient/mongodb/src/main/java/module-info.java

@@ -32,6 +32,8 @@
     requires io.helidon.tracing;
     requires io.helidon.reactive.dbclient;
     requires io.helidon.reactive.webserver;
+    requires io.helidon.logging.common;
+    requires io.helidon.logging.jul;
 
     provides DbMapperProvider with io.helidon.examples.dbclient.pokemons.PokemonMapperProvider;
 

examples/dbclient/pokemons/src/main/java/io/helidon/examples/dbclient/pokemons/PokemonMain.java

@@ -16,10 +16,10 @@
 
 package io.helidon.service.employee;
 
-import io.helidon.common.LogConfig;
 import io.helidon.common.reactive.Single;
 import io.helidon.config.Config;
 import io.helidon.health.checks.HealthChecks;
+import io.helidon.logging.common.LogConfig;
 import io.helidon.metrics.serviceapi.MetricsSupport;
 import io.helidon.reactive.health.HealthSupport;
 import io.helidon.reactive.media.jsonb.JsonbSupport;

examples/dbclient/pokemons/src/main/java/module-info.java

@@ -16,7 +16,6 @@
 
 package io.helidon.grpc.examples.basics;
 
-import io.helidon.common.LogConfig;
 import io.helidon.config.Config;
 import io.helidon.grpc.examples.common.GreetService;
 import io.helidon.grpc.examples.common.GreetServiceJava;
@@ -25,6 +24,7 @@
 import io.helidon.grpc.server.GrpcServer;
 import io.helidon.grpc.server.GrpcServerConfiguration;
 import io.helidon.health.checks.HealthChecks;
+import io.helidon.logging.common.LogConfig;
 import io.helidon.reactive.health.HealthSupport;
 import io.helidon.reactive.webserver.Routing;
 import io.helidon.reactive.webserver.WebServer;

examples/employee-app/src/main/java/io/helidon/service/employee/Main.java

@@ -16,14 +16,14 @@
 
 package io.helidon.grpc.examples.metrics;
 
-import io.helidon.common.LogConfig;
 import io.helidon.config.Config;
 import io.helidon.grpc.examples.common.GreetService;
 import io.helidon.grpc.examples.common.StringService;
 import io.helidon.grpc.metrics.GrpcMetrics;
 import io.helidon.grpc.server.GrpcRouting;
 import io.helidon.grpc.server.GrpcServer;
 import io.helidon.grpc.server.GrpcServerConfiguration;
+import io.helidon.logging.common.LogConfig;
 import io.helidon.metrics.serviceapi.MetricsSupport;
 import io.helidon.reactive.webserver.Routing;
 import io.helidon.reactive.webserver.WebServer;

examples/grpc/basics/src/main/java/io/helidon/grpc/examples/basics/Server.java

@@ -16,7 +16,6 @@
 
 package io.helidon.grpc.examples.opentracing;
 
-import io.helidon.common.LogConfig;
 import io.helidon.config.Config;
 import io.helidon.grpc.examples.common.GreetService;
 import io.helidon.grpc.examples.common.StringService;
@@ -25,6 +24,7 @@
 import io.helidon.grpc.server.GrpcServerConfiguration;
 import io.helidon.grpc.server.GrpcTracingConfig;
 import io.helidon.grpc.server.ServerRequestAttribute;
+import io.helidon.logging.common.LogConfig;
 import io.helidon.tracing.Tracer;
 import io.helidon.tracing.TracerBuilder;
 

examples/grpc/metrics/src/main/java/io/helidon/grpc/examples/metrics/Server.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019, 2020 Oracle and/or its affiliates.
+ * Copyright (c) 2019, 2022 Oracle and/or its affiliates.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -19,12 +19,12 @@
 import java.time.DayOfWeek;
 import java.time.LocalTime;
 
-import io.helidon.common.LogConfig;
 import io.helidon.grpc.examples.common.StringService;
 import io.helidon.grpc.server.GrpcRouting;
 import io.helidon.grpc.server.GrpcServer;
 import io.helidon.grpc.server.GrpcServerConfiguration;
 import io.helidon.grpc.server.ServiceDescriptor;
+import io.helidon.logging.common.LogConfig;
 import io.helidon.security.Security;
 import io.helidon.security.SubjectType;
 import io.helidon.security.abac.policy.PolicyValidator;

examples/grpc/opentracing/src/main/java/io/helidon/grpc/examples/opentracing/ZipkinExampleMain.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019, 2020 Oracle and/or its affiliates.
+ * Copyright (c) 2019, 2022 Oracle and/or its affiliates.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,12 +16,12 @@
 
 package io.helidon.grpc.examples.security.abac;
 
-import io.helidon.common.LogConfig;
 import io.helidon.config.Config;
 import io.helidon.grpc.examples.common.StringService;
 import io.helidon.grpc.server.GrpcRouting;
 import io.helidon.grpc.server.GrpcServer;
 import io.helidon.grpc.server.GrpcServerConfiguration;
+import io.helidon.logging.common.LogConfig;
 import io.helidon.security.Security;
 import io.helidon.security.integration.grpc.GrpcSecurity;
 

examples/grpc/security-abac/src/main/java/io/helidon/grpc/examples/security/abac/AbacServer.java

@@ -18,7 +18,6 @@
 
 import java.util.Optional;
 
-import io.helidon.common.LogConfig;
 import io.helidon.common.context.Context;
 import io.helidon.common.http.Http;
 import io.helidon.config.Config;
@@ -32,6 +31,7 @@
 import io.helidon.grpc.server.GrpcServerConfiguration;
 import io.helidon.grpc.server.GrpcService;
 import io.helidon.grpc.server.ServiceDescriptor;
+import io.helidon.logging.common.LogConfig;
 import io.helidon.reactive.webclient.WebClient;
 import io.helidon.reactive.webclient.WebClientResponse;
 import io.helidon.reactive.webclient.security.WebClientSecurity;