Skip to content

Commit b5feada

Browse files
committed
Merge pull request #43314 from quaff
* gh-43314: Polish "Document StructuredLoggingJsonMembersCustomizer constructor params" Document StructuredLoggingJsonMembersCustomizer constructor params Closes gh-43314
2 parents d3c5a4b + 15109b2 commit b5feada

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

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

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,28 @@
1616

1717
package org.springframework.boot.logging.structured;
1818

19+
import ch.qos.logback.classic.pattern.ThrowableProxyConverter;
20+
1921
import org.springframework.boot.json.JsonWriter;
2022
import org.springframework.boot.json.JsonWriter.Members;
23+
import org.springframework.core.env.Environment;
2124

2225
/**
23-
* Customer that can be injected into a {@link StructuredLogFormatter} implementations to
26+
* Customizer that can be injected into {@link StructuredLogFormatter} implementations to
2427
* customize {@link JsonWriter} {@link Members}.
2528
* <p>
2629
* An implementation may be provided using the {@code logging.structured.json.customizer}
2730
* property.
31+
* <p>
32+
* Implementing classes can declare the following parameter types in the constructor:
33+
* <ul>
34+
* <li>{@link Environment}</li>
35+
* </ul>
36+
* When using Logback, implementing classes can also use the following parameter types in
37+
* the constructor:
38+
* <ul>
39+
* <li>{@link ThrowableProxyConverter}</li>
40+
* </ul>
2841
*
2942
* @param <T> the type being written
3043
* @author Phillip Webb

0 commit comments

Comments
 (0)