Skip to content

Commit 456d7b7

Browse files
wanger26wanger26
committed
FEAT - Add standardized property to distinguish a group of applications
- Add a standardized property to provide some indicator that a set of applications are part of a larger "business application" so that they can be viewed in metrics, portals, traces and more #39913 Signed-off-by: Jakob Wanger <[email protected]>
1 parent 781d7b0 commit 456d7b7

File tree

20 files changed

+362
-14
lines changed

20 files changed

+362
-14
lines changed

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,11 @@ class OtlpPropertiesConfigAdapter extends StepRegistryPropertiesConfigAdapter<Ot
4343
*/
4444
private static final String DEFAULT_APPLICATION_NAME = "unknown_service";
4545

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+
4651
private final OpenTelemetryProperties openTelemetryProperties;
4752

4853
private final OtlpMetricsConnectionDetails connectionDetails;
@@ -79,13 +84,18 @@ public Map<String, String> resourceAttributes() {
7984
Map<String, String> result = new HashMap<>((!CollectionUtils.isEmpty(resourceAttributes)) ? resourceAttributes
8085
: get(OtlpProperties::getResourceAttributes, OtlpConfig.super::resourceAttributes));
8186
result.computeIfAbsent("service.name", (key) -> getApplicationName());
87+
result.computeIfAbsent("service.group", (key) -> getApplicationGroup());
8288
return Collections.unmodifiableMap(result);
8389
}
8490

8591
private String getApplicationName() {
8692
return this.environment.getProperty("spring.application.name", DEFAULT_APPLICATION_NAME);
8793
}
8894

95+
private String getApplicationGroup() {
96+
return this.environment.getProperty("spring.application.group", DEFAULT_APPLICATION_GROUP);
97+
}
98+
8999
@Override
90100
public Map<String, String> headers() {
91101
return get(OtlpProperties::getHeaders, OtlpConfig.super::headers);

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

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,15 @@ public class OpenTelemetryAutoConfiguration {
5353
*/
5454
private static final String DEFAULT_APPLICATION_NAME = "unknown_service";
5555

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+
5661
private static final AttributeKey<String> ATTRIBUTE_KEY_SERVICE_NAME = AttributeKey.stringKey("service.name");
5762

63+
private static final AttributeKey<String> ATTRIBUTE_KEY_SERVICE_GROUP = AttributeKey.stringKey("service.group");
64+
5865
@Bean
5966
@ConditionalOnMissingBean(OpenTelemetry.class)
6067
OpenTelemetrySdk openTelemetry(ObjectProvider<SdkTracerProvider> tracerProvider,
@@ -72,8 +79,10 @@ OpenTelemetrySdk openTelemetry(ObjectProvider<SdkTracerProvider> tracerProvider,
7279
@ConditionalOnMissingBean
7380
Resource openTelemetryResource(Environment environment, OpenTelemetryProperties properties) {
7481
String applicationName = environment.getProperty("spring.application.name", DEFAULT_APPLICATION_NAME);
82+
String applicationGroup = environment.getProperty("spring.application.group", DEFAULT_APPLICATION_GROUP);
7583
return Resource.getDefault()
7684
.merge(Resource.create(Attributes.of(ATTRIBUTE_KEY_SERVICE_NAME, applicationName)))
85+
.merge(Resource.create(Attributes.of(ATTRIBUTE_KEY_SERVICE_GROUP, applicationGroup)))
7786
.merge(toResource(properties));
7887
}
7988

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

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,32 @@ void shouldUseDefaultApplicationNameIfApplicationNameIsNotSet() {
139139
assertThat(createAdapter().resourceAttributes()).containsEntry("service.name", "unknown_service");
140140
}
141141

142+
@Test
143+
@SuppressWarnings("removal")
144+
void serviceGroupOverridesApplicationGroup() {
145+
this.environment.setProperty("spring.application.group", "alpha");
146+
this.properties.setResourceAttributes(Map.of("service.group", "beta"));
147+
assertThat(createAdapter().resourceAttributes()).containsEntry("service.group", "beta");
148+
}
149+
150+
@Test
151+
void serviceGroupOverridesApplicationGroupWhenUsingOtelProperties() {
152+
this.environment.setProperty("spring.application.group", "alpha");
153+
this.openTelemetryProperties.setResourceAttributes(Map.of("service.group", "beta"));
154+
assertThat(createAdapter().resourceAttributes()).containsEntry("service.group", "beta");
155+
}
156+
157+
@Test
158+
void shouldUseApplicationGroupIfServiceGroupIsNotSet() {
159+
this.environment.setProperty("spring.application.group", "alpha");
160+
assertThat(createAdapter().resourceAttributes()).containsEntry("service.group", "alpha");
161+
}
162+
163+
@Test
164+
void shouldUseDefaultApplicationGroupIfApplicationGroupIsNotSet() {
165+
assertThat(createAdapter().resourceAttributes()).containsEntry("service.group", "unknown_group");
166+
}
167+
142168
private OtlpPropertiesConfigAdapter createAdapter() {
143169
return new OtlpPropertiesConfigAdapter(this.properties, this.openTelemetryProperties, this.connectionDetails,
144170
this.environment);

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,7 @@ 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
207208
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
208209
spring.datasource.url=jdbc:mysql://localhost/test
209210
server.port=9000

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

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

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).
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).
9495
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.
9596

9697

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ The following items are output:
3434
* Process ID.
3535
* A `---` separator to distinguish the start of actual log messages.
3636
* Application name: Enclosed in square brackets (logged by default only if configprop:spring.application.name[] is set)
37+
* Application group: Enclosed in square brackets (logged by default only if configprop:spring.application.group[] is set)
3738
* Thread name: Enclosed in square brackets (may be truncated for console output).
3839
* Correlation ID: If tracing is enabled (not shown in the sample above)
3940
* Logger name: This is usually the source class name (often abbreviated).
@@ -43,6 +44,7 @@ NOTE: Logback does not have a `FATAL` level.
4344
It is mapped to `ERROR`.
4445

4546
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+
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`.
4648

4749

4850

@@ -544,12 +546,13 @@ The following listing shows three sample profiles:
544546
If you want to refer to properties from your Spring `Environment` within your Log4j2 configuration you can use `spring:` prefixed https://logging.apache.org/log4j/2.x/manual/lookups.html[lookups].
545547
Doing so can be useful if you want to access values from your `application.properties` file in your Log4j2 configuration.
546548

547-
The following example shows how to set a Log4j2 property named `applicationName` that reads `spring.application.name` from the Spring `Environment`:
549+
The following example shows how to set a Log4j2 property named `applicationName` and `applicationGroup` that reads `spring.application.name` and `spring.application.group` from the Spring `Environment`:
548550

549551
[source,xml]
550552
----
551553
<Properties>
552554
<Property name="applicationName">${spring:spring.application.name}</Property>
555+
<Property name="applicationProperty">${spring:spring.application.property}</Property>
553556
</Properties>
554557
----
555558

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

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -229,6 +229,7 @@ private PropertyResolver getPropertyResolver() {
229229
protected void apply(LogFile logFile, PropertyResolver resolver) {
230230
String defaultCharsetName = getDefaultCharset().name();
231231
setApplicationNameSystemProperty(resolver);
232+
setApplicationGroupSystemProperty(resolver);
232233
setSystemProperty(LoggingSystemProperty.PID, new ApplicationPid().toString());
233234
setSystemProperty(LoggingSystemProperty.CONSOLE_CHARSET, resolver, defaultCharsetName);
234235
setSystemProperty(LoggingSystemProperty.FILE_CHARSET, resolver, defaultCharsetName);
@@ -255,6 +256,16 @@ private void setApplicationNameSystemProperty(PropertyResolver resolver) {
255256
}
256257
}
257258

259+
private void setApplicationGroupSystemProperty(PropertyResolver resolver) {
260+
if (resolver.getProperty("logging.include-application-group", Boolean.class, Boolean.TRUE)) {
261+
String applicationGroup = resolver.getProperty("spring.application.group");
262+
if (StringUtils.hasText(applicationGroup)) {
263+
setSystemProperty(LoggingSystemProperty.APPLICATION_GROUP.getEnvironmentVariableName(),
264+
"[%s] ".formatted(applicationGroup));
265+
}
266+
}
267+
}
268+
258269
private void setSystemProperty(LoggingSystemProperty property, PropertyResolver resolver) {
259270
setSystemProperty(property, resolver, Function.identity());
260271
}

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,11 @@ public enum LoggingSystemProperty {
3030
*/
3131
APPLICATION_NAME("LOGGED_APPLICATION_NAME"),
3232

33+
/**
34+
* Logging system property for the application group that should be logged.
35+
*/
36+
APPLICATION_GROUP("LOGGED_APPLICATION_GROUP"),
37+
3338
/**
3439
* Logging system property for the process ID.
3540
*/

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

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
/*
2+
* Copyright 2012-2024 the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package org.springframework.boot.logging.logback;
18+
19+
import ch.qos.logback.classic.pattern.ClassicConverter;
20+
import ch.qos.logback.classic.pattern.PropertyConverter;
21+
import ch.qos.logback.classic.spi.ILoggingEvent;
22+
23+
import org.springframework.boot.logging.LoggingSystemProperty;
24+
25+
/**
26+
* 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}.
30+
*
31+
* @author Jakob Wanger
32+
* @since 3.4.0
33+
*/
34+
public class ApplicationGroupConverter extends ClassicConverter {
35+
36+
@Override
37+
public String convert(ILoggingEvent event) {
38+
String applicationGroup = event.getLoggerContextVO()
39+
.getPropertyMap()
40+
.get(LoggingSystemProperty.APPLICATION_GROUP.getEnvironmentVariableName());
41+
if (applicationGroup == null) {
42+
applicationGroup = System.getProperty(LoggingSystemProperty.APPLICATION_GROUP.getEnvironmentVariableName());
43+
if (applicationGroup == null) {
44+
applicationGroup = "";
45+
}
46+
}
47+
return applicationGroup;
48+
}
49+
50+
}

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,14 +69,15 @@ void apply(LogbackConfigurator config) {
6969

7070
private void defaults(LogbackConfigurator config) {
7171
config.conversionRule("applicationName", ApplicationNameConverter.class);
72+
config.conversionRule("applicationGroup", ApplicationGroupConverter.class);
7273
config.conversionRule("clr", ColorConverter.class);
7374
config.conversionRule("correlationId", CorrelationIdConverter.class);
7475
config.conversionRule("wex", WhitespaceThrowableProxyConverter.class);
7576
config.conversionRule("wEx", ExtendedWhitespaceThrowableProxyConverter.class);
7677
config.getContext()
7778
.putProperty("CONSOLE_LOG_PATTERN", resolve(config, "${CONSOLE_LOG_PATTERN:-"
7879
+ "%clr(%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd'T'HH:mm:ss.SSSXXX}}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) "
79-
+ "%clr(${PID:- }){magenta} %clr(---){faint} %clr(%applicationName[%15.15t]){faint} "
80+
+ "%clr(${PID:- }){magenta} %clr(---){faint} %clr(%applicationName[%15.15t]){faint} %clr(---){faint} %clr(%applicationGroup[%15.15t]){faint} "
8081
+ "%clr(${LOG_CORRELATION_PATTERN:-}){faint}%clr(%-40.40logger{39}){cyan} "
8182
+ "%clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"));
8283
String defaultCharset = Charset.defaultCharset().name();
@@ -85,7 +86,7 @@ private void defaults(LogbackConfigurator config) {
8586
config.getContext().putProperty("CONSOLE_LOG_THRESHOLD", resolve(config, "${CONSOLE_LOG_THRESHOLD:-TRACE}"));
8687
config.getContext()
8788
.putProperty("FILE_LOG_PATTERN", resolve(config, "${FILE_LOG_PATTERN:-"
88-
+ "%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd'T'HH:mm:ss.SSSXXX}} ${LOG_LEVEL_PATTERN:-%5p} ${PID:- } --- %applicationName[%t] "
89+
+ "%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd'T'HH:mm:ss.SSSXXX}} ${LOG_LEVEL_PATTERN:-%5p} ${PID:- } --- %applicationName[%t] --- %applicationGroup[%t] "
8990
+ "${LOG_CORRELATION_PATTERN:-}"
9091
+ "%-40.40logger{39} : %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"));
9192
config.getContext()

0 commit comments

Comments
 (0)