Issue ReactiveX#806: Switch resilience4j.retry.calls from Gauge to Co…

…unter (ReactiveX#812) In fact under the hood it is a change from Gauge to FunctionCounter which better represents this metric as it constantly grows.
jihoonson · Jan 20, 2020 · bb72046 · bb72046
1 parent 097e9c9
commit bb72046
Show file tree

Hide file tree

Showing 14 changed files with 121 additions and 130 deletions.
diff --git a/...crometer/src/main/java/io/github/resilience4j/micrometer/tagged/AbstractRetryMetrics.java b/...crometer/src/main/java/io/github/resilience4j/micrometer/tagged/AbstractRetryMetrics.java
@@ -17,7 +17,7 @@
 package io.github.resilience4j.micrometer.tagged;
 
 import io.github.resilience4j.retry.Retry;
-import io.micrometer.core.instrument.Gauge;
+import io.micrometer.core.instrument.FunctionCounter;
 import io.micrometer.core.instrument.Meter;
 import io.micrometer.core.instrument.MeterRegistry;
 import io.micrometer.core.instrument.Tag;
@@ -44,28 +44,28 @@ protected void addMetrics(MeterRegistry meterRegistry, Retry retry) {
 
     private void registerMetrics(MeterRegistry meterRegistry, Retry retry, List<Tag> customTags) {
         Set<Meter.Id> idSet = new HashSet<>();
-        idSet.add(Gauge.builder(names.getCallsMetricName(), retry,
+        idSet.add(FunctionCounter.builder(names.getCallsMetricName(), retry,
             rt -> rt.getMetrics().getNumberOfSuccessfulCallsWithoutRetryAttempt())
             .description("The number of successful calls without a retry attempt")
             .tag(TagNames.NAME, retry.getName())
             .tag(TagNames.KIND, "successful_without_retry")
             .tags(customTags)
             .register(meterRegistry).getId());
-        idSet.add(Gauge.builder(names.getCallsMetricName(), retry,
+        idSet.add(FunctionCounter.builder(names.getCallsMetricName(), retry,
             rt -> rt.getMetrics().getNumberOfSuccessfulCallsWithRetryAttempt())
             .description("The number of successful calls after a retry attempt")
             .tag(TagNames.NAME, retry.getName())
             .tag(TagNames.KIND, "successful_with_retry")
             .tags(customTags)
             .register(meterRegistry).getId());
-        idSet.add(Gauge.builder(names.getCallsMetricName(), retry,
+        idSet.add(FunctionCounter.builder(names.getCallsMetricName(), retry,
             rt -> rt.getMetrics().getNumberOfFailedCallsWithoutRetryAttempt())
             .description("The number of failed calls without a retry attempt")
             .tag(TagNames.NAME, retry.getName())
             .tag(TagNames.KIND, "failed_without_retry")
             .tags(customTags)
             .register(meterRegistry).getId());
-        idSet.add(Gauge.builder(names.getCallsMetricName(), retry,
+        idSet.add(FunctionCounter.builder(names.getCallsMetricName(), retry,
             rt -> rt.getMetrics().getNumberOfFailedCallsWithRetryAttempt())
             .description("The number of failed calls after a retry attempt")
             .tag(TagNames.NAME, retry.getName())

diff --git a/...-micrometer/src/test/java/io/github/resilience4j/micrometer/tagged/MetricsTestHelper.java b/...-micrometer/src/test/java/io/github/resilience4j/micrometer/tagged/MetricsTestHelper.java
@@ -15,47 +15,23 @@
  */
 package io.github.resilience4j.micrometer.tagged;
 
-import io.micrometer.core.instrument.Counter;
-import io.micrometer.core.instrument.Gauge;
-import io.micrometer.core.instrument.Timer;
+import io.micrometer.core.instrument.Meter;
 
 import java.util.Collection;
 import java.util.Optional;
 
 final class MetricsTestHelper {
 
-    static Optional<Gauge> findGaugeByKindAndNameTags(Collection<Gauge> gauges, String kind,
+    static <T extends Meter> Optional<T> findMeterByKindAndNameTags(Collection<T> meters, String kind,
         String name) {
-        return gauges.stream()
+        return meters.stream()
             .filter(g -> kind.equals(g.getId().getTag(TagNames.KIND)))
             .filter(g -> name.equals(g.getId().getTag(TagNames.NAME)))
             .findAny();
     }
 
-    static Optional<Timer> findTimerByKindAndNameTags(Collection<Timer> timers, String kind,
-        String name) {
-        return timers.stream()
-            .filter(g -> kind.equals(g.getId().getTag(TagNames.KIND)))
-            .filter(g -> name.equals(g.getId().getTag(TagNames.NAME)))
-            .findAny();
-    }
-
-    static Optional<Counter> findCounterByKindAndNameTags(Collection<Counter> counters, String kind,
-        String name) {
-        return counters.stream()
-            .filter(g -> kind.equals(g.getId().getTag(TagNames.KIND)))
-            .filter(g -> name.equals(g.getId().getTag(TagNames.NAME)))
-            .findAny();
-    }
-
-    static Optional<Counter> findCounterByNamesTag(Collection<Counter> gauges, String name) {
-        return gauges.stream()
-            .filter(g -> name.equals(g.getId().getTag(TagNames.NAME)))
-            .findAny();
-    }
-
-    static Optional<Gauge> findGaugeByNamesTag(Collection<Gauge> gauges, String name) {
-        return gauges.stream()
+    static <T extends Meter> Optional<T> findMeterByNamesTag(Collection<T> meters, String name) {
+        return meters.stream()
             .filter(g -> name.equals(g.getId().getTag(TagNames.NAME)))
             .findAny();
     }

diff --git a/...est/java/io/github/resilience4j/micrometer/tagged/TaggedBulkheadMetricsPublisherTest.java b/...est/java/io/github/resilience4j/micrometer/tagged/TaggedBulkheadMetricsPublisherTest.java
@@ -31,7 +31,7 @@
 
 import static io.github.resilience4j.micrometer.tagged.AbstractBulkheadMetrics.MetricNames.DEFAULT_BULKHEAD_AVAILABLE_CONCURRENT_CALLS_METRIC_NAME;
 import static io.github.resilience4j.micrometer.tagged.AbstractBulkheadMetrics.MetricNames.DEFAULT_BULKHEAD_MAX_ALLOWED_CONCURRENT_CALLS_METRIC_NAME;
-import static io.github.resilience4j.micrometer.tagged.MetricsTestHelper.findGaugeByNamesTag;
+import static io.github.resilience4j.micrometer.tagged.MetricsTestHelper.findMeterByNamesTag;
 import static org.assertj.core.api.Assertions.assertThat;
 
 public class TaggedBulkheadMetricsPublisherTest {
@@ -69,7 +69,7 @@ public void shouldAddMetricsForANewlyCreatedRetry() {
         Collection<Gauge> gauges = meterRegistry
             .get(DEFAULT_BULKHEAD_MAX_ALLOWED_CONCURRENT_CALLS_METRIC_NAME).gauges();
 
-        Optional<Gauge> successful = findGaugeByNamesTag(gauges, newBulkhead.getName());
+        Optional<Gauge> successful = findMeterByNamesTag(gauges, newBulkhead.getName());
         assertThat(successful).isPresent();
         assertThat(successful.get().value())
             .isEqualTo(newBulkhead.getMetrics().getMaxAllowedConcurrentCalls());
@@ -94,7 +94,7 @@ public void shouldReplaceMetrics() {
         Collection<Gauge> gauges = meterRegistry
             .get(DEFAULT_BULKHEAD_MAX_ALLOWED_CONCURRENT_CALLS_METRIC_NAME).gauges();
 
-        Optional<Gauge> successful = findGaugeByNamesTag(gauges, bulkhead.getName());
+        Optional<Gauge> successful = findMeterByNamesTag(gauges, bulkhead.getName());
         assertThat(successful).isPresent();
         assertThat(successful.get().value())
             .isEqualTo(bulkhead.getMetrics().getMaxAllowedConcurrentCalls());
@@ -107,7 +107,7 @@ public void shouldReplaceMetrics() {
         gauges = meterRegistry.get(DEFAULT_BULKHEAD_MAX_ALLOWED_CONCURRENT_CALLS_METRIC_NAME)
             .gauges();
 
-        successful = findGaugeByNamesTag(gauges, newBulkhead.getName());
+        successful = findMeterByNamesTag(gauges, newBulkhead.getName());
         assertThat(successful).isPresent();
         assertThat(successful.get().value())
             .isEqualTo(newBulkhead.getMetrics().getMaxAllowedConcurrentCalls());

diff --git a/...ter/src/test/java/io/github/resilience4j/micrometer/tagged/TaggedBulkheadMetricsTest.java b/...ter/src/test/java/io/github/resilience4j/micrometer/tagged/TaggedBulkheadMetricsTest.java
@@ -31,7 +31,7 @@
 
 import static io.github.resilience4j.micrometer.tagged.AbstractBulkheadMetrics.MetricNames.DEFAULT_BULKHEAD_AVAILABLE_CONCURRENT_CALLS_METRIC_NAME;
 import static io.github.resilience4j.micrometer.tagged.AbstractBulkheadMetrics.MetricNames.DEFAULT_BULKHEAD_MAX_ALLOWED_CONCURRENT_CALLS_METRIC_NAME;
-import static io.github.resilience4j.micrometer.tagged.MetricsTestHelper.findGaugeByNamesTag;
+import static io.github.resilience4j.micrometer.tagged.MetricsTestHelper.findMeterByNamesTag;
 import static org.assertj.core.api.Assertions.assertThat;
 
 public class TaggedBulkheadMetricsTest {
@@ -69,7 +69,7 @@ public void shouldAddMetricsForANewlyCreatedRetry() {
         Collection<Gauge> gauges = meterRegistry
             .get(DEFAULT_BULKHEAD_MAX_ALLOWED_CONCURRENT_CALLS_METRIC_NAME).gauges();
 
-        Optional<Gauge> successful = findGaugeByNamesTag(gauges, newBulkhead.getName());
+        Optional<Gauge> successful = findMeterByNamesTag(gauges, newBulkhead.getName());
         assertThat(successful).isPresent();
         assertThat(successful.get().value())
             .isEqualTo(newBulkhead.getMetrics().getMaxAllowedConcurrentCalls());
@@ -94,7 +94,7 @@ public void shouldReplaceMetrics() {
         Collection<Gauge> gauges = meterRegistry
             .get(DEFAULT_BULKHEAD_MAX_ALLOWED_CONCURRENT_CALLS_METRIC_NAME).gauges();
 
-        Optional<Gauge> successful = findGaugeByNamesTag(gauges, bulkhead.getName());
+        Optional<Gauge> successful = findMeterByNamesTag(gauges, bulkhead.getName());
         assertThat(successful).isPresent();
         assertThat(successful.get().value())
             .isEqualTo(bulkhead.getMetrics().getMaxAllowedConcurrentCalls());
@@ -107,7 +107,7 @@ public void shouldReplaceMetrics() {
         gauges = meterRegistry.get(DEFAULT_BULKHEAD_MAX_ALLOWED_CONCURRENT_CALLS_METRIC_NAME)
             .gauges();
 
-        successful = findGaugeByNamesTag(gauges, newBulkhead.getName());
+        successful = findMeterByNamesTag(gauges, newBulkhead.getName());
         assertThat(successful).isPresent();
         assertThat(successful.get().value())
             .isEqualTo(newBulkhead.getMetrics().getMaxAllowedConcurrentCalls());

diff --git a/...va/io/github/resilience4j/micrometer/tagged/TaggedCircuitBreakerMetricsPublisherTest.java b/...va/io/github/resilience4j/micrometer/tagged/TaggedCircuitBreakerMetricsPublisherTest.java
@@ -33,8 +33,7 @@
 import java.util.stream.Collectors;
 
 import static io.github.resilience4j.micrometer.tagged.AbstractCircuitBreakerMetrics.MetricNames.*;
-import static io.github.resilience4j.micrometer.tagged.MetricsTestHelper.findCounterByKindAndNameTags;
-import static io.github.resilience4j.micrometer.tagged.MetricsTestHelper.findGaugeByKindAndNameTags;
+import static io.github.resilience4j.micrometer.tagged.MetricsTestHelper.findMeterByKindAndNameTags;
 import static org.assertj.core.api.Assertions.assertThat;
 
 public class TaggedCircuitBreakerMetricsPublisherTest {
@@ -82,7 +81,8 @@ public void shouldAddMetricsForANewlyCreatedCircuitBreaker() {
         Collection<Gauge> gauges = meterRegistry.get(DEFAULT_CIRCUIT_BREAKER_BUFFERED_CALLS)
             .gauges();
 
-        Optional<Gauge> successful = findGaugeByKindAndNameTags(gauges, "successful",
+        Optional<Gauge> successful = MetricsTestHelper
+            .findMeterByKindAndNameTags(gauges, "successful",
             newCircuitBreaker.getName());
         assertThat(successful).isPresent();
         assertThat(successful.get().value())
@@ -110,7 +110,7 @@ public void notPermittedCallsCounterReportsCorrespondingValue() {
 
         Collection<Counter> counters = meterRegistry.get(DEFAULT_CIRCUIT_BREAKER_CALLS).counters();
 
-        Optional<Counter> notPermitted = findCounterByKindAndNameTags(counters, "not_permitted",
+        Optional<Counter> notPermitted = findMeterByKindAndNameTags(counters, "not_permitted",
             circuitBreaker.getName());
         assertThat(notPermitted).isPresent();
         assertThat(notPermitted.get().count())
@@ -122,7 +122,7 @@ public void failedCallsGaugeReportsCorrespondingValue() {
         Collection<Gauge> gauges = meterRegistry.get(DEFAULT_CIRCUIT_BREAKER_BUFFERED_CALLS)
             .gauges();
 
-        Optional<Gauge> failed = findGaugeByKindAndNameTags(gauges, "failed",
+        Optional<Gauge> failed = MetricsTestHelper.findMeterByKindAndNameTags(gauges, "failed",
             circuitBreaker.getName());
         assertThat(failed).isPresent();
         assertThat(failed.get().value())
@@ -134,7 +134,8 @@ public void successfulCallsGaugeReportsCorrespondingValue() {
         Collection<Gauge> gauges = meterRegistry.get(DEFAULT_CIRCUIT_BREAKER_BUFFERED_CALLS)
             .gauges();
 
-        Optional<Gauge> successful = findGaugeByKindAndNameTags(gauges, "successful",
+        Optional<Gauge> successful = MetricsTestHelper
+            .findMeterByKindAndNameTags(gauges, "successful",
             circuitBreaker.getName());
         assertThat(successful).isPresent();
         assertThat(successful.get().value())
@@ -145,7 +146,7 @@ public void successfulCallsGaugeReportsCorrespondingValue() {
     public void slowSuccessFulCallsGaugeReportsCorrespondingValue() {
         Collection<Gauge> gauges = meterRegistry.get(DEFAULT_CIRCUIT_BREAKER_SLOW_CALLS).gauges();
 
-        Optional<Gauge> slow = findGaugeByKindAndNameTags(gauges, "successful",
+        Optional<Gauge> slow = MetricsTestHelper.findMeterByKindAndNameTags(gauges, "successful",
             circuitBreaker.getName());
         assertThat(slow).isPresent();
         assertThat(slow.get().value())
@@ -156,7 +157,7 @@ public void slowSuccessFulCallsGaugeReportsCorrespondingValue() {
     public void slowFailedCallsGaugeReportsCorrespondingValue() {
         Collection<Gauge> gauges = meterRegistry.get(DEFAULT_CIRCUIT_BREAKER_SLOW_CALLS).gauges();
 
-        Optional<Gauge> slow = findGaugeByKindAndNameTags(gauges, "failed",
+        Optional<Gauge> slow = MetricsTestHelper.findMeterByKindAndNameTags(gauges, "failed",
             circuitBreaker.getName());
         assertThat(slow).isPresent();
         assertThat(slow.get().value())

diff --git a/...c/test/java/io/github/resilience4j/micrometer/tagged/TaggedCircuitBreakerMetricsTest.java b/...c/test/java/io/github/resilience4j/micrometer/tagged/TaggedCircuitBreakerMetricsTest.java
@@ -33,8 +33,7 @@
 import java.util.stream.Collectors;
 
 import static io.github.resilience4j.micrometer.tagged.AbstractCircuitBreakerMetrics.MetricNames.*;
-import static io.github.resilience4j.micrometer.tagged.MetricsTestHelper.findCounterByKindAndNameTags;
-import static io.github.resilience4j.micrometer.tagged.MetricsTestHelper.findGaugeByKindAndNameTags;
+import static io.github.resilience4j.micrometer.tagged.MetricsTestHelper.findMeterByKindAndNameTags;
 import static org.assertj.core.api.Assertions.assertThat;
 
 public class TaggedCircuitBreakerMetricsTest {
@@ -80,7 +79,8 @@ public void shouldAddMetricsForANewlyCreatedCircuitBreaker() {
         Collection<Gauge> gauges = meterRegistry.get(DEFAULT_CIRCUIT_BREAKER_BUFFERED_CALLS)
             .gauges();
 
-        Optional<Gauge> successful = findGaugeByKindAndNameTags(gauges, "successful",
+        Optional<Gauge> successful = MetricsTestHelper
+            .findMeterByKindAndNameTags(gauges, "successful",
             newCircuitBreaker.getName());
         assertThat(successful).isPresent();
         assertThat(successful.get().value())
@@ -120,7 +120,7 @@ public void notPermittedCallsCounterReportsCorrespondingValue() {
 
         Collection<Counter> counters = meterRegistry.get(DEFAULT_CIRCUIT_BREAKER_CALLS).counters();
 
-        Optional<Counter> notPermitted = findCounterByKindAndNameTags(counters, "not_permitted",
+        Optional<Counter> notPermitted = findMeterByKindAndNameTags(counters, "not_permitted",
             circuitBreaker.getName());
         assertThat(notPermitted).isPresent();
         assertThat(notPermitted.get().count())
@@ -132,7 +132,7 @@ public void failedCallsGaugeReportsCorrespondingValue() {
         Collection<Gauge> gauges = meterRegistry.get(DEFAULT_CIRCUIT_BREAKER_BUFFERED_CALLS)
             .gauges();
 
-        Optional<Gauge> failed = findGaugeByKindAndNameTags(gauges, "failed",
+        Optional<Gauge> failed = MetricsTestHelper.findMeterByKindAndNameTags(gauges, "failed",
             circuitBreaker.getName());
         assertThat(failed).isPresent();
         assertThat(failed.get().value())
@@ -144,7 +144,8 @@ public void successfulCallsGaugeReportsCorrespondingValue() {
         Collection<Gauge> gauges = meterRegistry.get(DEFAULT_CIRCUIT_BREAKER_BUFFERED_CALLS)
             .gauges();
 
-        Optional<Gauge> successful = findGaugeByKindAndNameTags(gauges, "successful",
+        Optional<Gauge> successful = MetricsTestHelper
+            .findMeterByKindAndNameTags(gauges, "successful",
             circuitBreaker.getName());
         assertThat(successful).isPresent();
         assertThat(successful.get().value())
@@ -156,7 +157,7 @@ public void successfulCallsGaugeReportsCorrespondingValue() {
     public void slowSuccessfulGaugeReportsCorrespondingValue() {
         Collection<Gauge> gauges = meterRegistry.get(DEFAULT_CIRCUIT_BREAKER_SLOW_CALLS).gauges();
 
-        Optional<Gauge> slow = findGaugeByKindAndNameTags(gauges, "successful",
+        Optional<Gauge> slow = MetricsTestHelper.findMeterByKindAndNameTags(gauges, "successful",
             circuitBreaker.getName());
         assertThat(slow).isPresent();
         assertThat(slow.get().value())
@@ -168,7 +169,7 @@ public void slowSuccessfulGaugeReportsCorrespondingValue() {
     public void slowFailedCallsGaugeReportsCorrespondingValue() {
         Collection<Gauge> gauges = meterRegistry.get(DEFAULT_CIRCUIT_BREAKER_SLOW_CALLS).gauges();
 
-        Optional<Gauge> slow = findGaugeByKindAndNameTags(gauges, "failed",
+        Optional<Gauge> slow = MetricsTestHelper.findMeterByKindAndNameTags(gauges, "failed",
             circuitBreaker.getName());
         assertThat(slow).isPresent();
         assertThat(slow.get().value())

diff --git a/.../java/io/github/resilience4j/micrometer/tagged/TaggedRateLimiterMetricsPublisherTest.java b/.../java/io/github/resilience4j/micrometer/tagged/TaggedRateLimiterMetricsPublisherTest.java
@@ -31,7 +31,7 @@
 
 import static io.github.resilience4j.micrometer.tagged.AbstractRateLimiterMetrics.MetricNames.DEFAULT_AVAILABLE_PERMISSIONS_METRIC_NAME;
 import static io.github.resilience4j.micrometer.tagged.AbstractRateLimiterMetrics.MetricNames.DEFAULT_WAITING_THREADS_METRIC_NAME;
-import static io.github.resilience4j.micrometer.tagged.MetricsTestHelper.findGaugeByNamesTag;
+import static io.github.resilience4j.micrometer.tagged.MetricsTestHelper.findMeterByNamesTag;
 import static org.assertj.core.api.Assertions.assertThat;
 
 public class TaggedRateLimiterMetricsPublisherTest {
@@ -66,7 +66,7 @@ public void shouldAddMetricsForANewlyCreatedRateLimiter() {
         Collection<Gauge> gauges = meterRegistry.get(DEFAULT_AVAILABLE_PERMISSIONS_METRIC_NAME)
             .gauges();
 
-        Optional<Gauge> successful = findGaugeByNamesTag(gauges, newRateLimiter.getName());
+        Optional<Gauge> successful = findMeterByNamesTag(gauges, newRateLimiter.getName());
         assertThat(successful).isPresent();
         assertThat(successful.get().value())
             .isEqualTo(newRateLimiter.getMetrics().getAvailablePermissions());

diff --git a/.../src/test/java/io/github/resilience4j/micrometer/tagged/TaggedRateLimiterMetricsTest.java b/.../src/test/java/io/github/resilience4j/micrometer/tagged/TaggedRateLimiterMetricsTest.java
@@ -30,7 +30,7 @@
 
 import static io.github.resilience4j.micrometer.tagged.AbstractRateLimiterMetrics.MetricNames.DEFAULT_AVAILABLE_PERMISSIONS_METRIC_NAME;
 import static io.github.resilience4j.micrometer.tagged.AbstractRateLimiterMetrics.MetricNames.DEFAULT_WAITING_THREADS_METRIC_NAME;
-import static io.github.resilience4j.micrometer.tagged.MetricsTestHelper.findGaugeByNamesTag;
+import static io.github.resilience4j.micrometer.tagged.MetricsTestHelper.findMeterByNamesTag;
 import static org.assertj.core.api.Assertions.assertThat;
 
 public class TaggedRateLimiterMetricsTest {
@@ -65,7 +65,7 @@ public void shouldAddMetricsForANewlyCreatedRateLimiter() {
         Collection<Gauge> gauges = meterRegistry.get(DEFAULT_AVAILABLE_PERMISSIONS_METRIC_NAME)
             .gauges();
 
-        Optional<Gauge> successful = findGaugeByNamesTag(gauges, newRateLimiter.getName());
+        Optional<Gauge> successful = findMeterByNamesTag(gauges, newRateLimiter.getName());
         assertThat(successful).isPresent();
         assertThat(successful.get().value())
             .isEqualTo(newRateLimiter.getMetrics().getAvailablePermissions());