Clarify PublicMetrics (uniqueness of metric names)

See spring-projectsgh-6404
hyk001 · Jan 25, 2017 · 98a4c72 · 98a4c72
1 parent 5ee4674
commit 98a4c72
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/...-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/PublicMetrics.java b/...-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/PublicMetrics.java
@@ -22,9 +22,12 @@
 
 /**
  * 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 {