Skip to content

Commit 0b854bf

Browse files
izeyephilwebb
izeye
authored and
philwebb
committed
Replace "structure logging" with "structured logging"
See gh-43203
1 parent 68022ef commit 0b854bf

File tree

32 files changed

+66
-65
lines changed

32 files changed

+66
-65
lines changed

‎spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/features/logging.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -609,7 +609,7 @@ logging:
609609
corpname: mycorp
610610
----
611611

612-
TIP: For more advanced customizations, you can write your own class that implements the javadoc:org.springframework.boot.logging.structured.StructureLoggingJsonMembersCustomizer[] interface and declare it using the configprop:logging.structured.json.customizer[] property.
612+
TIP: For more advanced customizations, you can write your own class that implements the javadoc:org.springframework.boot.logging.structured.StructuredLoggingJsonMembersCustomizer[] interface and declare it using the configprop:logging.structured.json.customizer[] property.
613613
You can also declare implementations by listing them in a `META-INF/spring.factories` file.
614614

615615

‎spring-boot-project/spring-boot/src/main/java/org/springframework/boot/logging/log4j2/ElasticCommonSchemaStructuredLogFormatter.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@
2828
import org.springframework.boot.logging.structured.CommonStructuredLogFormat;
2929
import org.springframework.boot.logging.structured.ElasticCommonSchemaProperties;
3030
import org.springframework.boot.logging.structured.JsonWriterStructuredLogFormatter;
31-
import org.springframework.boot.logging.structured.StructureLoggingJsonMembersCustomizer;
3231
import org.springframework.boot.logging.structured.StructuredLogFormatter;
32+
import org.springframework.boot.logging.structured.StructuredLoggingJsonMembersCustomizer;
3333
import org.springframework.core.env.Environment;
3434
import org.springframework.util.ObjectUtils;
3535

@@ -43,7 +43,7 @@
4343
class ElasticCommonSchemaStructuredLogFormatter extends JsonWriterStructuredLogFormatter<LogEvent> {
4444

4545
ElasticCommonSchemaStructuredLogFormatter(Environment environment,
46-
StructureLoggingJsonMembersCustomizer<?> customizer) {
46+
StructuredLoggingJsonMembersCustomizer<?> customizer) {
4747
super((members) -> jsonMembers(environment, members), customizer);
4848
}
4949

‎spring-boot-project/spring-boot/src/main/java/org/springframework/boot/logging/log4j2/GraylogExtendedLogFormatStructuredLogFormatter.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@
3737
import org.springframework.boot.logging.structured.CommonStructuredLogFormat;
3838
import org.springframework.boot.logging.structured.GraylogExtendedLogFormatProperties;
3939
import org.springframework.boot.logging.structured.JsonWriterStructuredLogFormatter;
40-
import org.springframework.boot.logging.structured.StructureLoggingJsonMembersCustomizer;
4140
import org.springframework.boot.logging.structured.StructuredLogFormatter;
41+
import org.springframework.boot.logging.structured.StructuredLoggingJsonMembersCustomizer;
4242
import org.springframework.core.env.Environment;
4343
import org.springframework.core.log.LogMessage;
4444
import org.springframework.util.Assert;
@@ -70,7 +70,7 @@ class GraylogExtendedLogFormatStructuredLogFormatter extends JsonWriterStructure
7070
private static final Set<String> ADDITIONAL_FIELD_ILLEGAL_KEYS = Set.of("id", "_id");
7171

7272
GraylogExtendedLogFormatStructuredLogFormatter(Environment environment,
73-
StructureLoggingJsonMembersCustomizer<?> customizer) {
73+
StructuredLoggingJsonMembersCustomizer<?> customizer) {
7474
super((members) -> jsonMembers(environment, members), customizer);
7575
}
7676

‎spring-boot-project/spring-boot/src/main/java/org/springframework/boot/logging/log4j2/LogstashStructuredLogFormatter.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@
3232
import org.springframework.boot.json.JsonWriter;
3333
import org.springframework.boot.logging.structured.CommonStructuredLogFormat;
3434
import org.springframework.boot.logging.structured.JsonWriterStructuredLogFormatter;
35-
import org.springframework.boot.logging.structured.StructureLoggingJsonMembersCustomizer;
3635
import org.springframework.boot.logging.structured.StructuredLogFormatter;
36+
import org.springframework.boot.logging.structured.StructuredLoggingJsonMembersCustomizer;
3737
import org.springframework.util.CollectionUtils;
3838

3939
/**
@@ -44,7 +44,7 @@
4444
*/
4545
class LogstashStructuredLogFormatter extends JsonWriterStructuredLogFormatter<LogEvent> {
4646

47-
LogstashStructuredLogFormatter(StructureLoggingJsonMembersCustomizer<?> customizer) {
47+
LogstashStructuredLogFormatter(StructuredLoggingJsonMembersCustomizer<?> customizer) {
4848
super(LogstashStructuredLogFormatter::jsonMembers, customizer);
4949
}
5050

‎spring-boot-project/spring-boot/src/main/java/org/springframework/boot/logging/log4j2/StructuredLogLayout.java

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,10 @@
3030
import org.apache.logging.log4j.core.layout.AbstractStringLayout;
3131

3232
import org.springframework.boot.logging.structured.CommonStructuredLogFormat;
33-
import org.springframework.boot.logging.structured.StructureLoggingJsonMembersCustomizer;
3433
import org.springframework.boot.logging.structured.StructuredLogFormatter;
3534
import org.springframework.boot.logging.structured.StructuredLogFormatterFactory;
3635
import org.springframework.boot.logging.structured.StructuredLogFormatterFactory.CommonFormatters;
36+
import org.springframework.boot.logging.structured.StructuredLoggingJsonMembersCustomizer;
3737
import org.springframework.boot.util.Instantiator;
3838
import org.springframework.core.env.Environment;
3939
import org.springframework.util.Assert;
@@ -111,21 +111,21 @@ private void addCommonFormatters(CommonFormatters<LogEvent> commonFormatters) {
111111

112112
private ElasticCommonSchemaStructuredLogFormatter createEcsFormatter(Instantiator<?> instantiator) {
113113
Environment environment = instantiator.getArg(Environment.class);
114-
StructureLoggingJsonMembersCustomizer<?> jsonMembersCustomizer = instantiator
115-
.getArg(StructureLoggingJsonMembersCustomizer.class);
114+
StructuredLoggingJsonMembersCustomizer<?> jsonMembersCustomizer = instantiator
115+
.getArg(StructuredLoggingJsonMembersCustomizer.class);
116116
return new ElasticCommonSchemaStructuredLogFormatter(environment, jsonMembersCustomizer);
117117
}
118118

119119
private GraylogExtendedLogFormatStructuredLogFormatter createGraylogFormatter(Instantiator<?> instantiator) {
120120
Environment environment = instantiator.getArg(Environment.class);
121-
StructureLoggingJsonMembersCustomizer<?> jsonMembersCustomizer = instantiator
122-
.getArg(StructureLoggingJsonMembersCustomizer.class);
121+
StructuredLoggingJsonMembersCustomizer<?> jsonMembersCustomizer = instantiator
122+
.getArg(StructuredLoggingJsonMembersCustomizer.class);
123123
return new GraylogExtendedLogFormatStructuredLogFormatter(environment, jsonMembersCustomizer);
124124
}
125125

126126
private LogstashStructuredLogFormatter createLogstashFormatter(Instantiator<?> instantiator) {
127-
StructureLoggingJsonMembersCustomizer<?> jsonMembersCustomizer = instantiator
128-
.getArg(StructureLoggingJsonMembersCustomizer.class);
127+
StructuredLoggingJsonMembersCustomizer<?> jsonMembersCustomizer = instantiator
128+
.getArg(StructuredLoggingJsonMembersCustomizer.class);
129129
return new LogstashStructuredLogFormatter(jsonMembersCustomizer);
130130
}
131131

‎spring-boot-project/spring-boot/src/main/java/org/springframework/boot/logging/logback/ElasticCommonSchemaStructuredLogFormatter.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@
2828
import org.springframework.boot.logging.structured.CommonStructuredLogFormat;
2929
import org.springframework.boot.logging.structured.ElasticCommonSchemaProperties;
3030
import org.springframework.boot.logging.structured.JsonWriterStructuredLogFormatter;
31-
import org.springframework.boot.logging.structured.StructureLoggingJsonMembersCustomizer;
3231
import org.springframework.boot.logging.structured.StructuredLogFormatter;
32+
import org.springframework.boot.logging.structured.StructuredLoggingJsonMembersCustomizer;
3333
import org.springframework.core.env.Environment;
3434

3535
/**
@@ -45,7 +45,7 @@ class ElasticCommonSchemaStructuredLogFormatter extends JsonWriterStructuredLogF
4545
(pair) -> pair.value);
4646

4747
ElasticCommonSchemaStructuredLogFormatter(Environment environment, ThrowableProxyConverter throwableProxyConverter,
48-
StructureLoggingJsonMembersCustomizer<?> customizer) {
48+
StructuredLoggingJsonMembersCustomizer<?> customizer) {
4949
super((members) -> jsonMembers(environment, throwableProxyConverter, members), customizer);
5050
}
5151

‎spring-boot-project/spring-boot/src/main/java/org/springframework/boot/logging/logback/GraylogExtendedLogFormatStructuredLogFormatter.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@
3737
import org.springframework.boot.logging.structured.CommonStructuredLogFormat;
3838
import org.springframework.boot.logging.structured.GraylogExtendedLogFormatProperties;
3939
import org.springframework.boot.logging.structured.JsonWriterStructuredLogFormatter;
40-
import org.springframework.boot.logging.structured.StructureLoggingJsonMembersCustomizer;
4140
import org.springframework.boot.logging.structured.StructuredLogFormatter;
41+
import org.springframework.boot.logging.structured.StructuredLoggingJsonMembersCustomizer;
4242
import org.springframework.core.env.Environment;
4343
import org.springframework.core.log.LogMessage;
4444
import org.springframework.util.Assert;
@@ -70,7 +70,7 @@ class GraylogExtendedLogFormatStructuredLogFormatter extends JsonWriterStructure
7070
private static final Set<String> ADDITIONAL_FIELD_ILLEGAL_KEYS = Set.of("id", "_id");
7171

7272
GraylogExtendedLogFormatStructuredLogFormatter(Environment environment,
73-
ThrowableProxyConverter throwableProxyConverter, StructureLoggingJsonMembersCustomizer<?> customizer) {
73+
ThrowableProxyConverter throwableProxyConverter, StructuredLoggingJsonMembersCustomizer<?> customizer) {
7474
super((members) -> jsonMembers(environment, throwableProxyConverter, members), customizer);
7575
}
7676

‎spring-boot-project/spring-boot/src/main/java/org/springframework/boot/logging/logback/LogstashStructuredLogFormatter.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@
3535
import org.springframework.boot.json.JsonWriter.PairExtractor;
3636
import org.springframework.boot.logging.structured.CommonStructuredLogFormat;
3737
import org.springframework.boot.logging.structured.JsonWriterStructuredLogFormatter;
38-
import org.springframework.boot.logging.structured.StructureLoggingJsonMembersCustomizer;
3938
import org.springframework.boot.logging.structured.StructuredLogFormatter;
39+
import org.springframework.boot.logging.structured.StructuredLoggingJsonMembersCustomizer;
4040

4141
/**
4242
* Logback {@link StructuredLogFormatter} for {@link CommonStructuredLogFormat#LOGSTASH}.
@@ -50,7 +50,7 @@ class LogstashStructuredLogFormatter extends JsonWriterStructuredLogFormatter<IL
5050
(pair) -> pair.value);
5151

5252
LogstashStructuredLogFormatter(ThrowableProxyConverter throwableProxyConverter,
53-
StructureLoggingJsonMembersCustomizer<?> customizer) {
53+
StructuredLoggingJsonMembersCustomizer<?> customizer) {
5454
super((members) -> jsonMembers(throwableProxyConverter, members), customizer);
5555
}
5656

‎spring-boot-project/spring-boot/src/main/java/org/springframework/boot/logging/logback/StructuredLogEncoder.java

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@
2525
import ch.qos.logback.core.encoder.EncoderBase;
2626

2727
import org.springframework.boot.logging.structured.CommonStructuredLogFormat;
28-
import org.springframework.boot.logging.structured.StructureLoggingJsonMembersCustomizer;
2928
import org.springframework.boot.logging.structured.StructuredLogFormatter;
3029
import org.springframework.boot.logging.structured.StructuredLogFormatterFactory;
3130
import org.springframework.boot.logging.structured.StructuredLogFormatterFactory.CommonFormatters;
31+
import org.springframework.boot.logging.structured.StructuredLoggingJsonMembersCustomizer;
3232
import org.springframework.boot.util.Instantiator;
3333
import org.springframework.boot.util.Instantiator.AvailableParameters;
3434
import org.springframework.core.env.Environment;
@@ -89,25 +89,25 @@ private void addCommonFormatters(CommonFormatters<ILoggingEvent> commonFormatter
8989
private StructuredLogFormatter<ILoggingEvent> createEcsFormatter(Instantiator<?> instantiator) {
9090
Environment environment = instantiator.getArg(Environment.class);
9191
ThrowableProxyConverter throwableProxyConverter = instantiator.getArg(ThrowableProxyConverter.class);
92-
StructureLoggingJsonMembersCustomizer<?> jsonMembersCustomizer = instantiator
93-
.getArg(StructureLoggingJsonMembersCustomizer.class);
92+
StructuredLoggingJsonMembersCustomizer<?> jsonMembersCustomizer = instantiator
93+
.getArg(StructuredLoggingJsonMembersCustomizer.class);
9494
return new ElasticCommonSchemaStructuredLogFormatter(environment, throwableProxyConverter,
9595
jsonMembersCustomizer);
9696
}
9797

9898
private StructuredLogFormatter<ILoggingEvent> createGraylogFormatter(Instantiator<?> instantiator) {
9999
Environment environment = instantiator.getArg(Environment.class);
100100
ThrowableProxyConverter throwableProxyConverter = instantiator.getArg(ThrowableProxyConverter.class);
101-
StructureLoggingJsonMembersCustomizer<?> jsonMembersCustomizer = instantiator
102-
.getArg(StructureLoggingJsonMembersCustomizer.class);
101+
StructuredLoggingJsonMembersCustomizer<?> jsonMembersCustomizer = instantiator
102+
.getArg(StructuredLoggingJsonMembersCustomizer.class);
103103
return new GraylogExtendedLogFormatStructuredLogFormatter(environment, throwableProxyConverter,
104104
jsonMembersCustomizer);
105105
}
106106

107107
private StructuredLogFormatter<ILoggingEvent> createLogstashFormatter(Instantiator<?> instantiator) {
108108
ThrowableProxyConverter throwableProxyConverter = instantiator.getArg(ThrowableProxyConverter.class);
109-
StructureLoggingJsonMembersCustomizer<?> jsonMembersCustomizer = instantiator
110-
.getArg(StructureLoggingJsonMembersCustomizer.class);
109+
StructuredLoggingJsonMembersCustomizer<?> jsonMembersCustomizer = instantiator
110+
.getArg(StructuredLoggingJsonMembersCustomizer.class);
111111
return new LogstashStructuredLogFormatter(throwableProxyConverter, jsonMembersCustomizer);
112112
}
113113

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,18 +42,18 @@ public abstract class JsonWriterStructuredLogFormatter<E> implements StructuredL
4242
* @param customizer an optional customizer to apply
4343
*/
4444
protected JsonWriterStructuredLogFormatter(Consumer<Members<E>> members,
45-
StructureLoggingJsonMembersCustomizer<?> customizer) {
45+
StructuredLoggingJsonMembersCustomizer<?> customizer) {
4646
this(JsonWriter.of(customized(members, customizer)).withNewLineAtEnd());
4747
}
4848

4949
private static <E> Consumer<Members<E>> customized(Consumer<Members<E>> members,
50-
StructureLoggingJsonMembersCustomizer<?> customizer) {
50+
StructuredLoggingJsonMembersCustomizer<?> customizer) {
5151
return (customizer != null) ? members.andThen(customizeWith(customizer)) : members;
5252
}
5353

5454
@SuppressWarnings("unchecked")
55-
private static <E> Consumer<Members<E>> customizeWith(StructureLoggingJsonMembersCustomizer<?> customizer) {
56-
return (members) -> LambdaSafe.callback(StructureLoggingJsonMembersCustomizer.class, customizer, members)
55+
private static <E> Consumer<Members<E>> customizeWith(StructuredLoggingJsonMembersCustomizer<?> customizer) {
56+
return (members) -> LambdaSafe.callback(StructuredLoggingJsonMembersCustomizer.class, customizer, members)
5757
.invoke((instance) -> instance.customize(members));
5858
}
5959

0 commit comments

Comments
 (0)