From ab1f8cf77bfd9945f6202b25e661426791049455 Mon Sep 17 00:00:00 2001
From: Johannes Edmeier <johannes.edmeier@codecentric.de>
Date: Wed, 18 Jul 2018 21:46:31 +0200
Subject: [PATCH] Add metric description and base unit to metrics endpoint

See gh-13813
---
 .../MetricsEndpointDocumentationTests.java    |  2 ++
 .../boot/actuate/metrics/MetricsEndpoint.java | 22 ++++++++++++++++---
 2 files changed, 21 insertions(+), 3 deletions(-)

diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/MetricsEndpointDocumentationTests.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/MetricsEndpointDocumentationTests.java
index 604e052db7d..5e57f74e6d7 100644
--- a/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/MetricsEndpointDocumentationTests.java
+++ b/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/MetricsEndpointDocumentationTests.java
@@ -54,6 +54,8 @@ public class MetricsEndpointDocumentationTests extends MockMvcEndpointDocumentat
 				.andExpect(status().isOk())
 				.andDo(document("metrics/metric", responseFields(
 						fieldWithPath("name").description("Name of the metric"),
+						fieldWithPath("description").description("Description of the metric"),
+						fieldWithPath("baseUnit").description("Base unit of the metric"),
 						fieldWithPath("measurements")
 								.description("Measurements of the metric"),
 						fieldWithPath("measurements[].statistic")
diff --git a/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/MetricsEndpoint.java b/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/MetricsEndpoint.java
index c7055c3294d..a80f1ae3ea9 100644
--- a/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/MetricsEndpoint.java
+++ b/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/MetricsEndpoint.java
@@ -91,7 +91,9 @@ public class MetricsEndpoint {
 		Map<Statistic, Double> samples = getSamples(meters);
 		Map<String, Set<String>> availableTags = getAvailableTags(meters);
 		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));
 	}
 
@@ -183,13 +185,19 @@ public class MetricsEndpoint {
 
 		private final String name;
 
+		private final String description;
+
+		private final String baseUnit;
+
 		private final List<Sample> measurements;
 
 		private final List<AvailableTag> availableTags;
 
-		MetricResponse(String name, List<Sample> measurements,
-				List<AvailableTag> availableTags) {
+		MetricResponse(String name, String description, String baseUnit,
+				List<Sample> measurements, List<AvailableTag> availableTags) {
 			this.name = name;
+			this.description = description;
+			this.baseUnit = baseUnit;
 			this.measurements = measurements;
 			this.availableTags = availableTags;
 		}
@@ -198,6 +206,14 @@ public class MetricsEndpoint {
 			return this.name;
 		}
 
+		public String getDescription() {
+			return this.description;
+		}
+
+		public String getBaseUnit() {
+			return this.baseUnit;
+		}
+
 		public List<Sample> getMeasurements() {
 			return this.measurements;
 		}