From cf018d19b321fccb760cdf7fb89ce47bd50dbd63 Mon Sep 17 00:00:00 2001 From: Brian Brazil Date: Thu, 21 Jan 2021 09:22:24 +0000 Subject: [PATCH] Address code review comments. Signed-off-by: Brian Brazil --- .../src/main/java/io/prometheus/client/Counter.java | 6 ++++++ .../src/main/java/io/prometheus/client/SimpleCollector.java | 2 +- .../client/cache/caffeine/CacheMetricsCollectorTest.java | 1 - 3 files changed, 7 insertions(+), 2 deletions(-) diff --git a/simpleclient/src/main/java/io/prometheus/client/Counter.java b/simpleclient/src/main/java/io/prometheus/client/Counter.java index 900812b16..bcff43eb2 100644 --- a/simpleclient/src/main/java/io/prometheus/client/Counter.java +++ b/simpleclient/src/main/java/io/prometheus/client/Counter.java @@ -64,6 +64,12 @@ * * 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 _total on the metric name, it will be + * removed. When exposing the time series for counter value, a + * _total suffix will be added. This is for compatibility between + * OpenMetrics and the Prometheus text format, as OpenMetrics requires the + * _total suffix. */ public class Counter extends SimpleCollector 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 index 6a0183961..a228c6851 100644 --- 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 index 75f198d1b..65429f337 100644 --- 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);