Merge pull request #345 from calvernaz/main

Migrate to ConfigMapping configs

Author: gsmet

README.md

@@ -14,7 +14,7 @@ Quarkus logging extension outputting the logging in json.
 
 # Configuration
 The extension is enabled by default for console, when added to the project.
-Console logging can be disabled using configuration: `quarkus.log.json.console.enable=false`
+Console logging can be disabled using configuration: `quarkus.log.json.console.enabled=false`
 
 To see additional configuration options take a look at [Config](https://quarkiverse.github.io/quarkiverse-docs/quarkus-logging-json/dev/index.html)
 
@@ -63,6 +63,17 @@ public class MyJsonProvider implements JsonProvider {
 }
 ```
 
+## Configuration Properties Relocation
+
+In 3.2.0, two configuration properties were renamed to be more consistent with Quarkus configuration.
+
+- Old: `quarkus.log.json.console.enable` → New: `quarkus.log.json.console.enabled`
+- Old: `quarkus.log.json.file.enable` → New: `quarkus.log.json.file.enabled`
+
+A relocation/fallback mechanism has been added so the old properties are still supported
+but we recomment that you switch to the new ones
+(`quarkus update` will do it for you).
+
 ## Contributors ✨
 
 Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
@@ -81,3 +92,5 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 
 This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+
+`

deployment/src/test/java/io/quarkiverse/loggingjson/deployment/JsonDeprecatedConfigTest.java

@@ -0,0 +1,63 @@
+package io.quarkiverse.loggingjson.deployment;
+
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.logging.Handler;
+import java.util.logging.Level;
+import java.util.logging.LogManager;
+import java.util.logging.Logger;
+
+import org.jboss.logmanager.handlers.ConsoleHandler;
+import org.jboss.logmanager.handlers.FileHandler;
+import org.jboss.shrinkwrap.api.ShrinkWrap;
+import org.jboss.shrinkwrap.api.spec.JavaArchive;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+import io.quarkiverse.loggingjson.JsonFormatter;
+import io.quarkus.bootstrap.logging.InitialConfigurator;
+import io.quarkus.bootstrap.logging.QuarkusDelayedHandler;
+import io.quarkus.bootstrap.model.AppArtifact;
+import io.quarkus.test.QuarkusUnitTest;
+
+/**
+ * In this test, we check that the feature is disabled as it is the only way to check the relocation/fallback works.
+ */
+class JsonDeprecatedConfigTest {
+
+    @RegisterExtension
+    static final QuarkusUnitTest config = new QuarkusUnitTest()
+            .setArchiveProducer(() -> ShrinkWrap.create(JavaArchive.class))
+            .setForcedDependencies(Collections.singletonList(
+                    new AppArtifact("io.quarkus", "quarkus-jackson", System.getProperty("test.quarkus.version"))))
+            .withConfigurationResource("application-json-deprecated-config.properties");
+
+    static {
+        System.setProperty("java.util.logging.manager", org.jboss.logmanager.LogManager.class.getName());
+    }
+
+    @Test
+    void testJsonLoggingDisabled() throws Exception {
+        LogManager logManager = LogManager.getLogManager();
+        Assertions.assertTrue(logManager instanceof org.jboss.logmanager.LogManager);
+
+        QuarkusDelayedHandler delayedHandler = InitialConfigurator.DELAYED_HANDLER;
+        Assertions.assertTrue(Arrays.asList(Logger.getLogger("").getHandlers()).contains(delayedHandler));
+        Assertions.assertEquals(Level.ALL, delayedHandler.getLevel());
+
+        Handler consoleHandler = Arrays.stream(delayedHandler.getHandlers())
+                .filter(h -> (h instanceof ConsoleHandler))
+                .findFirst().orElse(null);
+        Assertions.assertNotNull(consoleHandler);
+
+        Assertions.assertFalse(consoleHandler.getFormatter() instanceof JsonFormatter);
+
+        Handler fileHandler = Arrays.stream(delayedHandler.getHandlers())
+                .filter(h -> (h instanceof FileHandler))
+                .findFirst().orElse(null);
+        Assertions.assertNotNull(fileHandler);
+
+        Assertions.assertFalse(fileHandler.getFormatter() instanceof JsonFormatter);
+    }
+}

deployment/src/test/resources/application-json-deprecated-config.properties

@@ -0,0 +1,8 @@
+quarkus.log.level=INFO
+quarkus.log.console.enable=true
+quarkus.log.console.level=WARNING
+quarkus.log.json.console.enable=false
+quarkus.log.json.fields.arguments.include-non-structured-arguments=true
+quarkus.log.json.additional-field.serviceName.value=deployment-test
+quarkus.log.file.enable=true
+quarkus.log.json.file.enable=false

deployment/src/test/resources/application-json-ecs.properties

@@ -1,7 +1,7 @@
 quarkus.log.level=INFO
 quarkus.log.console.enable=true
 quarkus.log.console.level=WARNING
-quarkus.log.json.console.enable=true
+quarkus.log.json.console.enabled=true
 quarkus.log.json.log-format=ecs
 quarkus.log.json.fields.arguments.include-non-structured-arguments=true
 quarkus.log.json.additional-field."service.name".value=deployment-test

deployment/src/test/resources/application-json.properties

@@ -1,7 +1,7 @@
 quarkus.log.level=INFO
 quarkus.log.console.enable=true
 quarkus.log.console.level=WARNING
-quarkus.log.json.console.enable=true
+quarkus.log.json.console.enabled=true
 quarkus.log.json.fields.arguments.include-non-structured-arguments=true
 quarkus.log.json.additional-field.serviceName.value=deployment-test
-quarkus.log.json.file.enable=true
+quarkus.log.json.file.enabled=true

docs/modules/ROOT/pages/includes/quarkus-log-json.adoc

@@ -10,30 +10,30 @@ h|[[quarkus-log-json_configuration]]link:#quarkus-log-json_configuration[Configu
 h|Type
 h|Default
 
-a| [[quarkus-log-json_quarkus.log.json.console.enable]]`link:#quarkus-log-json_quarkus.log.json.console.enable[quarkus.log.json.console.enable]`
+a| [[quarkus-log-json_quarkus.log.json.console.enabled]]`link:#quarkus-log-json_quarkus.log.json.console.enabled[quarkus.log.json.console.enabled]`
 
 [.description]
 --
 Determine whether to enable the JSON console formatting extension, which disables "normal" console formatting.
 
 ifdef::add-copy-button-to-env-var[]
-Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_JSON_CONSOLE_ENABLE+++[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_JSON_CONSOLE_ENABLED+++[]
 endif::add-copy-button-to-env-var[]
 ifndef::add-copy-button-to-env-var[]
-Environment variable: `+++QUARKUS_LOG_JSON_CONSOLE_ENABLE+++`
+Environment variable: `+++QUARKUS_LOG_JSON_CONSOLE_ENABLED+++`
 endif::add-copy-button-to-env-var[]
 --|boolean 
 |`true`
 
 
-a| [[quarkus-log-json_quarkus.log.json.file.enable]]`link:#quarkus-log-json_quarkus.log.json.file.enable[quarkus.log.json.file.enable]`
+a| [[quarkus-log-json_quarkus.log.json.file.enabled]]`link:#quarkus-log-json_quarkus.log.json.file.enabled[quarkus.log.json.file.enabled]`
 
 [.description]
 --
 Determine whether to enable the JSON file formatting extension, which disables "normal" file formatting.
 
 ifdef::add-copy-button-to-env-var[]
-Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_JSON_FILE_ENABLE+++[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_JSON_FILE_ENABLED+++[]
 endif::add-copy-button-to-env-var[]
 ifndef::add-copy-button-to-env-var[]
 Environment variable: `+++QUARKUS_LOG_JSON_FILE_ENABLE+++`

runtime/pom.xml

@@ -73,9 +73,6 @@
                             <version>${quarkus.version}</version>
                         </path>
                     </annotationProcessorPaths>
-                    <compilerArgs>
-                        <arg>-AlegacyConfigRoot=true</arg>
-                    </compilerArgs>
                 </configuration>
             </plugin>
         </plugins>

runtime/src/main/java/io/quarkiverse/loggingjson/JsonFormatter.java

@@ -15,7 +15,7 @@ public class JsonFormatter extends ExtFormatter {
     public JsonFormatter(List<JsonProvider> providers, JsonFactory jsonFactory, Config config) {
         this.providers = providers;
         this.jsonFactory = jsonFactory;
-        this.recordDelimiter = config.recordDelimiter;
+        this.recordDelimiter = config.recordDelimiter();
     }
 
     @Override

runtime/src/main/java/io/quarkiverse/loggingjson/LoggingJsonRecorder.java

@@ -23,12 +23,12 @@ public class LoggingJsonRecorder {
 
     public RuntimeValue<Optional<Formatter>> initializeConsoleJsonLogging(Config config,
             JsonFactory jsonFactory) {
-        return initializeJsonLogging(config.console, config, jsonFactory);
+        return initializeJsonLogging(config.console(), config, jsonFactory);
     }
 
     public RuntimeValue<Optional<Formatter>> initializeFileJsonLogging(Config config,
             JsonFactory jsonFactory) {
-        return initializeJsonLogging(config.file, config, jsonFactory);
+        return initializeJsonLogging(config.file(), config, jsonFactory);
     }
 
     public RuntimeValue<Optional<Formatter>> initializeJsonLogging(ConfigFormatter formatter, Config config,
@@ -39,7 +39,7 @@ public RuntimeValue<Optional<Formatter>> initializeJsonLogging(ConfigFormatter f
 
         List<JsonProvider> providers;
 
-        if (config.logFormat == Config.LogFormat.ECS) {
+        if (config.logFormat() == Config.LogFormat.ECS) {
             providers = ecsFormat(config);
         } else {
             providers = defaultFormat(config);
@@ -68,42 +68,42 @@ public RuntimeValue<Optional<Formatter>> initializeJsonLogging(ConfigFormatter f
 
     private List<JsonProvider> defaultFormat(Config config) {
         List<JsonProvider> providers = new ArrayList<>();
-        providers.add(new TimestampJsonProvider(config.fields.timestamp));
-        providers.add(new SequenceJsonProvider(config.fields.sequence));
-        providers.add(new LoggerClassNameJsonProvider(config.fields.loggerClassName));
-        providers.add(new LoggerNameJsonProvider(config.fields.loggerName));
-        providers.add(new LogLevelJsonProvider(config.fields.level));
-        providers.add(new MessageJsonProvider(config.fields.message));
-        providers.add(new ThreadNameJsonProvider(config.fields.threadName));
-        providers.add(new ThreadIdJsonProvider(config.fields.threadId));
-        providers.add(new MDCJsonProvider(config.fields.mdc));
-        providers.add(new NDCJsonProvider(config.fields.ndc));
-        providers.add(new HostNameJsonProvider(config.fields.hostname));
-        providers.add(new ProcessNameJsonProvider(config.fields.processName));
-        providers.add(new ProcessIdJsonProvider(config.fields.processId));
-        providers.add(new StackTraceJsonProvider(config.fields.stackTrace));
-        providers.add(new ErrorTypeJsonProvider(config.fields.errorType));
-        providers.add(new ErrorMessageJsonProvider(config.fields.errorMessage));
-        providers.add(new ArgumentsJsonProvider(config.fields.arguments));
-        providers.add(new AdditionalFieldsJsonProvider(config.additionalField));
+        providers.add(new TimestampJsonProvider(config.fields().timestamp()));
+        providers.add(new SequenceJsonProvider(config.fields().sequence()));
+        providers.add(new LoggerClassNameJsonProvider(config.fields().loggerClassName()));
+        providers.add(new LoggerNameJsonProvider(config.fields().loggerName()));
+        providers.add(new LogLevelJsonProvider(config.fields().level()));
+        providers.add(new MessageJsonProvider(config.fields().message()));
+        providers.add(new ThreadNameJsonProvider(config.fields().threadName()));
+        providers.add(new ThreadIdJsonProvider(config.fields().threadId()));
+        providers.add(new MDCJsonProvider(config.fields().mdc()));
+        providers.add(new NDCJsonProvider(config.fields().ndc()));
+        providers.add(new HostNameJsonProvider(config.fields().hostname()));
+        providers.add(new ProcessNameJsonProvider(config.fields().processName()));
+        providers.add(new ProcessIdJsonProvider(config.fields().processId()));
+        providers.add(new StackTraceJsonProvider(config.fields().stackTrace()));
+        providers.add(new ErrorTypeJsonProvider(config.fields().errorType()));
+        providers.add(new ErrorMessageJsonProvider(config.fields().errorMessage()));
+        providers.add(new ArgumentsJsonProvider(config.fields().arguments()));
+        providers.add(new AdditionalFieldsJsonProvider(config.additionalField()));
         return providers;
     }
 
     private List<JsonProvider> ecsFormat(Config config) {
         List<JsonProvider> providers = new ArrayList<>();
-        providers.add(new TimestampJsonProvider(config.fields.timestamp, "@timestamp"));
-        providers.add(new LoggerNameJsonProvider(config.fields.loggerName, "log.logger"));
-        providers.add(new LogLevelJsonProvider(config.fields.level, "log.level"));
-        providers.add(new ThreadNameJsonProvider(config.fields.threadName, "process.thread.name"));
-        providers.add(new ThreadIdJsonProvider(config.fields.threadId, "process.thread.id"));
-        providers.add(new MDCJsonProvider(config.fields.mdc));
-        providers.add(new HostNameJsonProvider(config.fields.hostname, "host.name"));
-        providers.add(new StackTraceJsonProvider(config.fields.stackTrace, "error.stack_trace"));
-        providers.add(new ErrorTypeJsonProvider(config.fields.errorType, "error.type"));
-        providers.add(new ErrorMessageJsonProvider(config.fields.errorMessage, "error.message"));
-        providers.add(new ArgumentsJsonProvider(config.fields.arguments));
-        providers.add(new AdditionalFieldsJsonProvider(config.additionalField));
-        providers.add(new MessageJsonProvider(config.fields.message));
+        providers.add(new TimestampJsonProvider(config.fields().timestamp(), "@timestamp"));
+        providers.add(new LoggerNameJsonProvider(config.fields().loggerName(), "log.logger"));
+        providers.add(new LogLevelJsonProvider(config.fields().level(), "log.level"));
+        providers.add(new ThreadNameJsonProvider(config.fields().threadName(), "process.thread.name"));
+        providers.add(new ThreadIdJsonProvider(config.fields().threadId(), "process.thread.id"));
+        providers.add(new MDCJsonProvider(config.fields().mdc()));
+        providers.add(new HostNameJsonProvider(config.fields().hostname(), "host.name"));
+        providers.add(new StackTraceJsonProvider(config.fields().stackTrace(), "error.stack_trace"));
+        providers.add(new ErrorTypeJsonProvider(config.fields().errorType(), "error.type"));
+        providers.add(new ErrorMessageJsonProvider(config.fields().errorMessage(), "error.message"));
+        providers.add(new ArgumentsJsonProvider(config.fields().arguments()));
+        providers.add(new AdditionalFieldsJsonProvider(config.additionalField()));
+        providers.add(new MessageJsonProvider(config.fields().message()));
         providers.add(new StaticKeyValueProvider("ecs.version", "1.12.1"));
         return providers;
     }