root
/
spring-boot
mirror of https://github.com/spring-projects/spring-boot.git
1
0
Fork 0
Code Issues Actions 4 Packages Projects Releases Wiki Activity

Merge pull request #43314 from quaff 

* gh-43314:
  Polish "Document StructuredLoggingJsonMembersCustomizer constructor params"
  Document StructuredLoggingJsonMembersCustomizer constructor params

Closes gh-43314
This commit is contained in:
Andy Wilkinson 2024-11-28 13:39:50 +00:00
parent d3c5a4bf8d 15109b2eb2
commit b5feadab13
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/logging/structured/StructuredLoggingJsonMembersCustomizer.java
View File

@ -16,15 +16,28 @@
package org.springframework.boot.logging.structured; 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;
import org.springframework.boot.json.JsonWriter.Members; 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}. * customize {@link JsonWriter} {@link Members}.
* <p> * <p>
* An implementation may be provided using the {@code logging.structured.json.customizer} * An implementation may be provided using the {@code logging.structured.json.customizer}
* property. * property.
* <p>
* Implementing classes can declare the following parameter types in the constructor:
* <ul>
* <li>{@link Environment}</li>
* </ul>
* When using Logback, implementing classes can also use the following parameter types in
* the constructor:
* <ul>
* <li>{@link ThrowableProxyConverter}</li>
* </ul>
* *
* @param <T> the type being written * @param <T> the type being written
* @author Phillip Webb * @author Phillip Webb