Fix warnings/javadocs in sal-distributed-datastore

[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / main / java / org / opendaylight / controller / cluster / datastore / TransactionRateLimitingCallback.java

diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/TransactionRateLimitingCallback.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/TransactionRateLimitingCallback.java
index 1202a909d54bfb8faf69adce2a47cded7391853d..f35e30a06ccb1c8a95b4ff843ac22abedc21d168 100644 (file)
--- a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/TransactionRateLimitingCallback.java
+++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/TransactionRateLimitingCallback.java
@@ -8,70 +8,63 @@
 
 package org.opendaylight.controller.cluster.datastore;
 
-import com.codahale.metrics.Snapshot;
 import com.codahale.metrics.Timer;
+import com.google.common.annotations.VisibleForTesting;
 import com.google.common.base.Preconditions;
+import com.google.common.base.Ticker;
 import java.util.concurrent.TimeUnit;
 import org.opendaylight.controller.cluster.datastore.utils.ActorContext;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 
 /**
  * TransactionRateLimitingCallback computes the new transaction rate limit on the successful completion of a
- * transaction
+ * transaction.
  */
-public class TransactionRateLimitingCallback implements OperationCallback{
+public class TransactionRateLimitingCallback implements OperationCallback {
+    private static Ticker TICKER = Ticker.systemTicker();
 
-    private static final Logger LOG = LoggerFactory.getLogger(TransactionRateLimitingCallback.class);
-    private static final String COMMIT = "commit";
+    private enum State {
+        STOPPED,
+        RUNNING,
+        PAUSED
+    }
 
     private final Timer commitTimer;
-    private final ActorContext actorContext;
-    private Timer.Context timerContext;
+    private long startTime;
+    private long elapsedTime;
+    private volatile State state = State.STOPPED;
 
-    TransactionRateLimitingCallback(ActorContext actorContext){
-        this.actorContext = actorContext;
-        commitTimer = actorContext.getOperationTimer(COMMIT);
+    TransactionRateLimitingCallback(ActorContext actorContext) {
+        commitTimer = actorContext.getOperationTimer(ActorContext.COMMIT);
     }
 
     @Override
     public void run() {
-        timerContext = commitTimer.time();
+        Preconditions.checkState(state == State.STOPPED, "state is not STOPPED");
+        resume();
     }
 
     @Override
-    public void success() {
-        Preconditions.checkState(timerContext != null, "Call run before success");
-        timerContext.stop();
-
-        Snapshot timerSnapshot = commitTimer.getSnapshot();
-        double newRateLimit = 0;
-
-        long commitTimeoutInSeconds = actorContext.getDatastoreContext()
-                .getShardTransactionCommitTimeoutInSeconds();
-        long commitTimeoutInNanos = TimeUnit.SECONDS.toNanos(commitTimeoutInSeconds);
-
-        // Find the time that it takes for transactions to get executed in every 10th percentile
-        // Compute the rate limit for that percentile and sum it up
-        for(int i=1;i<=10;i++){
-            // Get the amount of time transactions take in the i*10th percentile
-            double percentileTimeInNanos = timerSnapshot.getValue(i * 0.1D);
-
-            if(percentileTimeInNanos > 0) {
-                // Figure out the rate limit for the i*10th percentile in nanos
-                double percentileRateLimit = ((double) commitTimeoutInNanos / percentileTimeInNanos);
-
-                // Add the percentileRateLimit to the total rate limit
-                newRateLimit += percentileRateLimit;
-            }
+    public void pause() {
+        if (state == State.RUNNING) {
+            elapsedTime += TICKER.read() - startTime;
+            state = State.PAUSED;
         }
+    }
 
-        // Compute the rate limit per second
-        newRateLimit = newRateLimit/(commitTimeoutInSeconds*10);
-
-        LOG.debug("Data Store {} commit rateLimit adjusted to {}", actorContext.getDataStoreType(), newRateLimit);
+    @Override
+    public void resume() {
+        if (state != State.RUNNING) {
+            startTime = TICKER.read();
+            state = State.RUNNING;
+        }
+    }
 
-        actorContext.setTxCreationLimit(newRateLimit);
+    @Override
+    public void success() {
+        Preconditions.checkState(state != State.STOPPED, "state is STOPPED");
+        pause();
+        commitTimer.update(elapsedTime, TimeUnit.NANOSECONDS);
+        state = State.STOPPED;
     }
 
     @Override
@@ -80,4 +73,9 @@ public class TransactionRateLimitingCallback implements OperationCallback{
         // the default transaction commit timeout. Using the timeout information to figure out the rate limit is
         // not going to be useful - so we leave it as it is
     }
-}
\ No newline at end of file
+
+    @VisibleForTesting
+    static void setTicker(Ticker ticker) {
+        TICKER = ticker;
+    }
+}