forked from spring-projects/spring-boot
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add regex support to /metrics and /env endpoints
Update MetricsMvcEndpoint and EnvironmentMvcEndpoint to support regex filter of names. See spring-projectsgh-2252 Add it
- Loading branch information
Showing
5 changed files
with
266 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
98 changes: 98 additions & 0 deletions
98
...tuator/src/main/java/org/springframework/boot/actuate/endpoint/mvc/NamePatternFilter.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| /* | ||
| * Copyright 2012-2015 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 | ||
| * | ||
| * http://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.boot.actuate.endpoint.mvc; | ||
|
|
||
| import java.util.LinkedHashMap; | ||
| import java.util.Map; | ||
| import java.util.regex.Pattern; | ||
|
|
||
| /** | ||
| * Utility class that can be used to filter source data using a name regular expression. | ||
| * Detects if the name is classic "single value" key or a regular expression. Subclasses | ||
| * must provide implementations of {@link #getValue(Object, String)} and | ||
| * {@link #getNames(Object, NameCallback)}. | ||
| * | ||
| * @author Phillip Webb | ||
| * @author Sergei Egorov | ||
| * @param <T> The source data type | ||
| * @since 1.3.0 | ||
| */ | ||
| abstract class NamePatternFilter<T> { | ||
|
|
||
| private static final String[] REGEX_PARTS = { "*", "$", "^", "+" }; | ||
|
|
||
| private final T source; | ||
|
|
||
| public NamePatternFilter(T source) { | ||
| this.source = source; | ||
| } | ||
|
|
||
| public Object getResults(String name) { | ||
| if (!isRegex(name)) { | ||
| return getValue(this.source, name); | ||
| } | ||
| Pattern pattern = Pattern.compile(name); | ||
| ResultCollectingNameCallback resultCollector = new ResultCollectingNameCallback( | ||
| pattern); | ||
| getNames(this.source, resultCollector); | ||
| return resultCollector.getResults(); | ||
|
|
||
| } | ||
|
|
||
| private boolean isRegex(String name) { | ||
| for (String part : REGEX_PARTS) { | ||
| if (name.contains(part)) { | ||
| return true; | ||
| } | ||
| } | ||
| return false; | ||
| } | ||
|
|
||
| protected abstract void getNames(T source, NameCallback callback); | ||
|
|
||
| protected abstract Object getValue(T source, String name); | ||
|
|
||
| protected static interface NameCallback { | ||
|
|
||
| void addName(String name); | ||
|
|
||
| } | ||
|
|
||
| private class ResultCollectingNameCallback implements NameCallback { | ||
|
|
||
| private final Pattern pattern; | ||
|
|
||
| private final Map<String, Object> results = new LinkedHashMap<String, Object>(); | ||
|
|
||
| public ResultCollectingNameCallback(Pattern pattern) { | ||
| this.pattern = pattern; | ||
| } | ||
|
|
||
| @Override | ||
| public void addName(String name) { | ||
| if (this.pattern.matcher(name).matches()) { | ||
| this.results.put(name, getValue(NamePatternFilter.this.source, name)); | ||
| } | ||
| } | ||
|
|
||
| public Map<String, Object> getResults() { | ||
| return this.results; | ||
| } | ||
|
|
||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
78 changes: 78 additions & 0 deletions
78
...r/src/test/java/org/springframework/boot/actuate/endpoint/mvc/NamePatternFilterTests.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| /* | ||
| * Copyright 2012-2015 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 | ||
| * | ||
| * http://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.boot.actuate.endpoint.mvc; | ||
|
|
||
| import java.util.Map; | ||
|
|
||
| import org.junit.Test; | ||
|
|
||
| import static org.hamcrest.Matchers.equalTo; | ||
| import static org.junit.Assert.assertThat; | ||
|
|
||
| /** | ||
| * Tests for {@link NamePatternFilter}. | ||
| * | ||
| * @author Phillip Webb | ||
| */ | ||
| public class NamePatternFilterTests { | ||
|
|
||
| @Test | ||
| public void nonRegex() throws Exception { | ||
| MockNamePatternFilter filter = new MockNamePatternFilter(); | ||
| assertThat(filter.getResults("not.a.regex"), equalTo((Object) "not.a.regex")); | ||
| assertThat(filter.isGetNamesCalled(), equalTo(false)); | ||
| } | ||
|
|
||
| @Test | ||
| @SuppressWarnings("unchecked") | ||
| public void regex() throws Exception { | ||
| MockNamePatternFilter filter = new MockNamePatternFilter(); | ||
| Map<String, Object> results = (Map<String, Object>) filter.getResults("fo.*"); | ||
| assertThat(results.get("foo"), equalTo((Object) "foo")); | ||
| assertThat(results.get("fool"), equalTo((Object) "fool")); | ||
| assertThat(filter.isGetNamesCalled(), equalTo(true)); | ||
|
|
||
| } | ||
|
|
||
| private static class MockNamePatternFilter extends NamePatternFilter<Object> { | ||
|
|
||
| public MockNamePatternFilter() { | ||
| super(null); | ||
| } | ||
|
|
||
| private boolean getNamesCalled; | ||
|
|
||
| @Override | ||
| protected Object getValue(Object source, String name) { | ||
| return name; | ||
| } | ||
|
|
||
| @Override | ||
| protected void getNames(Object source, NameCallback callback) { | ||
| this.getNamesCalled = true; | ||
| callback.addName("foo"); | ||
| callback.addName("fool"); | ||
| callback.addName("fume"); | ||
| } | ||
|
|
||
| public boolean isGetNamesCalled() { | ||
| return this.getNamesCalled; | ||
| } | ||
|
|
||
| } | ||
|
|
||
| } |