From 34ac0450739a08589352e63987066dfde35ed357 Mon Sep 17 00:00:00 2001 From: Yanming Zhou Date: Thu, 28 Nov 2024 17:45:32 +0800 Subject: [PATCH 1/2] Document StructuredLoggingJsonMembersCustomizer constructor params See gh-43314 --- .../StructuredLoggingJsonMembersCustomizer.java | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/logging/structured/StructuredLoggingJsonMembersCustomizer.java b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/logging/structured/StructuredLoggingJsonMembersCustomizer.java index 67040b39149..48589cb4e9a 100644 --- a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/logging/structured/StructuredLoggingJsonMembersCustomizer.java +++ b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/logging/structured/StructuredLoggingJsonMembersCustomizer.java @@ -25,6 +25,15 @@ import org.springframework.boot.json.JsonWriter.Members; *

* An implementation may be provided using the {@code logging.structured.json.customizer} * property. + *

+ * {@code StructuredLoggingJsonMembersCustomizer} implementations may optionally take the + * following constructor parameters: + *

* * @param the type being written * @author Phillip Webb From 15109b2eb2755ea5cded7dd3cc4d8d1a0a7cc7f4 Mon Sep 17 00:00:00 2001 From: Andy Wilkinson Date: Thu, 28 Nov 2024 13:38:32 +0000 Subject: [PATCH 2/2] Polish "Document StructuredLoggingJsonMembersCustomizer constructor params" See gh-43314 --- ...StructuredLoggingJsonMembersCustomizer.java | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/logging/structured/StructuredLoggingJsonMembersCustomizer.java b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/logging/structured/StructuredLoggingJsonMembersCustomizer.java index 48589cb4e9a..087b2b180e2 100644 --- a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/logging/structured/StructuredLoggingJsonMembersCustomizer.java +++ b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/logging/structured/StructuredLoggingJsonMembersCustomizer.java @@ -16,23 +16,27 @@ package org.springframework.boot.logging.structured; +import ch.qos.logback.classic.pattern.ThrowableProxyConverter; + import org.springframework.boot.json.JsonWriter; import org.springframework.boot.json.JsonWriter.Members; +import org.springframework.core.env.Environment; /** - * Customer that can be injected into a {@link StructuredLogFormatter} implementations to + * Customizer that can be injected into {@link StructuredLogFormatter} implementations to * customize {@link JsonWriter} {@link Members}. *

* An implementation may be provided using the {@code logging.structured.json.customizer} * property. *

- * {@code StructuredLoggingJsonMembersCustomizer} implementations may optionally take the - * following constructor parameters: + * Implementing classes can declare the following parameter types in the constructor: *

    - *
  • {@link org.springframework.core.env.Environment} - The Spring - * {@code Environment}.
  • - *
  • {@link ch.qos.logback.classic.pattern.ThrowableProxyConverter} - The Logback - * {@code ThrowableProxyConverter} (available only if Logback is using).
  • + *
  • {@link Environment}
  • + *
+ * When using Logback, implementing classes can also use the following parameter types in + * the constructor: + *
    + *
  • {@link ThrowableProxyConverter}
  • *
* * @param the type being written