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

Add metric description and base unit to metrics endpoint 

See gh-13813
This commit is contained in:
Johannes Edmeier 2018-07-18 21:46:31 +02:00 committed by Stephane Nicoll
parent a7b13dbe45
commit ab1f8cf77b
2 changed files with 21 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/MetricsEndpointDocumentationTests.java
View File

@ -54,6 +54,8 @@ public class MetricsEndpointDocumentationTests extends MockMvcEndpointDocumentat
.andExpect(status().isOk()) .andExpect(status().isOk())
.andDo(document("metrics/metric", responseFields( .andDo(document("metrics/metric", responseFields(
fieldWithPath("name").description("Name of the metric"), fieldWithPath("name").description("Name of the metric"),
fieldWithPath("description").description("Description of the metric"),
fieldWithPath("baseUnit").description("Base unit of the metric"),
fieldWithPath("measurements") fieldWithPath("measurements")
.description("Measurements of the metric"), .description("Measurements of the metric"),
fieldWithPath("measurements[].statistic") fieldWithPath("measurements[].statistic")

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

@ -91,7 +91,9 @@ public class MetricsEndpoint {
Map<Statistic, Double> samples = getSamples(meters); Map<Statistic, Double> samples = getSamples(meters);
Map<String, Set<String>> availableTags = getAvailableTags(meters); Map<String, Set<String>> availableTags = getAvailableTags(meters);
tags.forEach((t) -> availableTags.remove(t.getKey())); tags.forEach((t) -> availableTags.remove(t.getKey()));
return new MetricResponse(requiredMetricName, asList(samples, Sample::new), Meter.Id meterId = meters.get(0).getId();
return new MetricResponse(requiredMetricName, meterId.getDescription(),
meterId.getBaseUnit(), asList(samples, Sample::new),
asList(availableTags, AvailableTag::new)); asList(availableTags, AvailableTag::new));
} }
@ -183,13 +185,19 @@ public class MetricsEndpoint {
private final String name; private final String name;
private final String description;
private final String baseUnit;
private final List<Sample> measurements; private final List<Sample> measurements;
private final List<AvailableTag> availableTags; private final List<AvailableTag> availableTags;
MetricResponse(String name, List<Sample> measurements, MetricResponse(String name, String description, String baseUnit,
List<AvailableTag> availableTags) { List<Sample> measurements, List<AvailableTag> availableTags) {
this.name = name; this.name = name;
this.description = description;
this.baseUnit = baseUnit;
this.measurements = measurements; this.measurements = measurements;
this.availableTags = availableTags; this.availableTags = availableTags;
} }
@ -198,6 +206,14 @@ public class MetricsEndpoint {
return this.name; return this.name;
} }
public String getDescription() {
return this.description;
}
public String getBaseUnit() {
return this.baseUnit;
}
public List<Sample> getMeasurements() { public List<Sample> getMeasurements() {
return this.measurements; return this.measurements;
} }