Hide DistributionStatisticsConfig changes behind a config flag

micrometer-metrics · Mar 18, 2022 · 79693ed · 79693ed
1 parent 09f2c52
commit 79693ed
Show file tree

Hide file tree

Showing 3 changed files with 219 additions and 158 deletions.
diff --git a/...ons/micrometer-registry-signalfx/src/main/java/io/micrometer/signalfx/SignalFxConfig.java b/...ons/micrometer-registry-signalfx/src/main/java/io/micrometer/signalfx/SignalFxConfig.java
@@ -24,7 +24,11 @@
 
 import static io.micrometer.core.instrument.config.MeterRegistryConfigValidator.checkAll;
 import static io.micrometer.core.instrument.config.MeterRegistryConfigValidator.checkRequired;
-import static io.micrometer.core.instrument.config.validate.PropertyValidator.*;
+import static io.micrometer.core.instrument.config.validate.PropertyValidator.getBoolean;
+import static io.micrometer.core.instrument.config.validate.PropertyValidator.getDuration;
+import static io.micrometer.core.instrument.config.validate.PropertyValidator.getSecret;
+import static io.micrometer.core.instrument.config.validate.PropertyValidator.getString;
+import static io.micrometer.core.instrument.config.validate.PropertyValidator.getUrlString;
 
 /**
  * Configuration for {@link SignalFxMeterRegistry}.
@@ -43,14 +47,10 @@ default String accessToken() {
     }
 
     /**
-     * Returns {@code true} if the signalfx registry should emit histogram buckets as
-     * CumulativeCounter instead of Gauge (as it is by default).
-     *
-     * @return {@code true} if the signalfx registry should emit histogram buckets as
-     * CumulativeCounter instead of Gauge (as it is by default).
+     * @return {@code true} if the SignalFx registry should emit cumulative histogram buckets.
      */
-    default Boolean fixHistogramBucketsType() {
-        return getBoolean(this, "fixHistogramBucketsType").orElse(false);
+    default boolean publishCumulativeHistogram() {
+        return getBoolean(this, "publishCumulativeHistogram").orElse(false);
     }
 
     /**

diff --git a/...rometer-registry-signalfx/src/main/java/io/micrometer/signalfx/SignalFxMeterRegistry.java b/...rometer-registry-signalfx/src/main/java/io/micrometer/signalfx/SignalFxMeterRegistry.java
@@ -73,7 +73,7 @@ public class SignalFxMeterRegistry extends StepMeterRegistry {
     private final HttpEventProtobufReceiverFactory eventReceiverFactory;
     private final Set<OnSendErrorHandler> onSendErrorHandlerCollection = Collections.singleton(
             metricError -> this.logger.warn("failed to send metrics: {}", metricError.getMessage()));
-    private final boolean fixHistogramBucketsType;
+    private final boolean publishCumulativeHistograms;
 
     public SignalFxMeterRegistry(SignalFxConfig config, Clock clock) {
         this(config, clock, DEFAULT_THREAD_FACTORY);
@@ -96,7 +96,7 @@ public SignalFxMeterRegistry(SignalFxConfig config, Clock clock, ThreadFactory t
         SignalFxReceiverEndpoint signalFxEndpoint = new SignalFxEndpoint(apiUri.getScheme(), apiUri.getHost(), port);
         this.dataPointReceiverFactory = new HttpDataPointProtobufReceiverFactory(signalFxEndpoint);
         this.eventReceiverFactory = new HttpEventProtobufReceiverFactory(signalFxEndpoint);
-        this.fixHistogramBucketsType = config.fixHistogramBucketsType();
+        this.publishCumulativeHistograms = config.publishCumulativeHistogram();
 
         config().namingConvention(new SignalFxNamingConvention());
 
@@ -136,13 +136,19 @@ protected void publish() {
 
     @Override
     protected Timer newTimer(Meter.Id id, DistributionStatisticConfig distributionStatisticConfig, PauseDetector pauseDetector) {
+        if (!publishCumulativeHistograms) {
+            return super.newTimer(id, distributionStatisticConfig, pauseDetector);
+        }
         Timer timer = new SignalfxTimer(id, clock, distributionStatisticConfig, pauseDetector, getBaseTimeUnit(), config.step().toMillis());
         HistogramGauges.registerWithCommonFormat(timer, this);
         return timer;
     }
 
     @Override
     protected DistributionSummary newDistributionSummary(Meter.Id id, DistributionStatisticConfig distributionStatisticConfig, double scale) {
+        if (!publishCumulativeHistograms) {
+            return super.newDistributionSummary(id, distributionStatisticConfig, scale);
+        }
         DistributionSummary summary = new SignalfxDistributionSummary(id, clock, distributionStatisticConfig, scale, config.step().toMillis());
         HistogramGauges.registerWithCommonFormat(summary, this);
         return summary;
@@ -205,7 +211,7 @@ Stream<SignalFxProtocolBuffers.DataPoint.Builder> addTimeGauge(TimeGauge timeGau
     }
 
     Stream<SignalFxProtocolBuffers.DataPoint.Builder> addGauge(Gauge gauge) {
-        if (fixHistogramBucketsType
+        if (publishCumulativeHistograms
                 && gauge.getId().syntheticAssociation() != null
                 && gauge.getId().getName().endsWith(".histogram")) {
             return Stream.of(addDatapoint(gauge, CUMULATIVE_COUNTER, null, gauge.value()));