Spring/spring-boot
Spring/spring-boot
1
0
Fork 0
mirror of https://github.com/spring-projects/spring-boot.git synced 2024-08-29 03:06:45 +08:00
Code Issues Packages Projects Releases Wiki Activity

Handle request mappings with regular expressions in MetricsFilter

Browse Source 
Closes gh-7503
This commit is contained in:
Andy Wilkinson 2016-12-01 13:22:55 +00:00
parent d9b8fc960c
commit 356edc725c
2 changed files with 65 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/MetricsFilter.java
View File

@ -20,7 +20,6 @@ import java.io.IOException;
import java.util.Collections;
import java.util.LinkedHashSet;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import javax.servlet.FilterChain;
@ -67,7 +66,7 @@ final class MetricsFilter extends OncePerRequestFilter {
static {
Set<PatternReplacer> replacements = new LinkedHashSet<PatternReplacer>();
replacements.add(new PatternReplacer("[{}]", 0, "-"));
replacements.add(new PatternReplacer("\\{(.+?)(?::.+)?\\}", 0, "-$1-"));
replacements.add(new PatternReplacer("**", Pattern.LITERAL, "-star-star-"));
replacements.add(new PatternReplacer("*", Pattern.LITERAL, "-star-"));
replacements.add(new PatternReplacer("/-", Pattern.LITERAL, "/"));
@ -140,13 +139,13 @@ final class MetricsFilter extends OncePerRequestFilter {
private void recordMetrics(HttpServletRequest request, String path, int status,
long time) {
String suffix = getFinalStatus(request, path, status);
String suffix = determineMetricNameSuffix(request, path, status);
submitMetrics(MetricsFilterSubmission.MERGED, request, status, time, suffix);
submitMetrics(MetricsFilterSubmission.PER_HTTP_METHOD, request, status, time,
suffix);
}
private String getFinalStatus(HttpServletRequest request, String path, int status) {
private String determineMetricNameSuffix(HttpServletRequest request, String path, int status) {
Object bestMatchingPattern = request
.getAttribute(HandlerMapping.BEST_MATCHING_PATTERN_ATTRIBUTE);
if (bestMatchingPattern != null) {
@ -242,8 +241,7 @@ final class MetricsFilter extends OncePerRequestFilter {
}
public String apply(String input) {
return this.pattern.matcher(input)
.replaceAll(Matcher.quoteReplacement(this.replacement));
return this.pattern.matcher(input).replaceAll(this.replacement);
}
}

61
spring-boot-actuator/src/test/java/org/springframework/boot/actuate/autoconfigure/MetricFilterAutoConfigurationTests.java
View File

@ -129,6 +129,51 @@ public class MetricFilterAutoConfigurationTests {
context.close();
}
@Test
public void recordsHttpInteractionsWithRegexTemplateVariable() throws Exception {
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(
Config.class, MetricFilterAutoConfiguration.class);
Filter filter = context.getBean(Filter.class);
MockMvc mvc = MockMvcBuilders.standaloneSetup(new MetricFilterTestController())
.addFilter(filter).build();
mvc.perform(get("/templateVarRegexTest/foo")).andExpect(status().isOk());
verify(context.getBean(CounterService.class))
.increment("status.200.templateVarRegexTest.someVariable");
verify(context.getBean(GaugeService.class))
.submit(eq("response.templateVarRegexTest.someVariable"), anyDouble());
context.close();
}
@Test
public void recordsHttpInteractionsWithWilcardMapping() throws Exception {
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(
Config.class, MetricFilterAutoConfiguration.class);
Filter filter = context.getBean(Filter.class);
MockMvc mvc = MockMvcBuilders.standaloneSetup(new MetricFilterTestController())
.addFilter(filter).build();
mvc.perform(get("/wildcardMapping/foo")).andExpect(status().isOk());
verify(context.getBean(CounterService.class))
.increment("status.200.wildcardMapping.star");
verify(context.getBean(GaugeService.class))
.submit(eq("response.wildcardMapping.star"), anyDouble());
context.close();
}
@Test
public void recordsHttpInteractionsWithDoubleWildcardMapping() throws Exception {
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(
Config.class, MetricFilterAutoConfiguration.class);
Filter filter = context.getBean(Filter.class);
MockMvc mvc = MockMvcBuilders.standaloneSetup(new MetricFilterTestController())
.addFilter(filter).build();
mvc.perform(get("/doubleWildcardMapping/foo/bar/baz")).andExpect(status().isOk());
verify(context.getBean(CounterService.class))
.increment("status.200.doubleWildcardMapping.star-star.baz");
verify(context.getBean(GaugeService.class))
.submit(eq("response.doubleWildcardMapping.star-star.baz"), anyDouble());
context.close();
}
@Test
public void recordsKnown404HttpInteractionsAsSingleMetricWithPathAndTemplateVariable()
throws Exception {
@ -429,6 +474,22 @@ public class MetricFilterAutoConfigurationTests {
return someVariable;
}
@RequestMapping("wildcardMapping/*")
public String testWildcardMapping() {
return "wildcard";
}
@RequestMapping("doubleWildcardMapping/**/baz")
public String testDoubleWildcardMapping() {
return "doubleWildcard";
}
@RequestMapping("templateVarRegexTest/{someVariable:[a-z]+}")
public String testTemplateVariableRegexResolution(
@PathVariable String someVariable) {
return someVariable;
}
@RequestMapping("knownPath/{someVariable}")
@ResponseStatus(HttpStatus.NOT_FOUND)
@ResponseBody