From c29d686a727b47f84ec6d44f1eb70db949f3cb2e Mon Sep 17 00:00:00 2001 From: Marcin Grzejszczak Date: Wed, 13 Apr 2022 10:31:35 +0200 Subject: [PATCH] Added a logging message when BeanCreationException happens; fixes gh-2136 --- .../web/SkipPatternConfiguration.java | 10 +++- .../web/SkipPatternConfigurationTests.java | 46 +++++++++++++++++++ 2 files changed, 54 insertions(+), 2 deletions(-) create mode 100644 spring-cloud-sleuth-autoconfigure/src/test/java/org/springframework/cloud/sleuth/autoconfig/instrument/web/SkipPatternConfigurationTests.java diff --git a/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/instrument/web/SkipPatternConfiguration.java b/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/instrument/web/SkipPatternConfiguration.java index 280229121..910c47f71 100644 --- a/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/instrument/web/SkipPatternConfiguration.java +++ b/spring-cloud-sleuth-autoconfigure/src/main/java/org/springframework/cloud/sleuth/autoconfig/instrument/web/SkipPatternConfiguration.java @@ -23,6 +23,9 @@ import java.util.StringJoiner; import java.util.regex.Pattern; import java.util.stream.Collectors; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + import org.springframework.beans.factory.BeanCreationException; import org.springframework.beans.factory.ObjectProvider; import org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties; @@ -59,6 +62,8 @@ import org.springframework.util.StringUtils; @EnableConfigurationProperties(SleuthWebProperties.class) class SkipPatternConfiguration { + private static final Log log = LogFactory.getLog(SkipPatternConfiguration.class); + @Bean @ConditionalOnMissingBean SkipPatternProvider sleuthSkipPatternProvider(@Nullable List patterns) { @@ -84,8 +89,9 @@ class SkipPatternConfiguration { return () -> result; } catch (BeanCreationException e) { - // Most likely, there is an actuator endpoint that indirectly references an - // instrumented HTTP client. + log.warn( + "Most likely, there is an actuator endpoint that indirectly references an instrumented HTTP client. An exception was thrown during bean initialization. Will ignore that exception", + e); return () -> consolidateSkipPatterns(patterns); } } diff --git a/spring-cloud-sleuth-autoconfigure/src/test/java/org/springframework/cloud/sleuth/autoconfig/instrument/web/SkipPatternConfigurationTests.java b/spring-cloud-sleuth-autoconfigure/src/test/java/org/springframework/cloud/sleuth/autoconfig/instrument/web/SkipPatternConfigurationTests.java new file mode 100644 index 000000000..6ae8639b1 --- /dev/null +++ b/spring-cloud-sleuth-autoconfigure/src/test/java/org/springframework/cloud/sleuth/autoconfig/instrument/web/SkipPatternConfigurationTests.java @@ -0,0 +1,46 @@ +/* + * Copyright 2013-2021 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.springframework.cloud.sleuth.autoconfig.instrument.web; + +import java.util.Collections; + +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; + +import org.springframework.beans.factory.BeanCreationException; +import org.springframework.boot.test.system.CapturedOutput; +import org.springframework.boot.test.system.OutputCaptureExtension; + +import static org.assertj.core.api.BDDAssertions.then; +import static org.assertj.core.api.BDDAssertions.thenNoException; + +@ExtendWith(OutputCaptureExtension.class) +class SkipPatternConfigurationTests { + + @Test + void should_print_an_exception_when_bean_creation_exception_thrown(CapturedOutput output) { + SkipPatternConfiguration configuration = new SkipPatternConfiguration(); + + thenNoException().isThrownBy(() -> configuration.sleuthSkipPatternProvider(Collections.singletonList(() -> { + throw new BeanCreationException("BOOM!"); + }))); + then(output.toString()).contains( + "Most likely, there is an actuator endpoint that indirectly references an instrumented HTTP client") + .contains("org.springframework.beans.factory.BeanCreationException: BOOM!"); + } + +}