Rename LatencyRecorder to MetricsRecorder and add counter for object leaks

chrisvest · chrisvest · commit b4eeba89271a · 2014-07-20T12:19:50.000+02:00
diff --git a/src/main/java/stormpot/BAllocThread.java b/src/main/java/stormpot/BAllocThread.java
@@ -35,7 +35,7 @@ class BAllocThread<T extends Poolable> extends Thread {
   private final BlockingQueue<BSlot<T>> dead;
   private final Reallocator<T> allocator;
   private final BSlot<T> poisonPill;
-  private final LatencyRecorder latencyRecorder;
+  private final MetricsRecorder metricsRecorder;
 
   // Single reader: this. Many writers.
   private volatile int targetSize;
@@ -55,7 +55,7 @@ public BAllocThread(
     this.targetSize = config.getSize();
     completionLatch = new CountDownLatch(1);
     this.allocator = config.getAdaptedReallocator();
-    this.latencyRecorder = config.getLatencyRecorder();
+    this.metricsRecorder = config.getMetricsRecorder();
     this.size = 0;
     this.live = live;
     this.dead = dead;
@@ -234,8 +234,8 @@ private void realloc(BSlot<T> slot) {
   }
 
   private void recordObjectLifetimeSample(long milliseconds) {
-    if (latencyRecorder != null) {
-      latencyRecorder.recordObjectLifetimeSampleMillis(milliseconds);
+    if (metricsRecorder != null) {
+      metricsRecorder.recordObjectLifetimeSampleMillis(milliseconds);
     }
   }
 
diff --git a/src/main/java/stormpot/BlazePool.java b/src/main/java/stormpot/BlazePool.java
@@ -51,7 +51,7 @@ public Throwable fillInStackTrace() {
   private final BlockingQueue<BSlot<T>> dead;
   private final BAllocThread<T> allocThread;
   private final Expiration<? super T> deallocRule;
-  private final LatencyRecorder latencyRecorder;
+  private final MetricsRecorder metricsRecorder;
 
   /**
    * Special slot used to signal that the pool has been shut down.
@@ -76,7 +76,7 @@ public BlazePool(Config<T> config) {
       config.validate();
       allocThread = new BAllocThread<T>(live, dead, config, poisonPill);
       deallocRule = config.getExpiration();
-      latencyRecorder = config.getLatencyRecorder();
+      metricsRecorder = config.getMetricsRecorder();
     }
     allocThread.start();
   }
@@ -281,49 +281,54 @@ public boolean isShutDown() {
 
   @Override
   public double getObjectLifetimePercentile(double percentile) {
-    if (latencyRecorder == null) {
+    if (metricsRecorder == null) {
       return Double.NaN;
     }
-    return latencyRecorder.getObjectLifetimePercentile(percentile);
+    return metricsRecorder.getObjectLifetimePercentile(percentile);
   }
 
   @Override
   public double getAllocationLatencyPercentile(double percentile) {
-    if (latencyRecorder == null) {
+    if (metricsRecorder == null) {
       return Double.NaN;
     }
-    return latencyRecorder.getAllocationLatencyPercentile(percentile);
+    return metricsRecorder.getAllocationLatencyPercentile(percentile);
   }
 
   @Override
   public double getAllocationFailureLatencyPercentile(double percentile) {
-    if (latencyRecorder == null) {
+    if (metricsRecorder == null) {
       return Double.NaN;
     }
-    return latencyRecorder.getAllocationFailureLatencyPercentile(percentile);
+    return metricsRecorder.getAllocationFailureLatencyPercentile(percentile);
   }
 
   @Override
   public double getReallocationLatencyPercentile(double percentile) {
-    if (latencyRecorder == null) {
+    if (metricsRecorder == null) {
       return Double.NaN;
     }
-    return latencyRecorder.getReallocationLatencyPercentile(percentile);
+    return metricsRecorder.getReallocationLatencyPercentile(percentile);
   }
 
   @Override
   public double getReallocationFailureLatencyPercentile(double percentile) {
-    if (latencyRecorder == null) {
+    if (metricsRecorder == null) {
       return Double.NaN;
     }
-    return latencyRecorder.getReallocationFailurePercentile(percentile);
+    return metricsRecorder.getReallocationFailurePercentile(percentile);
   }
 
   @Override
   public double getDeallocationLatencyPercentile(double percentile) {
-    if (latencyRecorder == null) {
+    if (metricsRecorder == null) {
       return Double.NaN;
     }
-    return latencyRecorder.getDeallocationLatencyPercentile(percentile);
+    return metricsRecorder.getDeallocationLatencyPercentile(percentile);
+  }
+
+  @Override
+  public long getLeakedObjectsCount() {
+    return metricsRecorder.getLeakedObjectsCount();
   }
 }
diff --git a/src/main/java/stormpot/Config.java b/src/main/java/stormpot/Config.java
@@ -55,7 +55,7 @@ public class Config<T extends Poolable> {
   private Expiration<? super T> expiration =
       new TimeSpreadExpiration(480000, 600000, TimeUnit.MILLISECONDS); // 8 to 10 minutes
   private Allocator<?> allocator;
-  private LatencyRecorder latencyRecorder;
+  private MetricsRecorder metricsRecorder;
 
   /**
    * Build a new empty Config object. Most settings have reasonable default
@@ -167,13 +167,13 @@ public synchronized Expiration<? super T> getExpiration() {
     return expiration;
   }
 
-  public synchronized Config<T> setLatencyRecorder(LatencyRecorder latencyRecorder) {
-    this.latencyRecorder = latencyRecorder;
+  public synchronized Config<T> setMetricsRecorder(MetricsRecorder metricsRecorder) {
+    this.metricsRecorder = metricsRecorder;
     return this;
   }
 
-  public synchronized LatencyRecorder getLatencyRecorder() {
-    return latencyRecorder;
+  public synchronized MetricsRecorder getMetricsRecorder() {
+    return metricsRecorder;
   }
 
   /**
@@ -202,18 +202,18 @@ Reallocator<T> getAdaptedReallocator() {
     if (allocator == null) {
       return null;
     }
-    if (latencyRecorder == null) {
+    if (metricsRecorder == null) {
       if (allocator instanceof Reallocator) {
         return (Reallocator<T>) allocator;
       }
       return new ReallocatingAdaptor<T>((Allocator<T>) allocator);
     } else {
       if (allocator instanceof Reallocator) {
         return new TimingReallocatorAdaptor<T>(
-            (Reallocator<T>) allocator, latencyRecorder);
+            (Reallocator<T>) allocator, metricsRecorder);
       }
       return new TimingReallocatingAdaptor<T>(
-          (Allocator<T>) allocator, latencyRecorder);
+          (Allocator<T>) allocator, metricsRecorder);
     }
   }
 }
diff --git a/src/main/java/stormpot/ManagedPool.java b/src/main/java/stormpot/ManagedPool.java
@@ -83,4 +83,6 @@ public interface ManagedPool {
   double getReallocationFailureLatencyPercentile(double percentile);
 
   double getDeallocationLatencyPercentile(double percentile);
+
+  long getLeakedObjectsCount();
 }
diff --git a/src/main/java/stormpot/MetricsRecorder.java b/src/main/java/stormpot/MetricsRecorder.java
@@ -15,7 +15,7 @@
  */
 package stormpot;
 
-public interface LatencyRecorder {
+public interface MetricsRecorder {
 
   void recordAllocationLatencySampleMillis(long milliseconds);
 
@@ -40,4 +40,6 @@ public interface LatencyRecorder {
   public double getReallocationFailurePercentile(double percentile);
 
   public double getObjectLifetimePercentile(double percentile);
+
+  long getLeakedObjectsCount();
 }
diff --git a/src/main/java/stormpot/QAllocThread.java b/src/main/java/stormpot/QAllocThread.java
@@ -34,7 +34,7 @@ class QAllocThread<T extends Poolable> extends Thread {
   private final BlockingQueue<QSlot<T>> dead;
   private final Reallocator<T> allocator;
   private final QSlot<T> poisonPill;
-  private final LatencyRecorder latencyRecorder;
+  private final MetricsRecorder metricsRecorder;
 
   // Single reader: this. Many writers.
   private volatile int targetSize;
@@ -52,8 +52,8 @@ public QAllocThread(
       BlockingQueue<QSlot<T>> dead,
       Config<T> config,
       QSlot<T> poisonPill,
-      LatencyRecorder latencyRecorder) {
-    this.latencyRecorder = latencyRecorder;
+      MetricsRecorder metricsRecorder) {
+    this.metricsRecorder = metricsRecorder;
     this.targetSize = config.getSize();
     completionLatch = new CountDownLatch(1);
     this.allocator = config.getAdaptedReallocator();
@@ -201,8 +201,8 @@ private void realloc(QSlot<T> slot) {
   }
 
   private void recordObjectLifetimeSample(long milliseconds) {
-    if (latencyRecorder != null) {
-      latencyRecorder.recordObjectLifetimeSampleMillis(milliseconds);
+    if (metricsRecorder != null) {
+      metricsRecorder.recordObjectLifetimeSampleMillis(milliseconds);
     }
   }
 
diff --git a/src/main/java/stormpot/QueuePool.java b/src/main/java/stormpot/QueuePool.java
@@ -44,7 +44,7 @@ public class QueuePool<T extends Poolable>
   private final BlockingQueue<QSlot<T>> dead;
   private final QAllocThread<T> allocThread;
   private final Expiration<? super T> deallocRule;
-  private final LatencyRecorder latencyRecorder;
+  private final MetricsRecorder metricsRecorder;
   private volatile boolean shutdown = false;
 
   /**
@@ -61,9 +61,9 @@ public QueuePool(Config<T> config) {
     dead = QueueFactory.createUnboundedBlockingQueue();
     synchronized (config) {
       config.validate();
-      latencyRecorder = config.getLatencyRecorder();
+      metricsRecorder = config.getMetricsRecorder();
       allocThread = new QAllocThread<T>(
-          live, dead, config, poisonPill, latencyRecorder);
+          live, dead, config, poisonPill, metricsRecorder);
       deallocRule = config.getExpiration();
     }
     allocThread.start();
@@ -166,49 +166,54 @@ public boolean isShutDown() {
 
   @Override
   public double getObjectLifetimePercentile(double percentile) {
-    if (latencyRecorder == null) {
+    if (metricsRecorder == null) {
       return Double.NaN;
     }
-    return latencyRecorder.getObjectLifetimePercentile(percentile);
+    return metricsRecorder.getObjectLifetimePercentile(percentile);
   }
 
   @Override
   public double getAllocationLatencyPercentile(double percentile) {
-    if (latencyRecorder == null) {
+    if (metricsRecorder == null) {
       return Double.NaN;
     }
-    return latencyRecorder.getAllocationLatencyPercentile(percentile);
+    return metricsRecorder.getAllocationLatencyPercentile(percentile);
   }
 
   @Override
   public double getAllocationFailureLatencyPercentile(double percentile) {
-    if (latencyRecorder == null) {
+    if (metricsRecorder == null) {
       return Double.NaN;
     }
-    return latencyRecorder.getAllocationFailureLatencyPercentile(percentile);
+    return metricsRecorder.getAllocationFailureLatencyPercentile(percentile);
   }
 
   @Override
   public double getReallocationLatencyPercentile(double percentile) {
-    if (latencyRecorder == null) {
+    if (metricsRecorder == null) {
       return Double.NaN;
     }
-    return latencyRecorder.getReallocationLatencyPercentile(percentile);
+    return metricsRecorder.getReallocationLatencyPercentile(percentile);
   }
 
   @Override
   public double getReallocationFailureLatencyPercentile(double percentile) {
-    if (latencyRecorder == null) {
+    if (metricsRecorder == null) {
       return Double.NaN;
     }
-    return latencyRecorder.getReallocationFailurePercentile(percentile);
+    return metricsRecorder.getReallocationFailurePercentile(percentile);
   }
 
   @Override
   public double getDeallocationLatencyPercentile(double percentile) {
-    if (latencyRecorder == null) {
+    if (metricsRecorder == null) {
       return Double.NaN;
     }
-    return latencyRecorder.getDeallocationLatencyPercentile(percentile);
+    return metricsRecorder.getDeallocationLatencyPercentile(percentile);
+  }
+
+  @Override
+  public long getLeakedObjectsCount() {
+    return metricsRecorder.getLeakedObjectsCount();
   }
 }
diff --git a/src/main/java/stormpot/TimingReallocatingAdaptor.java b/src/main/java/stormpot/TimingReallocatingAdaptor.java
@@ -19,13 +19,13 @@ class TimingReallocatingAdaptor<T extends Poolable>
     extends ReallocatingAdaptor<T>
     implements Reallocator<T> {
 
-  protected final LatencyRecorder latencyRecorder;
+  protected final MetricsRecorder metricsRecorder;
 
   public TimingReallocatingAdaptor(
       Allocator<T> allocator,
-      LatencyRecorder latencyRecorder) {
+      MetricsRecorder metricsRecorder) {
     super(allocator);
-    this.latencyRecorder = latencyRecorder;
+    this.metricsRecorder = metricsRecorder;
   }
 
   @Override
@@ -34,11 +34,11 @@ public T allocate(Slot slot) throws Exception {
     try {
       T obj = super.allocate(slot);
       long elapsed = System.currentTimeMillis() - start;
-      latencyRecorder.recordAllocationLatencySampleMillis(elapsed);
+      metricsRecorder.recordAllocationLatencySampleMillis(elapsed);
       return obj;
     } catch (Exception e) {
       long elapsed = System.currentTimeMillis() - start;
-      latencyRecorder.recordAllocationFailureLatencySampleMillis(elapsed);
+      metricsRecorder.recordAllocationFailureLatencySampleMillis(elapsed);
       throw e;
     }
   }
@@ -50,7 +50,7 @@ public void deallocate(T poolable) throws Exception {
       super.deallocate(poolable);
     } finally {
       long elapsed = System.currentTimeMillis() - start;
-      latencyRecorder.recordDeallocationLatencySampleMillis(elapsed);
+      metricsRecorder.recordDeallocationLatencySampleMillis(elapsed);
     }
   }
 }
diff --git a/src/main/java/stormpot/TimingReallocatorAdaptor.java b/src/main/java/stormpot/TimingReallocatorAdaptor.java
@@ -19,8 +19,8 @@ class TimingReallocatorAdaptor<T extends Poolable>
     extends TimingReallocatingAdaptor<T>
     implements Reallocator<T> {
   public TimingReallocatorAdaptor(
-      Reallocator<T> allocator, LatencyRecorder latencyRecorder) {
-    super(allocator, latencyRecorder);
+      Reallocator<T> allocator, MetricsRecorder metricsRecorder) {
+    super(allocator, metricsRecorder);
   }
 
   @Override
@@ -29,11 +29,11 @@ public T reallocate(Slot slot, T poolable) throws Exception {
     try {
       T obj = ((Reallocator<T>) allocator).reallocate(slot, poolable);
       long elapsed = System.currentTimeMillis() - start;
-      latencyRecorder.recordReallocationLatencySampleMillis(elapsed);
+      metricsRecorder.recordReallocationLatencySampleMillis(elapsed);
       return obj;
     } catch (Exception e) {
       long elapsed = System.currentTimeMillis() - start;
-      latencyRecorder.recordReallocationFailureLatencySampleMillis(elapsed);
+      metricsRecorder.recordReallocationFailureLatencySampleMillis(elapsed);
       throw e;
     }
   }
diff --git a/src/test/java/stormpot/ConfigTest.java b/src/test/java/stormpot/ConfigTest.java
diff --git a/src/test/java/stormpot/FixedMeanMetricsRecorder.java b/src/test/java/stormpot/FixedMeanMetricsRecorder.java
diff --git a/src/test/java/stormpot/LastSampleMetricsRecorder.java b/src/test/java/stormpot/LastSampleMetricsRecorder.java
diff --git a/src/test/java/stormpot/PoolTest.java b/src/test/java/stormpot/PoolTest.java

Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ public Throwable fillInStackTrace() {`
`51`	`51`	`private final BlockingQueue<BSlot<T>> dead;`
`52`	`52`	`private final BAllocThread<T> allocThread;`
`53`	`53`	`private final Expiration<? super T> deallocRule;`
`54`		`- private final LatencyRecorder latencyRecorder;`
	`54`	`+ private final MetricsRecorder metricsRecorder;`
`55`	`55`
`56`	`56`	`/**`
`57`	`57`	`* Special slot used to signal that the pool has been shut down.`
`@@ -76,7 +76,7 @@ public BlazePool(Config<T> config) {`
`76`	`76`	`config.validate();`
`77`	`77`	`allocThread = new BAllocThread<T>(live, dead, config, poisonPill);`
`78`	`78`	`deallocRule = config.getExpiration();`
`79`		`- latencyRecorder = config.getLatencyRecorder();`
	`79`	`+ metricsRecorder = config.getMetricsRecorder();`
`80`	`80`	`}`
`81`	`81`	`allocThread.start();`
`82`	`82`	`}`
`@@ -281,49 +281,54 @@ public boolean isShutDown() {`
`281`	`281`
`282`	`282`	`@Override`
`283`	`283`	`public double getObjectLifetimePercentile(double percentile) {`
`284`		`- if (latencyRecorder == null) {`
	`284`	`+ if (metricsRecorder == null) {`
`285`	`285`	`return Double.NaN;`
`286`	`286`	`}`
`287`		`- return latencyRecorder.getObjectLifetimePercentile(percentile);`
	`287`	`+ return metricsRecorder.getObjectLifetimePercentile(percentile);`
`288`	`288`	`}`
`289`	`289`
`290`	`290`	`@Override`
`291`	`291`	`public double getAllocationLatencyPercentile(double percentile) {`
`292`		`- if (latencyRecorder == null) {`
	`292`	`+ if (metricsRecorder == null) {`
`293`	`293`	`return Double.NaN;`
`294`	`294`	`}`
`295`		`- return latencyRecorder.getAllocationLatencyPercentile(percentile);`
	`295`	`+ return metricsRecorder.getAllocationLatencyPercentile(percentile);`
`296`	`296`	`}`
`297`	`297`
`298`	`298`	`@Override`
`299`	`299`	`public double getAllocationFailureLatencyPercentile(double percentile) {`
`300`		`- if (latencyRecorder == null) {`
	`300`	`+ if (metricsRecorder == null) {`
`301`	`301`	`return Double.NaN;`
`302`	`302`	`}`
`303`		`- return latencyRecorder.getAllocationFailureLatencyPercentile(percentile);`
	`303`	`+ return metricsRecorder.getAllocationFailureLatencyPercentile(percentile);`
`304`	`304`	`}`
`305`	`305`
`306`	`306`	`@Override`
`307`	`307`	`public double getReallocationLatencyPercentile(double percentile) {`
`308`		`- if (latencyRecorder == null) {`
	`308`	`+ if (metricsRecorder == null) {`
`309`	`309`	`return Double.NaN;`
`310`	`310`	`}`
`311`		`- return latencyRecorder.getReallocationLatencyPercentile(percentile);`
	`311`	`+ return metricsRecorder.getReallocationLatencyPercentile(percentile);`
`312`	`312`	`}`
`313`	`313`
`314`	`314`	`@Override`
`315`	`315`	`public double getReallocationFailureLatencyPercentile(double percentile) {`
`316`		`- if (latencyRecorder == null) {`
	`316`	`+ if (metricsRecorder == null) {`
`317`	`317`	`return Double.NaN;`
`318`	`318`	`}`
`319`		`- return latencyRecorder.getReallocationFailurePercentile(percentile);`
	`319`	`+ return metricsRecorder.getReallocationFailurePercentile(percentile);`
`320`	`320`	`}`
`321`	`321`
`322`	`322`	`@Override`
`323`	`323`	`public double getDeallocationLatencyPercentile(double percentile) {`
`324`		`- if (latencyRecorder == null) {`
	`324`	`+ if (metricsRecorder == null) {`
`325`	`325`	`return Double.NaN;`
`326`	`326`	`}`
`327`		`- return latencyRecorder.getDeallocationLatencyPercentile(percentile);`
	`327`	`+ return metricsRecorder.getDeallocationLatencyPercentile(percentile);`
	`328`	`+ }`
	`329`	`+`
	`330`	`+ @Override`
	`331`	`+ public long getLeakedObjectsCount() {`
	`332`	`+ return metricsRecorder.getLeakedObjectsCount();`
`328`	`333`	`}`
`329`	`334`	`}`
Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ public class Config<T extends Poolable> {`
`55`	`55`	`private Expiration<? super T> expiration =`
`56`	`56`	`new TimeSpreadExpiration(480000, 600000, TimeUnit.MILLISECONDS); // 8 to 10 minutes`
`57`	`57`	`private Allocator<?> allocator;`
`58`		`- private LatencyRecorder latencyRecorder;`
	`58`	`+ private MetricsRecorder metricsRecorder;`
`59`	`59`
`60`	`60`	`/**`
`61`	`61`	`* Build a new empty Config object. Most settings have reasonable default`
`@@ -167,13 +167,13 @@ public synchronized Expiration<? super T> getExpiration() {`
`167`	`167`	`return expiration;`
`168`	`168`	`}`
`169`	`169`
`170`		`- public synchronized Config<T> setLatencyRecorder(LatencyRecorder latencyRecorder) {`
`171`		`- this.latencyRecorder = latencyRecorder;`
	`170`	`+ public synchronized Config<T> setMetricsRecorder(MetricsRecorder metricsRecorder) {`
	`171`	`+ this.metricsRecorder = metricsRecorder;`
`172`	`172`	`return this;`
`173`	`173`	`}`
`174`	`174`
`175`		`- public synchronized LatencyRecorder getLatencyRecorder() {`
`176`		`- return latencyRecorder;`
	`175`	`+ public synchronized MetricsRecorder getMetricsRecorder() {`
	`176`	`+ return metricsRecorder;`
`177`	`177`	`}`
`178`	`178`
`179`	`179`	`/**`
`@@ -202,18 +202,18 @@ Reallocator<T> getAdaptedReallocator() {`
`202`	`202`	`if (allocator == null) {`
`203`	`203`	`return null;`
`204`	`204`	`}`
`205`		`- if (latencyRecorder == null) {`
	`205`	`+ if (metricsRecorder == null) {`
`206`	`206`	`if (allocator instanceof Reallocator) {`
`207`	`207`	`return (Reallocator<T>) allocator;`
`208`	`208`	`}`
`209`	`209`	`return new ReallocatingAdaptor<T>((Allocator<T>) allocator);`
`210`	`210`	`} else {`
`211`	`211`	`if (allocator instanceof Reallocator) {`
`212`	`212`	`return new TimingReallocatorAdaptor<T>(`
`213`		`- (Reallocator<T>) allocator, latencyRecorder);`
	`213`	`+ (Reallocator<T>) allocator, metricsRecorder);`
`214`	`214`	`}`
`215`	`215`	`return new TimingReallocatingAdaptor<T>(`
`216`		`- (Allocator<T>) allocator, latencyRecorder);`
	`216`	`+ (Allocator<T>) allocator, metricsRecorder);`
`217`	`217`	`}`
`218`	`218`	`}`
`219`	`219`	`}`
Original file line number	Diff line number	Diff line change
`@@ -83,4 +83,6 @@ public interface ManagedPool {`
`83`	`83`	`double getReallocationFailureLatencyPercentile(double percentile);`
`84`	`84`
`85`	`85`	`double getDeallocationLatencyPercentile(double percentile);`
	`86`	`+`
	`87`	`+ long getLeakedObjectsCount();`
`86`	`88`	`}`