Skip to content

Commit c4c50b7

Browse files
committed
Only auto-configure LogbackMetrics when Logback is actually being used
Closes gh-12286
1 parent 96ae160 commit c4c50b7

File tree

3 files changed

+94
-6
lines changed

3 files changed

+94
-6
lines changed

spring-boot-project/spring-boot-actuator-autoconfigure/pom.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,11 @@
3737
<artifactId>spring-context</artifactId>
3838
</dependency>
3939
<!-- Optional -->
40+
<dependency>
41+
<groupId>ch.qos.logback</groupId>
42+
<artifactId>logback-classic</artifactId>
43+
<optional>true</optional>
44+
</dependency>
4045
<dependency>
4146
<groupId>com.fasterxml.jackson.dataformat</groupId>
4247
<artifactId>jackson-dataformat-xml</artifactId>
@@ -379,11 +384,6 @@
379384
<artifactId>spring-boot-test-support</artifactId>
380385
<scope>test</scope>
381386
</dependency>
382-
<dependency>
383-
<groupId>ch.qos.logback</groupId>
384-
<artifactId>logback-classic</artifactId>
385-
<scope>test</scope>
386-
</dependency>
387387
<dependency>
388388
<groupId>io.projectreactor</groupId>
389389
<artifactId>reactor-test</artifactId>

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/MetricsAutoConfiguration.java

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616

1717
package org.springframework.boot.actuate.autoconfigure.metrics;
1818

19+
import ch.qos.logback.classic.LoggerContext;
1920
import io.micrometer.core.annotation.Timed;
2021
import io.micrometer.core.instrument.Clock;
2122
import io.micrometer.core.instrument.binder.jvm.ClassLoaderMetrics;
@@ -26,17 +27,25 @@
2627
import io.micrometer.core.instrument.binder.system.FileDescriptorMetrics;
2728
import io.micrometer.core.instrument.binder.system.ProcessorMetrics;
2829
import io.micrometer.core.instrument.binder.system.UptimeMetrics;
30+
import org.slf4j.ILoggerFactory;
31+
import org.slf4j.LoggerFactory;
2932

3033
import org.springframework.boot.autoconfigure.AutoConfigureBefore;
3134
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
35+
import org.springframework.boot.autoconfigure.condition.ConditionMessage;
36+
import org.springframework.boot.autoconfigure.condition.ConditionOutcome;
3237
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
3338
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
3439
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
40+
import org.springframework.boot.autoconfigure.condition.SpringBootCondition;
3541
import org.springframework.boot.context.properties.EnableConfigurationProperties;
3642
import org.springframework.context.ApplicationContext;
3743
import org.springframework.context.annotation.Bean;
44+
import org.springframework.context.annotation.ConditionContext;
45+
import org.springframework.context.annotation.Conditional;
3846
import org.springframework.context.annotation.Configuration;
3947
import org.springframework.core.annotation.Order;
48+
import org.springframework.core.type.AnnotatedTypeMetadata;
4049

4150
/**
4251
* {@link EnableAutoConfiguration Auto-configuration} for Micrometer-based metrics.
@@ -103,7 +112,9 @@ public ClassLoaderMetrics classLoaderMetrics() {
103112
static class MeterBindersConfiguration {
104113

105114
@Bean
106-
@ConditionalOnClass(name = "ch.qos.logback.classic.Logger")
115+
@ConditionalOnClass(name = { "ch.qos.logback.classic.LoggerContext",
116+
"org.slf4j.LoggerFactory" })
117+
@Conditional(LogbackLoggingCondition.class)
107118
@ConditionalOnMissingBean(LogbackMetrics.class)
108119
@ConditionalOnProperty(value = "management.metrics.binders.logback.enabled", matchIfMissing = true)
109120
public LogbackMetrics logbackMetrics() {
@@ -133,4 +144,23 @@ public FileDescriptorMetrics fileDescriptorMetrics() {
133144

134145
}
135146

147+
static class LogbackLoggingCondition extends SpringBootCondition {
148+
149+
@Override
150+
public ConditionOutcome getMatchOutcome(ConditionContext context,
151+
AnnotatedTypeMetadata metadata) {
152+
ILoggerFactory loggerFactory = LoggerFactory.getILoggerFactory();
153+
ConditionMessage.Builder message = ConditionMessage
154+
.forCondition("LogbackLoggingCondition");
155+
if (loggerFactory instanceof LoggerContext) {
156+
return ConditionOutcome.match(
157+
message.because("ILoggerFactory is a Logback LoggerContext"));
158+
}
159+
return ConditionOutcome
160+
.noMatch(message.because("ILoggerFactory is an instance of "
161+
+ loggerFactory.getClass().getCanonicalName()));
162+
}
163+
164+
}
165+
136166
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
/*
2+
* Copyright 2012-2018 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+
* http://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.actuate.autoconfigure.metrics;
18+
19+
import io.micrometer.core.instrument.binder.logging.LogbackMetrics;
20+
import org.junit.Test;
21+
import org.junit.runner.RunWith;
22+
23+
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
24+
import org.springframework.boot.autoconfigure.AutoConfigurations;
25+
import org.springframework.boot.autoconfigure.condition.ConditionEvaluationReport;
26+
import org.springframework.boot.autoconfigure.logging.ConditionEvaluationReportMessage;
27+
import org.springframework.boot.test.context.runner.ApplicationContextRunner;
28+
import org.springframework.boot.testsupport.runner.classpath.ClassPathOverrides;
29+
import org.springframework.boot.testsupport.runner.classpath.ModifiedClassPathRunner;
30+
31+
import static org.assertj.core.api.Assertions.assertThat;
32+
33+
/**
34+
* Tests for {@link MetricsAutoConfiguration} when both Log4j2 and Logback are on the
35+
* classpath.
36+
*
37+
* @author Andy Wilkinson
38+
*/
39+
@RunWith(ModifiedClassPathRunner.class)
40+
@ClassPathOverrides({ "org.apache.logging.log4j:log4j-core:2.9.0",
41+
"org.apache.logging.log4j:log4j-slf4j-impl:2.9.0" })
42+
public class MetricsAutoConfigurationWithLog4j2AndLogbackTests {
43+
44+
private final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
45+
.withConfiguration(AutoConfigurations.of(MetricsAutoConfiguration.class));
46+
47+
@Test
48+
public void doesNotConfigureLogbackMetrics() {
49+
this.contextRunner.run((context) -> {
50+
System.out.println(
51+
new ConditionEvaluationReportMessage(ConditionEvaluationReport
52+
.get((ConfigurableListableBeanFactory) context
53+
.getAutowireCapableBeanFactory())));
54+
assertThat(context).doesNotHaveBean(LogbackMetrics.class);
55+
});
56+
}
57+
58+
}

0 commit comments

Comments
 (0)