opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/DefaultConfigParamsImpl.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.controller.cluster.raft;
   9
  10 import com.google.common.base.Preconditions;
  11 import com.google.common.base.Strings;
  12 import com.google.common.base.Supplier;
  13 import com.google.common.base.Suppliers;
  14 import java.util.concurrent.TimeUnit;
  15 import javax.annotation.Nonnull;
  16 import org.opendaylight.controller.cluster.raft.policy.DefaultRaftPolicy;
  17 import org.opendaylight.controller.cluster.raft.policy.RaftPolicy;
  18 import org.slf4j.Logger;
  19 import org.slf4j.LoggerFactory;
  20 import scala.concurrent.duration.FiniteDuration;
  21
  22 /**
  23  * Default implementation of the ConfigParams
  24  *
  25  * If no implementation is provided for ConfigParams, then this will be used.
  26  */
  27 public class DefaultConfigParamsImpl implements ConfigParams {
  28
  29     private static final Logger LOG = LoggerFactory.getLogger(DefaultConfigParamsImpl.class);
  30
  31     private static final int SNAPSHOT_BATCH_COUNT = 20000;
  32
  33     private static final int JOURNAL_RECOVERY_LOG_BATCH_SIZE = 1000;
  34
  35     /**
  36      * The maximum election time variance
  37      */
  38     private static final int ELECTION_TIME_MAX_VARIANCE = 100;
  39
  40     private static final int SNAPSHOT_CHUNK_SIZE = 2048 * 1000; //2MB
  41
  42
  43     /**
  44      * The interval at which a heart beat message will be sent to the remote
  45      * RaftActor
  46      * <p/>
  47      * Since this is set to 100 milliseconds the Election timeout should be
  48      * at least 200 milliseconds
  49      */
  50     public static final FiniteDuration HEART_BEAT_INTERVAL =
  51         new FiniteDuration(100, TimeUnit.MILLISECONDS);
  52
  53     private FiniteDuration heartBeatInterval = HEART_BEAT_INTERVAL;
  54     private long snapshotBatchCount = SNAPSHOT_BATCH_COUNT;
  55     private int journalRecoveryLogBatchSize = JOURNAL_RECOVERY_LOG_BATCH_SIZE;
  56     private long isolatedLeaderCheckInterval = HEART_BEAT_INTERVAL.$times(1000).toMillis();
  57     private FiniteDuration electionTimeOutInterval;
  58
  59     // 12 is just an arbitrary percentage. This is the amount of the total memory that a raft actor's
  60     // in-memory journal can use before it needs to snapshot
  61     private int snapshotDataThresholdPercentage = 12;
  62
  63     private int snapshotChunkSize = SNAPSHOT_CHUNK_SIZE;
  64
  65     private long electionTimeoutFactor = 2;
  66     private String customRaftPolicyImplementationClass;
  67
  68     private final Supplier<RaftPolicy> policySupplier = Suppliers.memoize(new PolicySupplier());
  69
  70     private PeerAddressResolver peerAddressResolver = NoopPeerAddressResolver.INSTANCE;
  71
  72     public void setHeartBeatInterval(FiniteDuration heartBeatInterval) {
  73         this.heartBeatInterval = heartBeatInterval;
  74         electionTimeOutInterval = null;
  75     }
  76
  77     public void setSnapshotBatchCount(long snapshotBatchCount) {
  78         this.snapshotBatchCount = snapshotBatchCount;
  79     }
  80
  81     public void setSnapshotDataThresholdPercentage(int snapshotDataThresholdPercentage){
  82         this.snapshotDataThresholdPercentage = snapshotDataThresholdPercentage;
  83     }
  84
  85     public void setSnapshotChunkSize(int snapshotChunkSize) {
  86         this.snapshotChunkSize = snapshotChunkSize;
  87     }
  88
  89     public void setJournalRecoveryLogBatchSize(int journalRecoveryLogBatchSize) {
  90         this.journalRecoveryLogBatchSize = journalRecoveryLogBatchSize;
  91     }
  92
  93     public void setIsolatedLeaderCheckInterval(FiniteDuration isolatedLeaderCheckInterval) {
  94         this.isolatedLeaderCheckInterval = isolatedLeaderCheckInterval.toMillis();
  95     }
  96
  97     public void setElectionTimeoutFactor(long electionTimeoutFactor){
  98         this.electionTimeoutFactor = electionTimeoutFactor;
  99         electionTimeOutInterval = null;
 100     }
 101
 102     public void setCustomRaftPolicyImplementationClass(String customRaftPolicyImplementationClass){
 103         this.customRaftPolicyImplementationClass = customRaftPolicyImplementationClass;
 104     }
 105
 106     public String getCustomRaftPolicyImplementationClass() {
 107         return customRaftPolicyImplementationClass;
 108     }
 109
 110     @Override
 111     public long getSnapshotBatchCount() {
 112         return snapshotBatchCount;
 113     }
 114
 115     @Override
 116     public int getSnapshotDataThresholdPercentage() {
 117         return snapshotDataThresholdPercentage;
 118     }
 119
 120
 121     @Override
 122     public FiniteDuration getHeartBeatInterval() {
 123         return heartBeatInterval;
 124     }
 125
 126     @Override
 127     public FiniteDuration getElectionTimeOutInterval() {
 128         if(electionTimeOutInterval == null) {
 129             electionTimeOutInterval = getHeartBeatInterval().$times(electionTimeoutFactor);
 130         }
 131
 132         return electionTimeOutInterval;
 133     }
 134
 135     @Override
 136     public int getElectionTimeVariance() {
 137         return ELECTION_TIME_MAX_VARIANCE;
 138     }
 139
 140     @Override
 141     public int getSnapshotChunkSize() {
 142         return snapshotChunkSize;
 143     }
 144
 145     @Override
 146     public int getJournalRecoveryLogBatchSize() {
 147         return journalRecoveryLogBatchSize;
 148     }
 149
 150     @Override
 151     public long getIsolatedCheckIntervalInMillis() {
 152         return isolatedLeaderCheckInterval;
 153     }
 154
 155     @Override
 156     public long getElectionTimeoutFactor() {
 157         return electionTimeoutFactor;
 158     }
 159
 160     @Override
 161     public RaftPolicy getRaftPolicy() {
 162         return policySupplier.get();
 163     }
 164
 165     private class PolicySupplier implements Supplier<RaftPolicy>{
 166         @Override
 167         public RaftPolicy get() {
 168             if(Strings.isNullOrEmpty(DefaultConfigParamsImpl.this.customRaftPolicyImplementationClass)){
 169                 LOG.debug("No custom RaftPolicy specified. Using DefaultRaftPolicy");
 170                 return DefaultRaftPolicy.INSTANCE;
 171             }
 172             try {
 173                 String className = DefaultConfigParamsImpl.this.customRaftPolicyImplementationClass;
 174                 LOG.info("Trying to use custom RaftPolicy {}", className);
 175                 Class c = Class.forName(className);
 176                 RaftPolicy obj = (RaftPolicy)c.newInstance();
 177                 return obj;
 178             } catch (Exception e) {
 179                 if(LOG.isDebugEnabled()) {
 180                     LOG.error("Could not create custom raft policy, will stick with default", e);
 181                 } else {
 182                     LOG.error("Could not create custom raft policy, will stick with default : cause = {}", e.getMessage());
 183                 }
 184             }
 185             return DefaultRaftPolicy.INSTANCE;
 186         }
 187     }
 188
 189     @Override
 190     public PeerAddressResolver getPeerAddressResolver() {
 191         return peerAddressResolver;
 192     }
 193
 194     public void setPeerAddressResolver(@Nonnull PeerAddressResolver peerAddressResolver) {
 195         this.peerAddressResolver = Preconditions.checkNotNull(peerAddressResolver);
 196     }
 197 }