Skip only Actuator endpoints when context path set (#1150)

Previously, all endpoints under the set context path would be skipped. Instead, this skips only Actuator endpoints under the set context-path.

Resolves #1146

Author: shakuzen

spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/instrument/web/TraceWebAutoConfiguration.java

@@ -23,6 +23,7 @@
 
 import brave.Tracing;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties;
 import org.springframework.boot.actuate.autoconfigure.web.server.ManagementServerProperties;
 import org.springframework.boot.autoconfigure.AutoConfigureAfter;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
@@ -92,27 +93,31 @@ public SingleSkipPattern skipPatternForManagementServerProperties(
 	}
 
 	@Configuration
-	@ConditionalOnClass(ServerProperties.class)
+	@ConditionalOnClass({ServerProperties.class, WebEndpointProperties.class})
 	protected static class ServerSkipPatternProviderConfig {
 
 		/**
-		 * Sets or appends {@link ServerProperties#getServlet()#getContextPath()} to the
-		 * skip pattern. If neither is available then sets the default one
+		 * Uses {@link ServerProperties#getServlet()#getContextPath()} and
+		 * {@link WebEndpointProperties#getBasePath()} to skip Actuator endpoints.
 		 */
 		static Optional<Pattern> getPatternForServerProperties(
-				ServerProperties serverProperties) {
+				ServerProperties serverProperties,
+				WebEndpointProperties webEndpointProperties) {
 			String contextPath = serverProperties.getServlet().getContextPath();
 			if (StringUtils.hasText(contextPath)) {
-				return Optional.of(Pattern.compile(contextPath + ".*"));
+				return Optional.of(Pattern.compile(
+						contextPath + webEndpointProperties.getBasePath() + ".*"));
 			}
 			return Optional.empty();
 		}
 
 		@Bean
-		@ConditionalOnBean(ServerProperties.class)
+		@ConditionalOnBean({ ServerProperties.class, WebEndpointProperties.class })
 		public SingleSkipPattern skipPatternForServerProperties(
-				final ServerProperties serverProperties) {
-			return () -> getPatternForServerProperties(serverProperties);
+				final ServerProperties serverProperties,
+				final WebEndpointProperties webEndpointProperties) {
+			return () -> getPatternForServerProperties(serverProperties,
+					webEndpointProperties);
 		}
 
 	}

spring-cloud-sleuth-core/src/test/java/org/springframework/cloud/sleuth/instrument/web/SkipPatternProviderConfigTest.java

@@ -21,6 +21,8 @@
 import java.util.regex.Pattern;
 
 import org.junit.Test;
+
+import org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties;
 import org.springframework.boot.actuate.autoconfigure.web.server.ManagementServerProperties;
 import org.springframework.boot.autoconfigure.web.ServerProperties;
 
@@ -80,7 +82,9 @@ public void should_return_management_context_with_context_path() throws Exceptio
 	public void should_return_empty_when_server_props_have_no_context_path()
 			throws Exception {
 		Optional<Pattern> pattern = new TraceWebAutoConfiguration.ServerSkipPatternProviderConfig()
-				.skipPatternForServerProperties(new ServerProperties()).skipPattern();
+				.skipPatternForServerProperties(new ServerProperties(),
+						new WebEndpointProperties())
+				.skipPattern();
 
 		then(pattern).isEmpty();
 	}
@@ -91,10 +95,11 @@ public void should_return_server_props_with_context_path() throws Exception {
 		properties.getServlet().setContextPath("foo");
 
 		Optional<Pattern> pattern = new TraceWebAutoConfiguration.ServerSkipPatternProviderConfig()
-				.skipPatternForServerProperties(properties).skipPattern();
+				.skipPatternForServerProperties(properties, new WebEndpointProperties())
+				.skipPattern();
 
 		then(pattern).isNotEmpty();
-		then(pattern.get().pattern()).isEqualTo("foo.*");
+		then(pattern.get().pattern()).isEqualTo("foo/actuator.*");
 	}
 
 	@Test

spring-cloud-sleuth-core/src/test/java/org/springframework/cloud/sleuth/instrument/web/issues/issue971/DemoSleuthSkipApplicationTests.java

@@ -30,6 +30,8 @@
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.test.context.junit4.SpringRunner;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RestController;
 import org.springframework.web.client.RestTemplate;
 
 import static org.assertj.core.api.BDDAssertions.then;
@@ -60,11 +62,26 @@ public void should_not_sample_skipped_endpoint_with_context_path() {
 		then(this.accumulator.getSpans()).hasSize(0);
 	}
 
+	@Test
+	public void should_sample_non_actuator_endpoint_with_context_path() {
+		new RestTemplate().getForObject(
+				"http://localhost:" + this.port + "/context-path/something",
+				String.class);
+
+		then(this.tracer.currentSpan()).isNull();
+		then(this.accumulator.getSpans()).hasSize(1);
+	}
+
 	@EnableAutoConfiguration(exclude = RabbitAutoConfiguration.class)
 	@Configuration
 	@DisableSecurity
+	@RestController
 	public static class Config {
 
+		@GetMapping("something")
+		void doNothing() {
+		}
+
 		@Bean
 		ArrayListSpanReporter reporter() {
 			return new ArrayListSpanReporter();