Address code review comments.

brian-brazil · brian-brazil · commit cf018d19b321 · 2021-01-22T01:07:06.000Z
Signed-off-by: Brian Brazil &lt;brian.brazil@robustperception.io&gt;
diff --git a/simpleclient/src/main/java/io/prometheus/client/Counter.java b/simpleclient/src/main/java/io/prometheus/client/Counter.java
@@ -64,6 +64,12 @@
  * </pre>
  * These can be aggregated and processed together much more easily in the Prometheus
  * server than individual metrics for each labelset.
+ *
+ * If there is a suffix of <code>_total</code> on the metric name, it will be
+ * removed. When exposing the time series for counter value, a
+ * <code>_total</code> suffix will be added. This is for compatibility between
+ * OpenMetrics and the Prometheus text format, as OpenMetrics requires the
+ * <code>_total</code> suffix.
  */
 public class Counter extends SimpleCollector<Counter.Child> implements Collector.Describable {
 
diff --git a/simpleclient/src/main/java/io/prometheus/client/SimpleCollector.java b/simpleclient/src/main/java/io/prometheus/client/SimpleCollector.java
@@ -216,7 +216,7 @@ public B namespace(String namespace) {
       return (B)this;
     }
     /**
-     * Set the uit of the metric. Required.
+     * Set the unit of the metric. Required.
      */
     public B unit(String unit) {
       this.unit = unit;
diff --git a/simpleclient_caffeine/src/test/java/io/prometheus/client/cache/caffeine/CacheMetricsCollectorTest.java b/simpleclient_caffeine/src/test/java/io/prometheus/client/cache/caffeine/CacheMetricsCollectorTest.java
@@ -70,7 +70,6 @@ public void loadingCacheExposesMetricsForLoadsAndExceptions() throws Exception {
         }
         cache.get("user3");
 
-
         assertMetric(registry, "caffeine_cache_hit_total", "loadingusers", 1.0);
         assertMetric(registry, "caffeine_cache_miss_total", "loadingusers", 3.0);
 

Original file line number	Diff line number	Diff line change
`@@ -216,7 +216,7 @@ public B namespace(String namespace) {`
`216`	`216`	`return (B)this;`
`217`	`217`	`}`
`218`	`218`	`/**`
`219`		`- * Set the uit of the metric. Required.`
	`219`	`+ * Set the unit of the metric. Required.`
`220`	`220`	`*/`
`221`	`221`	`public B unit(String unit) {`
`222`	`222`	`this.unit = unit;`
Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,6 @@ public void loadingCacheExposesMetricsForLoadsAndExceptions() throws Exception {`
`70`	`70`	`}`
`71`	`71`	`cache.get("user3");`
`72`	`72`
`73`		`-`
`74`	`73`	`assertMetric(registry, "caffeine_cache_hit_total", "loadingusers", 1.0);`
`75`	`74`	`assertMetric(registry, "caffeine_cache_miss_total", "loadingusers", 3.0);`
`76`	`75`