root
/
spring-boot
mirror of https://github.com/spring-projects/spring-boot.git
1
0
Fork 0
Code Issues Actions 9 Packages Projects Releases Wiki Activity

Use InvalidEndpointRequestException for MetricsEndpoint 

Closes gh-14291
This commit is contained in:
Johnny Lim 2018-09-04 00:26:36 +09:00 committed by Stephane Nicoll
parent 72ebfb0332
commit 3eef927499
2 changed files with 19 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/MetricsEndpoint.java
View File

@ -34,11 +34,11 @@ import io.micrometer.core.instrument.Statistic;
import io.micrometer.core.instrument.Tag; import io.micrometer.core.instrument.Tag;
import io.micrometer.core.instrument.composite.CompositeMeterRegistry; import io.micrometer.core.instrument.composite.CompositeMeterRegistry;
import org.springframework.boot.actuate.endpoint.InvalidEndpointRequestException;
import org.springframework.boot.actuate.endpoint.annotation.Endpoint; import org.springframework.boot.actuate.endpoint.annotation.Endpoint;
import org.springframework.boot.actuate.endpoint.annotation.ReadOperation; import org.springframework.boot.actuate.endpoint.annotation.ReadOperation;
import org.springframework.boot.actuate.endpoint.annotation.Selector; import org.springframework.boot.actuate.endpoint.annotation.Selector;
import org.springframework.lang.Nullable; import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
/** /**
* An {@link Endpoint} for exposing the metrics held by a {@link MeterRegistry}. * An {@link Endpoint} for exposing the metrics held by a {@link MeterRegistry}.
@ -80,8 +80,6 @@ public class MetricsEndpoint {
@ReadOperation @ReadOperation
public MetricResponse metric(@Selector String requiredMetricName, public MetricResponse metric(@Selector String requiredMetricName,
@Nullable List<String> tag) { @Nullable List<String> tag) {
Assert.isTrue(tag == null || tag.stream().allMatch((t) -> t.contains(":")),
"Each tag parameter must be in the form key:value");
List<Tag> tags = parseTags(tag); List<Tag> tags = parseTags(tag);
List<Meter> meters = new ArrayList<>(); List<Meter> meters = new ArrayList<>();
collectMeters(meters, this.registry, requiredMetricName, tags); collectMeters(meters, this.registry, requiredMetricName, tags);
@ -106,6 +104,11 @@ public class MetricsEndpoint {
private Tag parseTag(String tag) { private Tag parseTag(String tag) {
String[] parts = tag.split(":", 2); String[] parts = tag.split(":", 2);
if (parts.length != 2) {
throw new InvalidEndpointRequestException(
"Each tag parameter must be in the form 'key:value' but was: " + tag,
"Each tag parameter must be in the form 'key:value'");
}
return Tag.of(parts[0], parts[1]); return Tag.of(parts[0], parts[1]);
} }

13
spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/metrics/MetricsEndpointTests.java
View File

@ -27,7 +27,11 @@ import io.micrometer.core.instrument.Statistic;
import io.micrometer.core.instrument.composite.CompositeMeterRegistry; import io.micrometer.core.instrument.composite.CompositeMeterRegistry;
import io.micrometer.core.instrument.simple.SimpleConfig; import io.micrometer.core.instrument.simple.SimpleConfig;
import io.micrometer.core.instrument.simple.SimpleMeterRegistry; import io.micrometer.core.instrument.simple.SimpleMeterRegistry;
import org.junit.Rule;
import org.junit.Test; import org.junit.Test;
import org.junit.rules.ExpectedException;
import org.springframework.boot.actuate.endpoint.InvalidEndpointRequestException;
import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThat;
@ -39,6 +43,9 @@ import static org.assertj.core.api.Assertions.assertThat;
*/ */
public class MetricsEndpointTests { public class MetricsEndpointTests {
@Rule
public ExpectedException thrown = ExpectedException.none();
private final MeterRegistry registry = new SimpleMeterRegistry(SimpleConfig.DEFAULT, private final MeterRegistry registry = new SimpleMeterRegistry(SimpleConfig.DEFAULT,
new MockClock()); new MockClock());
@ -109,6 +116,12 @@ public class MetricsEndpointTests {
assertThat(getCount(response)).hasValue(2.0); assertThat(getCount(response)).hasValue(2.0);
} }
@Test
public void metricWithInvalidTag() {
this.thrown.expect(InvalidEndpointRequestException.class);
this.endpoint.metric("counter", Collections.singletonList("key"));
}
@Test @Test
public void metricPresentInOneRegistryOfACompositeAndNotAnother() { public void metricPresentInOneRegistryOfACompositeAndNotAnother() {
CompositeMeterRegistry composite = new CompositeMeterRegistry(); CompositeMeterRegistry composite = new CompositeMeterRegistry();