Merge pull request #45520 from lasteris/QKS-45519

Rest client per CDI injected client logging configuration
quarkusio · Jan 14, 2025 · c0b9484 · c0b9484
2 parents 5708571 + f12169b
commit c0b9484
Show file tree

Hide file tree

Showing 5 changed files with 65 additions and 10 deletions.
diff --git a/docs/src/main/asciidoc/rest-client.adoc b/docs/src/main/asciidoc/rest-client.adoc
@@ -1845,14 +1845,20 @@ As HTTP messages can have large bodies, we limit the amount of body characters l
 
 NOTE: REST Client is logging the traffic with level DEBUG and does not alter logger properties. You may need to adjust your logger configuration to use this feature.
 
+These configuration properties work globally for all clients injected by CDI.
+If you want configure logging for a specific declarative client, you should do it by specifying named "client" properties, also known as `quarkus.rest-client."client".logging.*` properties.
+
 An example logging configuration:
 
 [source,properties]
 ----
 quarkus.rest-client.logging.scope=request-response
 quarkus.rest-client.logging.body-limit=50
 
+quarkus.rest-client.extensions-api.scope=all
+
 quarkus.log.category."org.jboss.resteasy.reactive.client.logging".level=DEBUG
+quarkus.log.console.level=DEBUG
 ----
 
 [TIP]

diff --git a/...t-client-config/runtime/src/main/java/io/quarkus/restclient/config/RestClientsConfig.java b/...t-client-config/runtime/src/main/java/io/quarkus/restclient/config/RestClientsConfig.java
@@ -621,6 +621,11 @@ default Optional<String> uriReload() {
          */
         @WithDefault("${microprofile.rest.client.disable.default.mapper:false}")
         Boolean disableDefaultMapper();
+
+        /**
+         * Logging configuration.
+         */
+        Optional<RestClientLoggingConfig> logging();
     }
 
     class RestClientKeysProvider implements Supplier<Iterable<String>> {

diff --git a/.../runtime/src/main/java/io/quarkus/rest/client/reactive/runtime/RestClientBuilderImpl.java b/.../runtime/src/main/java/io/quarkus/rest/client/reactive/runtime/RestClientBuilderImpl.java
@@ -440,17 +440,25 @@ public <T> T build(Class<T> aClass) throws IllegalStateException, RestClientDefi
         clientBuilder.register(new MicroProfileRestClientResponseFilter(exceptionMappers));
         clientBuilder.followRedirects(followRedirects != null ? followRedirects : restClients.followRedirects().orElse(false));
 
-        RestClientsConfig.RestClientLoggingConfig logging = restClients.logging();
-
-        LoggingScope effectiveLoggingScope = loggingScope; // if a scope was specified programmatically, it takes precedence
-        if (effectiveLoggingScope == null) {
-            effectiveLoggingScope = logging != null ? logging.scope().map(LoggingScope::forName).orElse(LoggingScope.NONE)
-                    : LoggingScope.NONE;
+        RestClientsConfig.RestClientLoggingConfig configRootLogging = restClients.logging();
+
+        Integer defaultLoggingBodyLimit = 100;
+        LoggingScope effectiveLoggingScope = LoggingScope.NONE;
+        Integer effectiveLoggingBodyLimit = defaultLoggingBodyLimit;
+        if (getConfiguration().hasProperty(QuarkusRestClientProperties.LOGGING_SCOPE)) {
+            effectiveLoggingScope = (LoggingScope) getConfiguration().getProperty(QuarkusRestClientProperties.LOGGING_SCOPE);
+        } else if (loggingScope != null) { //scope, specified programmatically, takes precedence over global configuration
+            effectiveLoggingScope = loggingScope;
+        } else if (configRootLogging != null) {
+            effectiveLoggingScope = configRootLogging.scope().map(LoggingScope::forName).orElse(LoggingScope.NONE);
         }
-
-        Integer effectiveLoggingBodyLimit = loggingBodyLimit; // if a limit was specified programmatically, it takes precedence
-        if (effectiveLoggingBodyLimit == null) {
-            effectiveLoggingBodyLimit = logging != null ? logging.bodyLimit() : 100;
+        if (getConfiguration().hasProperty(QuarkusRestClientProperties.LOGGING_BODY_LIMIT)) {
+            effectiveLoggingBodyLimit = (Integer) getConfiguration()
+                    .getProperty(QuarkusRestClientProperties.LOGGING_BODY_LIMIT);
+        } else if (loggingBodyLimit != null) { //bodyLimit, specified programmatically, takes precedence over global configuration
+            effectiveLoggingBodyLimit = loggingBodyLimit;
+        } else if (configRootLogging != null) {
+            effectiveLoggingBodyLimit = configRootLogging.bodyLimit();
         }
         clientBuilder.loggingScope(effectiveLoggingScope);
         clientBuilder.loggingBodySize(effectiveLoggingBodyLimit);

diff --git a/...e/src/main/java/io/quarkus/rest/client/reactive/runtime/RestClientCDIDelegateBuilder.java b/...e/src/main/java/io/quarkus/rest/client/reactive/runtime/RestClientCDIDelegateBuilder.java
@@ -24,6 +24,7 @@
 
 import org.eclipse.microprofile.config.ConfigProvider;
 import org.eclipse.microprofile.rest.client.ext.QueryParamStyle;
+import org.jboss.resteasy.reactive.client.api.LoggingScope;
 import org.jboss.resteasy.reactive.client.api.QuarkusRestClientProperties;
 import org.jboss.resteasy.reactive.client.impl.multipart.PausableHttpPostRequestEncoder;
 
@@ -81,9 +82,19 @@ void configureBuilder(QuarkusRestClientBuilder builder) {
         configureQueryParamStyle(builder);
         configureProxy(builder);
         configureShared(builder);
+        configureLogging(builder);
         configureCustomProperties(builder);
     }
 
+    private void configureLogging(QuarkusRestClientBuilder builder) {
+        if (restClientConfig.logging().isPresent()) {
+            RestClientsConfig.RestClientLoggingConfig loggingConfig = restClientConfig.logging().get();
+            builder.property(QuarkusRestClientProperties.LOGGING_SCOPE,
+                    loggingConfig.scope().isPresent() ? LoggingScope.forName(loggingConfig.scope().get()) : LoggingScope.NONE);
+            builder.property(QuarkusRestClientProperties.LOGGING_BODY_LIMIT, loggingConfig.bodyLimit());
+        }
+    }
+
     private void configureCustomProperties(QuarkusRestClientBuilder builder) {
         Optional<String> encoder = oneOf(restClientConfig.multipartPostEncoderMode(), configRoot.multipartPostEncoderMode());
         if (encoder != null && encoder.isPresent()) {

diff --git a/...ime/src/main/java/org/jboss/resteasy/reactive/client/api/QuarkusRestClientProperties.java b/...ime/src/main/java/org/jboss/resteasy/reactive/client/api/QuarkusRestClientProperties.java
@@ -85,4 +85,29 @@ public class QuarkusRestClientProperties {
      */
     public static final String CAPTURE_STACKTRACE = "io.quarkus.rest.client.capture-stacktrace";
 
+    /**
+     * Scope of logging for the client.
+     * <br/>
+     * WARNING: beware of logging sensitive data
+     * <br/>
+     * The possible values are:
+     * <ul>
+     * <li>{@code request-response} - enables logging request and responses, including redirect responses</li>
+     * <li>{@code all} - enables logging requests and responses and lower-level logging</li>
+     * <li>{@code none} - no additional logging</li>
+     * </ul>
+     *
+     * This property is applicable to reactive REST clients only.
+     */
+    public static final String LOGGING_SCOPE = "io.quarkus.rest.client.logging.scope";
+
+    /**
+     * How many characters of the body should be logged. Message body can be large and can easily pollute the logs.
+     * <p>
+     * By default, set to 100.
+     * <p>
+     * This property is applicable to reactive REST clients only.
+     */
+    public static final String LOGGING_BODY_LIMIT = "io.quarkus.rest.client.logging.body-limit";
+
 }