add interface to spectator monitors

brharrington · brharrington · commit d25569823412 · 2018-05-10T06:53:29.000-07:00
This interface would allow us to detect when polling
whether or not the monitor type reports directly to
spectator or would need to be sent in separately.
diff --git a/servo-core/src/main/java/com/netflix/servo/monitor/AnnotatedNumberMonitor.java b/servo-core/src/main/java/com/netflix/servo/monitor/AnnotatedNumberMonitor.java
@@ -25,7 +25,8 @@
 /**
  * Wraps an annotated field and exposes it as a numeric monitor object.
  */
-class AnnotatedNumberMonitor extends AbstractMonitor<Number> implements NumericMonitor<Number> {
+class AnnotatedNumberMonitor extends AbstractMonitor<Number>
+    implements NumericMonitor<Number>, SpectatorMonitor {
 
   private final Object object;
   private final AccessibleObject field;
diff --git a/servo-core/src/main/java/com/netflix/servo/monitor/BasicCounter.java b/servo-core/src/main/java/com/netflix/servo/monitor/BasicCounter.java
@@ -25,7 +25,8 @@
  * The value is the total count for the life of the counter. Observers are responsible
  * for converting to a rate and handling overflows if they occur.
  */
-public final class BasicCounter extends AbstractMonitor<Number> implements Counter {
+public final class BasicCounter extends AbstractMonitor<Number>
+    implements Counter, SpectatorMonitor {
   private final AtomicLong count = new AtomicLong();
   private final com.netflix.spectator.api.Counter spectatorCounter;
 
diff --git a/servo-core/src/main/java/com/netflix/servo/monitor/BasicGauge.java b/servo-core/src/main/java/com/netflix/servo/monitor/BasicGauge.java
@@ -24,7 +24,8 @@
 /**
  * A gauge implementation that invokes a specified callable to get the current value.
  */
-public final class BasicGauge<T extends Number> extends AbstractMonitor<T> implements Gauge<T> {
+public final class BasicGauge<T extends Number> extends AbstractMonitor<T>
+    implements Gauge<T>, SpectatorMonitor {
   private final Callable<T> function;
 
   /**
diff --git a/servo-core/src/main/java/com/netflix/servo/monitor/BasicTimer.java b/servo-core/src/main/java/com/netflix/servo/monitor/BasicTimer.java
@@ -28,7 +28,8 @@
  * A simple timer implementation providing the total time, count, min, and max for the times that
  * have been recorded.
  */
-public class BasicTimer extends AbstractMonitor<Long> implements Timer, CompositeMonitor<Long> {
+public class BasicTimer extends AbstractMonitor<Long>
+    implements Timer, CompositeMonitor<Long>, SpectatorMonitor {
 
   private static final String STATISTIC = "statistic";
   private static final String UNIT = "unit";
diff --git a/servo-core/src/main/java/com/netflix/servo/monitor/DoubleCounter.java b/servo-core/src/main/java/com/netflix/servo/monitor/DoubleCounter.java
@@ -1,5 +1,5 @@
-/**
- * Copyright 2015 Netflix, Inc.
+/*
+ * Copyright 2011-2018 Netflix, Inc.
  * <p/>
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -28,7 +28,8 @@
  * The value returned is a rate for the
  * previous interval as defined by the step.
  */
-class DoubleCounter extends AbstractMonitor<Number> implements NumericMonitor<Number> {
+class DoubleCounter extends AbstractMonitor<Number>
+    implements NumericMonitor<Number>, SpectatorMonitor {
 
   private final StepLong count;
   private final com.netflix.spectator.api.Counter spectatorCounter;
diff --git a/servo-core/src/main/java/com/netflix/servo/monitor/DoubleGauge.java b/servo-core/src/main/java/com/netflix/servo/monitor/DoubleGauge.java
@@ -1,5 +1,5 @@
-/**
- * Copyright 2013 Netflix, Inc.
+/*
+ * Copyright 2011-2018 Netflix, Inc.
  * <p/>
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,11 +17,13 @@
 
 import com.google.common.util.concurrent.AtomicDouble;
 import com.netflix.servo.SpectatorContext;
+import com.netflix.servo.annotations.DataSourceType;
 
 /**
  * A {@link Gauge} that reports a double value.
  */
-public class DoubleGauge extends NumberGauge {
+public class DoubleGauge extends AbstractMonitor<Double>
+    implements Gauge<Double>, SpectatorMonitor {
   private final AtomicDouble number;
   private final com.netflix.spectator.api.Gauge spectatorGauge;
 
@@ -31,9 +33,8 @@ public class DoubleGauge extends NumberGauge {
    * @param config configuration for this gauge
    */
   public DoubleGauge(MonitorConfig config) {
-    super(config);
+    super(config.withAdditionalTag(DataSourceType.GAUGE));
     number = new AtomicDouble(0.0);
-    setBackingNumber(number);
     spectatorGauge = SpectatorContext.gauge(config);
   }
 
@@ -86,9 +87,17 @@ public int hashCode() {
    * {@inheritDoc}
    */
   @Override
-  public Number getValue(int pollerIdx) {
+  public Double getValue(int pollerIdx) {
     // we return the actual value at the time of the call and not a reference
     // to the atomic number so the value doesn't change and is also available to jmx viewers
     return number.get();
   }
+
+  /**
+   * {@inheritDoc}
+   */
+  @Override
+  public String toString() {
+    return "DoubleGauge{config=" + config + ", number=" + number + '}';
+  }
 }
diff --git a/servo-core/src/main/java/com/netflix/servo/monitor/DoubleMaxGauge.java b/servo-core/src/main/java/com/netflix/servo/monitor/DoubleMaxGauge.java
@@ -27,7 +27,7 @@
  * non-negative, the reset value is 0.
  */
 public class DoubleMaxGauge extends AbstractMonitor<Double>
-    implements Gauge<Double> {
+    implements Gauge<Double>, SpectatorMonitor {
   private final StepLong max;
   private final com.netflix.spectator.api.Gauge spectatorGauge;
 
diff --git a/servo-core/src/main/java/com/netflix/servo/monitor/LongGauge.java b/servo-core/src/main/java/com/netflix/servo/monitor/LongGauge.java
@@ -1,5 +1,5 @@
-/**
- * Copyright 2013 Netflix, Inc.
+/*
+ * Copyright 2011-2018 Netflix, Inc.
  * <p/>
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,13 +16,15 @@
 package com.netflix.servo.monitor;
 
 import com.netflix.servo.SpectatorContext;
+import com.netflix.servo.annotations.DataSourceType;
 
 import java.util.concurrent.atomic.AtomicLong;
 
 /**
  * A {@link Gauge} that reports a long value.
  */
-public class LongGauge extends NumberGauge {
+public class LongGauge extends AbstractMonitor<Long>
+    implements Gauge<Long>, SpectatorMonitor {
   private final AtomicLong number;
   private final com.netflix.spectator.api.Gauge spectatorGauge;
 
@@ -32,9 +34,8 @@ public class LongGauge extends NumberGauge {
    * @param config configuration for this gauge
    */
   public LongGauge(MonitorConfig config) {
-    super(config);
+    super(config.withAdditionalTag(DataSourceType.GAUGE));
     number = new AtomicLong(0L);
-    setBackingNumber(number);
     spectatorGauge = SpectatorContext.gauge(config);
   }
 
@@ -85,9 +86,17 @@ public int hashCode() {
    * {@inheritDoc}
    */
   @Override
-  public Number getValue(int pollerIdx) {
+  public Long getValue(int pollerIdx) {
     // we return the actual value at the time of the call and not a reference
     // to the atomic number so the value doesn't change and is also available to jmx viewers
     return number.get();
   }
+
+  /**
+   * {@inheritDoc}
+   */
+  @Override
+  public String toString() {
+    return "LongGauge{config=" + config + ", number=" + number + '}';
+  }
 }
diff --git a/servo-core/src/main/java/com/netflix/servo/monitor/MaxGauge.java b/servo-core/src/main/java/com/netflix/servo/monitor/MaxGauge.java
@@ -1,5 +1,5 @@
-/**
- * Copyright 2013 Netflix, Inc.
+/*
+ * Copyright 2011-2018 Netflix, Inc.
  * <p/>
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -27,7 +27,7 @@
  * non-negative, the reset value is 0.
  */
 public class MaxGauge extends AbstractMonitor<Long>
-    implements Gauge<Long> {
+    implements Gauge<Long>, SpectatorMonitor {
   private final StepLong max;
   private final com.netflix.spectator.api.Gauge spectatorGauge;
 
diff --git a/servo-core/src/main/java/com/netflix/servo/monitor/NumberGauge.java b/servo-core/src/main/java/com/netflix/servo/monitor/NumberGauge.java
@@ -25,7 +25,8 @@
 /**
  * A {@link Gauge} that returns the value stored in {@link Number}.
  */
-public class NumberGauge extends AbstractMonitor<Number> implements Gauge<Number> {
+public class NumberGauge extends AbstractMonitor<Number>
+    implements Gauge<Number>, SpectatorMonitor {
   private WeakReference<Number> numberRef;
 
   /**
diff --git a/servo-core/src/main/java/com/netflix/servo/monitor/SpectatorMonitor.java b/servo-core/src/main/java/com/netflix/servo/monitor/SpectatorMonitor.java
@@ -0,0 +1,24 @@
+/*
+ * Copyright 2011-2018 Netflix, Inc.
+ * <p/>
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * <p/>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p/>
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.netflix.servo.monitor;
+
+/**
+ * Indicates that the monitor implementation will automatically update the spectator
+ * registry defined in {@code SpectatorContext}. Other monitors need to get polled and
+ * update the registry.
+ */
+public interface SpectatorMonitor {
+}
diff --git a/servo-core/src/main/java/com/netflix/servo/monitor/StepCounter.java b/servo-core/src/main/java/com/netflix/servo/monitor/StepCounter.java
@@ -1,5 +1,5 @@
-/**
- * Copyright 2013 Netflix, Inc.
+/*
+ * Copyright 2011-2018 Netflix, Inc.
  * <p/>
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -25,7 +25,7 @@
  * A simple counter implementation backed by a StepLong. The value returned is a rate for the
  * previous interval as defined by the step.
  */
-public class StepCounter extends AbstractMonitor<Number> implements Counter {
+public class StepCounter extends AbstractMonitor<Number> implements Counter, SpectatorMonitor {
 
   private final StepLong count;
   private final com.netflix.spectator.api.Counter spectatorCounter;
diff --git a/servo-core/src/test/java/com/netflix/servo/publish/NormalizationTransformTest.java b/servo-core/src/test/java/com/netflix/servo/publish/NormalizationTransformTest.java
@@ -167,9 +167,9 @@ public void testRandomOffset() throws Exception {
     assertMetrics(60000, 120000, inputList, expected);
   }
 
-  private List<Metric> getValue(List<? extends AbstractMonitor<Number>> monitors, Clock clock) {
+  private List<Metric> getValue(List<? extends AbstractMonitor<? extends Number>> monitors, Clock clock) {
     List<Metric> result = new ArrayList<>();
-    for (AbstractMonitor<Number> m : monitors) {
+    for (AbstractMonitor<? extends Number> m : monitors) {
       Number n = m.getValue(0);
       Metric metric = new Metric(m.getConfig(), clock.now(), n);
       result.add(metric);
@@ -187,7 +187,7 @@ public void testUpdate() throws Exception {
         manualClock);
     LongGauge gauge = new LongGauge(MonitorConfig.builder("longGauge").build());
 
-    List<? extends AbstractMonitor<Number>> monitors = UnmodifiableList.of(basicCounter,
+    List<? extends AbstractMonitor<? extends Number>> monitors = UnmodifiableList.of(basicCounter,
         stepCounter, gauge);
 
     MemoryMetricObserver observer = new MemoryMetricObserver("normalization-test", 1);
