Skip to content

Commit de001f5

Browse files
mhalbrittermhalbritter
committed
Polish "Add standardized property to distinguish a group of applications"
See gh-39957
1 parent 8ddb77f commit de001f5

File tree

20 files changed

+73
-44
lines changed

20 files changed

+73
-44
lines changed

‎spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/otlp/OtlpPropertiesConfigAdapter.java

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828
import org.springframework.boot.actuate.autoconfigure.opentelemetry.OpenTelemetryProperties;
2929
import org.springframework.core.env.Environment;
3030
import org.springframework.util.CollectionUtils;
31+
import org.springframework.util.StringUtils;
3132

3233
/**
3334
* Adapter to convert {@link OtlpProperties} to an {@link OtlpConfig}.
@@ -43,11 +44,6 @@ class OtlpPropertiesConfigAdapter extends StepRegistryPropertiesConfigAdapter<Ot
4344
*/
4445
private static final String DEFAULT_APPLICATION_NAME = "unknown_service";
4546

46-
/**
47-
* Default value for application group if {@code spring.application.group} is not set.
48-
*/
49-
private static final String DEFAULT_APPLICATION_GROUP = "unknown_group";
50-
5147
private final OpenTelemetryProperties openTelemetryProperties;
5248

5349
private final OtlpMetricsConnectionDetails connectionDetails;
@@ -93,7 +89,8 @@ private String getApplicationName() {
9389
}
9490

9591
private String getApplicationGroup() {
96-
return this.environment.getProperty("spring.application.group", DEFAULT_APPLICATION_GROUP);
92+
String applicationGroup = this.environment.getProperty("spring.application.group");
93+
return (StringUtils.hasLength(applicationGroup)) ? applicationGroup : null;
9794
}
9895

9996
@Override

‎spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/opentelemetry/OpenTelemetryAutoConfiguration.java

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@
3636
import org.springframework.boot.context.properties.EnableConfigurationProperties;
3737
import org.springframework.context.annotation.Bean;
3838
import org.springframework.core.env.Environment;
39+
import org.springframework.util.StringUtils;
3940

4041
/**
4142
* {@link EnableAutoConfiguration Auto-configuration} for OpenTelemetry.
@@ -53,11 +54,6 @@ public class OpenTelemetryAutoConfiguration {
5354
*/
5455
private static final String DEFAULT_APPLICATION_NAME = "unknown_service";
5556

56-
/**
57-
* Default value for application group if {@code spring.application.group} is not set.
58-
*/
59-
private static final String DEFAULT_APPLICATION_GROUP = "unknown_group";
60-
6157
private static final AttributeKey<String> ATTRIBUTE_KEY_SERVICE_NAME = AttributeKey.stringKey("service.name");
6258

6359
private static final AttributeKey<String> ATTRIBUTE_KEY_SERVICE_GROUP = AttributeKey.stringKey("service.group");
@@ -79,11 +75,13 @@ OpenTelemetrySdk openTelemetry(ObjectProvider<SdkTracerProvider> tracerProvider,
7975
@ConditionalOnMissingBean
8076
Resource openTelemetryResource(Environment environment, OpenTelemetryProperties properties) {
8177
String applicationName = environment.getProperty("spring.application.name", DEFAULT_APPLICATION_NAME);
82-
String applicationGroup = environment.getProperty("spring.application.group", DEFAULT_APPLICATION_GROUP);
83-
return Resource.getDefault()
84-
.merge(Resource.create(Attributes.of(ATTRIBUTE_KEY_SERVICE_NAME, applicationName)))
85-
.merge(Resource.create(Attributes.of(ATTRIBUTE_KEY_SERVICE_GROUP, applicationGroup)))
86-
.merge(toResource(properties));
78+
String applicationGroup = environment.getProperty("spring.application.group");
79+
Resource resource = Resource.getDefault()
80+
.merge(Resource.create(Attributes.of(ATTRIBUTE_KEY_SERVICE_NAME, applicationName)));
81+
if (StringUtils.hasLength(applicationGroup)) {
82+
resource = resource.merge(Resource.create(Attributes.of(ATTRIBUTE_KEY_SERVICE_GROUP, applicationGroup)));
83+
}
84+
return resource.merge(toResource(properties));
8785
}
8886

8987
private static Resource toResource(OpenTelemetryProperties properties) {

‎spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/export/otlp/OtlpPropertiesConfigAdapterTests.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ void shouldUseApplicationGroupIfServiceGroupIsNotSet() {
162162

163163
@Test
164164
void shouldUseDefaultApplicationGroupIfApplicationGroupIsNotSet() {
165-
assertThat(createAdapter().resourceAttributes()).containsEntry("service.group", "unknown_group");
165+
assertThat(createAdapter().resourceAttributes()).doesNotContainKey("service.group");
166166
}
167167

168168
private OtlpPropertiesConfigAdapter createAdapter() {

‎spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/opentelemetry/OpenTelemetryAutoConfigurationTests.java

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,23 @@ void shouldApplySpringApplicationNameToResource() {
9090
});
9191
}
9292

93+
@Test
94+
void shouldApplySpringApplicationGroupToResource() {
95+
this.runner.withPropertyValues("spring.application.group=my-group").run((context) -> {
96+
Resource resource = context.getBean(Resource.class);
97+
assertThat(resource.getAttributes().asMap())
98+
.contains(entry(AttributeKey.stringKey("service.group"), "my-group"));
99+
});
100+
}
101+
102+
@Test
103+
void shouldNotApplySpringApplicationGroupIfNotSet() {
104+
this.runner.run((context) -> {
105+
Resource resource = context.getBean(Resource.class);
106+
assertThat(resource.getAttributes().asMap()).doesNotContainKey(AttributeKey.stringKey("service.group"));
107+
});
108+
}
109+
93110
@Test
94111
void shouldFallbackToDefaultApplicationNameIfSpringApplicationNameIsNotSet() {
95112
this.runner.run((context) -> {

‎spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/properties-and-configuration.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,6 @@ The preceding example YAML corresponds to the following `application.properties`
204204
[source,properties,subs="verbatim",configprops]
205205
----
206206
spring.application.name=cruncher
207-
spring.application.group=crunchGroup
208207
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
209208
spring.datasource.url=jdbc:mysql://localhost/test
210209
server.port=9000

‎spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/actuator/tracing.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,10 +88,9 @@ logging:
8888
pattern:
8989
correlation: "[${spring.application.name:},%X{traceId:-},%X{spanId:-}] "
9090
include-application-name: false
91-
include-application-group: false
9291
----
9392

94-
NOTE: In the example above, configprop:logging.include-application-name[] and configprop:logging.include-application-group[] is set to `false` to avoid the application name being duplicated in the log messages (configprop:logging.pattern.correlation[] already contains it).
93+
NOTE: In the example above, configprop:logging.include-application-name[] is set to `false` to avoid the application name being duplicated in the log messages (configprop:logging.pattern.correlation[] already contains it).
9594
It's also worth mentioning that configprop:logging.pattern.correlation[] contains a trailing space so that it is separated from the logger name that comes right after it by default.
9695

9796

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ NOTE: Logback does not have a `FATAL` level.
4444
It is mapped to `ERROR`.
4545

4646
TIP: If you have a configprop:spring.application.name[] property but don't want it logged you can set configprop:logging.include-application-name[] to `false`.
47+
4748
TIP: If you have a configprop:spring.application.group[] property but don't want it logged you can set configprop:logging.include-application-group[] to `false`.
4849

4950

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -260,7 +260,7 @@ private void setApplicationGroupSystemProperty(PropertyResolver resolver) {
260260
if (resolver.getProperty("logging.include-application-group", Boolean.class, Boolean.TRUE)) {
261261
String applicationGroup = resolver.getProperty("spring.application.group");
262262
if (StringUtils.hasText(applicationGroup)) {
263-
setSystemProperty(LoggingSystemProperty.APPLICATION_GROUP.getEnvironmentVariableName(),
263+
setSystemProperty(LoggingSystemProperty.LOGGED_APPLICATION_GROUP.getEnvironmentVariableName(),
264264
"[%s] ".formatted(applicationGroup));
265265
}
266266
}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ public enum LoggingSystemProperty {
3333
/**
3434
* Logging system property for the application group that should be logged.
3535
*/
36-
APPLICATION_GROUP("LOGGED_APPLICATION_GROUP"),
36+
LOGGED_APPLICATION_GROUP("LOGGED_APPLICATION_GROUP"),
3737

3838
/**
3939
* Logging system property for the process ID.

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

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@
2424

2525
/**
2626
* Logback {@link ClassicConverter} to convert the
27-
* {@link LoggingSystemProperty#APPLICATION_GROUP APPLICATION_GROUP} into a value suitable
28-
* for logging. Similar to Logback's {@link PropertyConverter} but a non-existent property
29-
* is logged as an empty string rather than {@code null}.
27+
* {@link LoggingSystemProperty#LOGGED_APPLICATION_GROUP APPLICATION_GROUP} into a value
28+
* suitable for logging. Similar to Logback's {@link PropertyConverter} but a non-existent
29+
* property is logged as an empty string rather than {@code null}.
3030
*
3131
* @author Jakob Wanger
3232
* @since 3.4.0
@@ -37,9 +37,10 @@ public class ApplicationGroupConverter extends ClassicConverter {
3737
public String convert(ILoggingEvent event) {
3838
String applicationGroup = event.getLoggerContextVO()
3939
.getPropertyMap()
40-
.get(LoggingSystemProperty.APPLICATION_GROUP.getEnvironmentVariableName());
40+
.get(LoggingSystemProperty.LOGGED_APPLICATION_GROUP.getEnvironmentVariableName());
4141
if (applicationGroup == null) {
42-
applicationGroup = System.getProperty(LoggingSystemProperty.APPLICATION_GROUP.getEnvironmentVariableName());
42+
applicationGroup = System
43+
.getProperty(LoggingSystemProperty.LOGGED_APPLICATION_GROUP.getEnvironmentVariableName());
4344
if (applicationGroup == null) {
4445
applicationGroup = "";
4546
}

0 commit comments

Comments
 (0)