From 98a4c72c504942340a53a91365c4549be40441d4 Mon Sep 17 00:00:00 2001
From: Dave Syer <dsyer@pivotal.io>
Date: Wed, 25 Jan 2017 09:40:10 +0000
Subject: [PATCH] Clarify PublicMetrics (uniqueness of metric names)

See gh-6404
---
 .../springframework/boot/actuate/endpoint/PublicMetrics.java | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/PublicMetrics.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/PublicMetrics.java
index bc3ea2861c..cdcde530c5 100644
--- a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/PublicMetrics.java
+++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/PublicMetrics.java
@@ -22,9 +22,12 @@ import org.springframework.boot.actuate.metrics.Metric;
 
 /**
  * Interface to expose specific {@link Metric}s via a {@link MetricsEndpoint}.
+ * Implementations should take care that the metrics they provide have unique names in the
+ * application context, but they shouldn't have to care about global uniqueness in the JVM
+ * or across a distributed system.
  *
  * @author Dave Syer
- * @see SystemPublicMetrics
+ * @see SystemPublicMetrics SystemPublicMetrics for an example implementation
  */
 public interface PublicMetrics {