2 * Copyright (c) 2014 Brocade Communications Systems, Inc. and others. All rights reserved.
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
9 package org.opendaylight.controller.cluster.datastore;
11 import akka.util.Timeout;
12 import com.google.common.annotations.VisibleForTesting;
13 import com.google.common.collect.Sets;
15 import java.util.concurrent.TimeUnit;
16 import org.apache.commons.lang3.text.WordUtils;
17 import org.opendaylight.controller.cluster.common.actor.AkkaConfigurationReader;
18 import org.opendaylight.controller.cluster.common.actor.FileAkkaConfigurationReader;
19 import org.opendaylight.controller.cluster.raft.ConfigParams;
20 import org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl;
21 import org.opendaylight.controller.cluster.raft.PeerAddressResolver;
22 import org.opendaylight.controller.md.sal.dom.store.impl.InMemoryDOMDataStoreConfigProperties;
23 import scala.concurrent.duration.Duration;
24 import scala.concurrent.duration.FiniteDuration;
27 * Contains contextual data for a data store.
29 * @author Thomas Pantelis
31 public class DatastoreContext {
32 public static final String METRICS_DOMAIN = "org.opendaylight.controller.cluster.datastore";
34 public static final Duration DEFAULT_SHARD_TRANSACTION_IDLE_TIMEOUT = Duration.create(10, TimeUnit.MINUTES);
35 public static final int DEFAULT_OPERATION_TIMEOUT_IN_MS = 5000;
36 public static final int DEFAULT_SHARD_TX_COMMIT_TIMEOUT_IN_SECONDS = 30;
37 public static final int DEFAULT_JOURNAL_RECOVERY_BATCH_SIZE = 1000;
38 public static final int DEFAULT_SNAPSHOT_BATCH_COUNT = 20000;
39 public static final int DEFAULT_HEARTBEAT_INTERVAL_IN_MILLIS = 500;
40 public static final int DEFAULT_ISOLATED_LEADER_CHECK_INTERVAL_IN_MILLIS = DEFAULT_HEARTBEAT_INTERVAL_IN_MILLIS * 10;
41 public static final int DEFAULT_SHARD_TX_COMMIT_QUEUE_CAPACITY = 50000;
42 public static final Timeout DEFAULT_SHARD_INITIALIZATION_TIMEOUT = new Timeout(5, TimeUnit.MINUTES);
43 public static final Timeout DEFAULT_SHARD_LEADER_ELECTION_TIMEOUT = new Timeout(30, TimeUnit.SECONDS);
44 public static final boolean DEFAULT_PERSISTENT = true;
45 public static final FileAkkaConfigurationReader DEFAULT_CONFIGURATION_READER = new FileAkkaConfigurationReader();
46 public static final int DEFAULT_SHARD_SNAPSHOT_DATA_THRESHOLD_PERCENTAGE = 12;
47 public static final int DEFAULT_SHARD_ELECTION_TIMEOUT_FACTOR = 2;
48 public static final int DEFAULT_TX_CREATION_INITIAL_RATE_LIMIT = 100;
49 public static final String UNKNOWN_DATA_STORE_TYPE = "unknown";
50 public static final int DEFAULT_SHARD_BATCHED_MODIFICATION_COUNT = 1000;
51 public static final long DEFAULT_SHARD_COMMIT_QUEUE_EXPIRY_TIMEOUT_IN_MS = TimeUnit.MILLISECONDS.convert(2, TimeUnit.MINUTES);
52 public static final int DEFAULT_SHARD_SNAPSHOT_CHUNK_SIZE = 2048000;
54 private static Set<String> globalDatastoreTypes = Sets.newConcurrentHashSet();
56 private InMemoryDOMDataStoreConfigProperties dataStoreProperties;
57 private Duration shardTransactionIdleTimeout = DatastoreContext.DEFAULT_SHARD_TRANSACTION_IDLE_TIMEOUT;
58 private long operationTimeoutInMillis = DEFAULT_OPERATION_TIMEOUT_IN_MS;
59 private String dataStoreMXBeanType;
60 private int shardTransactionCommitTimeoutInSeconds = DEFAULT_SHARD_TX_COMMIT_TIMEOUT_IN_SECONDS;
61 private int shardTransactionCommitQueueCapacity = DEFAULT_SHARD_TX_COMMIT_QUEUE_CAPACITY;
62 private Timeout shardInitializationTimeout = DEFAULT_SHARD_INITIALIZATION_TIMEOUT;
63 private Timeout shardLeaderElectionTimeout = DEFAULT_SHARD_LEADER_ELECTION_TIMEOUT;
64 private boolean persistent = DEFAULT_PERSISTENT;
65 private AkkaConfigurationReader configurationReader = DEFAULT_CONFIGURATION_READER;
66 private long transactionCreationInitialRateLimit = DEFAULT_TX_CREATION_INITIAL_RATE_LIMIT;
67 private final DefaultConfigParamsImpl raftConfig = new DefaultConfigParamsImpl();
68 private String dataStoreType = UNKNOWN_DATA_STORE_TYPE;
69 private int shardBatchedModificationCount = DEFAULT_SHARD_BATCHED_MODIFICATION_COUNT;
70 private boolean writeOnlyTransactionOptimizationsEnabled = true;
71 private long shardCommitQueueExpiryTimeoutInMillis = DEFAULT_SHARD_COMMIT_QUEUE_EXPIRY_TIMEOUT_IN_MS;
72 private boolean transactionDebugContextEnabled = false;
73 private String shardManagerPersistenceId;
75 public static Set<String> getGlobalDatastoreTypes() {
76 return globalDatastoreTypes;
79 private DatastoreContext() {
80 setShardJournalRecoveryLogBatchSize(DEFAULT_JOURNAL_RECOVERY_BATCH_SIZE);
81 setSnapshotBatchCount(DEFAULT_SNAPSHOT_BATCH_COUNT);
82 setHeartbeatInterval(DEFAULT_HEARTBEAT_INTERVAL_IN_MILLIS);
83 setIsolatedLeaderCheckInterval(DEFAULT_ISOLATED_LEADER_CHECK_INTERVAL_IN_MILLIS);
84 setSnapshotDataThresholdPercentage(DEFAULT_SHARD_SNAPSHOT_DATA_THRESHOLD_PERCENTAGE);
85 setElectionTimeoutFactor(DEFAULT_SHARD_ELECTION_TIMEOUT_FACTOR);
86 setShardSnapshotChunkSize(DEFAULT_SHARD_SNAPSHOT_CHUNK_SIZE);
89 private DatastoreContext(DatastoreContext other) {
90 this.dataStoreProperties = other.dataStoreProperties;
91 this.shardTransactionIdleTimeout = other.shardTransactionIdleTimeout;
92 this.operationTimeoutInMillis = other.operationTimeoutInMillis;
93 this.dataStoreMXBeanType = other.dataStoreMXBeanType;
94 this.shardTransactionCommitTimeoutInSeconds = other.shardTransactionCommitTimeoutInSeconds;
95 this.shardTransactionCommitQueueCapacity = other.shardTransactionCommitQueueCapacity;
96 this.shardInitializationTimeout = other.shardInitializationTimeout;
97 this.shardLeaderElectionTimeout = other.shardLeaderElectionTimeout;
98 this.persistent = other.persistent;
99 this.configurationReader = other.configurationReader;
100 this.transactionCreationInitialRateLimit = other.transactionCreationInitialRateLimit;
101 this.dataStoreType = other.dataStoreType;
102 this.shardBatchedModificationCount = other.shardBatchedModificationCount;
103 this.writeOnlyTransactionOptimizationsEnabled = other.writeOnlyTransactionOptimizationsEnabled;
104 this.shardCommitQueueExpiryTimeoutInMillis = other.shardCommitQueueExpiryTimeoutInMillis;
105 this.transactionDebugContextEnabled = other.transactionDebugContextEnabled;
106 this.shardManagerPersistenceId = shardManagerPersistenceId;
108 setShardJournalRecoveryLogBatchSize(other.raftConfig.getJournalRecoveryLogBatchSize());
109 setSnapshotBatchCount(other.raftConfig.getSnapshotBatchCount());
110 setHeartbeatInterval(other.raftConfig.getHeartBeatInterval().toMillis());
111 setIsolatedLeaderCheckInterval(other.raftConfig.getIsolatedCheckIntervalInMillis());
112 setSnapshotDataThresholdPercentage(other.raftConfig.getSnapshotDataThresholdPercentage());
113 setElectionTimeoutFactor(other.raftConfig.getElectionTimeoutFactor());
114 setCustomRaftPolicyImplementation(other.raftConfig.getCustomRaftPolicyImplementationClass());
115 setShardSnapshotChunkSize(other.raftConfig.getSnapshotChunkSize());
116 setPeerAddressResolver(other.raftConfig.getPeerAddressResolver());
119 public static Builder newBuilder() {
120 return new Builder(new DatastoreContext());
123 public static Builder newBuilderFrom(DatastoreContext context) {
124 return new Builder(new DatastoreContext(context));
127 public InMemoryDOMDataStoreConfigProperties getDataStoreProperties() {
128 return dataStoreProperties;
131 public Duration getShardTransactionIdleTimeout() {
132 return shardTransactionIdleTimeout;
135 public String getDataStoreMXBeanType() {
136 return dataStoreMXBeanType;
139 public long getOperationTimeoutInMillis() {
140 return operationTimeoutInMillis;
143 public ConfigParams getShardRaftConfig() {
147 public int getShardTransactionCommitTimeoutInSeconds() {
148 return shardTransactionCommitTimeoutInSeconds;
151 public int getShardTransactionCommitQueueCapacity() {
152 return shardTransactionCommitQueueCapacity;
155 public Timeout getShardInitializationTimeout() {
156 return shardInitializationTimeout;
159 public Timeout getShardLeaderElectionTimeout() {
160 return shardLeaderElectionTimeout;
163 public boolean isPersistent() {
167 public AkkaConfigurationReader getConfigurationReader() {
168 return configurationReader;
171 public long getShardElectionTimeoutFactor(){
172 return raftConfig.getElectionTimeoutFactor();
175 public String getDataStoreType(){
176 return dataStoreType;
179 public long getTransactionCreationInitialRateLimit() {
180 return transactionCreationInitialRateLimit;
183 public String getShardManagerPersistenceId() {
184 return shardManagerPersistenceId;
187 private void setPeerAddressResolver(PeerAddressResolver resolver) {
188 raftConfig.setPeerAddressResolver(resolver);
191 private void setHeartbeatInterval(long shardHeartbeatIntervalInMillis){
192 raftConfig.setHeartBeatInterval(new FiniteDuration(shardHeartbeatIntervalInMillis,
193 TimeUnit.MILLISECONDS));
196 private void setShardJournalRecoveryLogBatchSize(int shardJournalRecoveryLogBatchSize){
197 raftConfig.setJournalRecoveryLogBatchSize(shardJournalRecoveryLogBatchSize);
201 private void setIsolatedLeaderCheckInterval(long shardIsolatedLeaderCheckIntervalInMillis) {
202 raftConfig.setIsolatedLeaderCheckInterval(
203 new FiniteDuration(shardIsolatedLeaderCheckIntervalInMillis, TimeUnit.MILLISECONDS));
206 private void setElectionTimeoutFactor(long shardElectionTimeoutFactor) {
207 raftConfig.setElectionTimeoutFactor(shardElectionTimeoutFactor);
210 private void setCustomRaftPolicyImplementation(String customRaftPolicyImplementation) {
211 raftConfig.setCustomRaftPolicyImplementationClass(customRaftPolicyImplementation);
214 private void setSnapshotDataThresholdPercentage(int shardSnapshotDataThresholdPercentage) {
215 raftConfig.setSnapshotDataThresholdPercentage(shardSnapshotDataThresholdPercentage);
218 private void setSnapshotBatchCount(long shardSnapshotBatchCount) {
219 raftConfig.setSnapshotBatchCount(shardSnapshotBatchCount);
222 private void setShardSnapshotChunkSize(int shardSnapshotChunkSize) {
223 raftConfig.setSnapshotChunkSize(shardSnapshotChunkSize);
226 public int getShardBatchedModificationCount() {
227 return shardBatchedModificationCount;
230 public boolean isWriteOnlyTransactionOptimizationsEnabled() {
231 return writeOnlyTransactionOptimizationsEnabled;
234 public long getShardCommitQueueExpiryTimeoutInMillis() {
235 return shardCommitQueueExpiryTimeoutInMillis;
238 public boolean isTransactionDebugContextEnabled() {
239 return transactionDebugContextEnabled;
242 public int getShardSnapshotChunkSize() {
243 return raftConfig.getSnapshotChunkSize();
246 public static class Builder {
247 private final DatastoreContext datastoreContext;
248 private int maxShardDataChangeExecutorPoolSize =
249 InMemoryDOMDataStoreConfigProperties.DEFAULT_MAX_DATA_CHANGE_EXECUTOR_POOL_SIZE;
250 private int maxShardDataChangeExecutorQueueSize =
251 InMemoryDOMDataStoreConfigProperties.DEFAULT_MAX_DATA_CHANGE_EXECUTOR_QUEUE_SIZE;
252 private int maxShardDataChangeListenerQueueSize =
253 InMemoryDOMDataStoreConfigProperties.DEFAULT_MAX_DATA_CHANGE_LISTENER_QUEUE_SIZE;
254 private int maxShardDataStoreExecutorQueueSize =
255 InMemoryDOMDataStoreConfigProperties.DEFAULT_MAX_DATA_STORE_EXECUTOR_QUEUE_SIZE;
257 private Builder(DatastoreContext datastoreContext) {
258 this.datastoreContext = datastoreContext;
260 if(datastoreContext.getDataStoreProperties() != null) {
261 maxShardDataChangeExecutorPoolSize =
262 datastoreContext.getDataStoreProperties().getMaxDataChangeExecutorPoolSize();
263 maxShardDataChangeExecutorQueueSize =
264 datastoreContext.getDataStoreProperties().getMaxDataChangeExecutorQueueSize();
265 maxShardDataChangeListenerQueueSize =
266 datastoreContext.getDataStoreProperties().getMaxDataChangeListenerQueueSize();
267 maxShardDataStoreExecutorQueueSize =
268 datastoreContext.getDataStoreProperties().getMaxDataStoreExecutorQueueSize();
272 public Builder boundedMailboxCapacity(int boundedMailboxCapacity) {
273 // TODO - this is defined in the yang DataStoreProperties but not currently used.
277 public Builder enableMetricCapture(boolean enableMetricCapture) {
278 // TODO - this is defined in the yang DataStoreProperties but not currently used.
283 public Builder shardTransactionIdleTimeout(long timeout, TimeUnit unit) {
284 datastoreContext.shardTransactionIdleTimeout = Duration.create(timeout, unit);
288 public Builder shardTransactionIdleTimeoutInMinutes(long timeout) {
289 return shardTransactionIdleTimeout(timeout, TimeUnit.MINUTES);
292 public Builder operationTimeoutInSeconds(int operationTimeoutInSeconds) {
293 datastoreContext.operationTimeoutInMillis = TimeUnit.SECONDS.toMillis(operationTimeoutInSeconds);
297 public Builder operationTimeoutInMillis(long operationTimeoutInMillis) {
298 datastoreContext.operationTimeoutInMillis = operationTimeoutInMillis;
302 public Builder dataStoreMXBeanType(String dataStoreMXBeanType) {
303 datastoreContext.dataStoreMXBeanType = dataStoreMXBeanType;
307 public Builder shardTransactionCommitTimeoutInSeconds(int shardTransactionCommitTimeoutInSeconds) {
308 datastoreContext.shardTransactionCommitTimeoutInSeconds = shardTransactionCommitTimeoutInSeconds;
312 public Builder shardJournalRecoveryLogBatchSize(int shardJournalRecoveryLogBatchSize) {
313 datastoreContext.setShardJournalRecoveryLogBatchSize(shardJournalRecoveryLogBatchSize);
317 public Builder shardSnapshotBatchCount(int shardSnapshotBatchCount) {
318 datastoreContext.setSnapshotBatchCount(shardSnapshotBatchCount);
322 public Builder shardSnapshotDataThresholdPercentage(int shardSnapshotDataThresholdPercentage) {
323 datastoreContext.setSnapshotDataThresholdPercentage(shardSnapshotDataThresholdPercentage);
327 public Builder shardHeartbeatIntervalInMillis(int shardHeartbeatIntervalInMillis) {
328 datastoreContext.setHeartbeatInterval(shardHeartbeatIntervalInMillis);
332 public Builder shardTransactionCommitQueueCapacity(int shardTransactionCommitQueueCapacity) {
333 datastoreContext.shardTransactionCommitQueueCapacity = shardTransactionCommitQueueCapacity;
337 public Builder shardInitializationTimeout(long timeout, TimeUnit unit) {
338 datastoreContext.shardInitializationTimeout = new Timeout(timeout, unit);
342 public Builder shardInitializationTimeoutInSeconds(long timeout) {
343 return shardInitializationTimeout(timeout, TimeUnit.SECONDS);
346 public Builder shardLeaderElectionTimeout(long timeout, TimeUnit unit) {
347 datastoreContext.shardLeaderElectionTimeout = new Timeout(timeout, unit);
351 public Builder shardLeaderElectionTimeoutInSeconds(long timeout) {
352 return shardLeaderElectionTimeout(timeout, TimeUnit.SECONDS);
355 public Builder configurationReader(AkkaConfigurationReader configurationReader){
356 datastoreContext.configurationReader = configurationReader;
360 public Builder persistent(boolean persistent){
361 datastoreContext.persistent = persistent;
365 public Builder shardIsolatedLeaderCheckIntervalInMillis(int shardIsolatedLeaderCheckIntervalInMillis) {
366 datastoreContext.setIsolatedLeaderCheckInterval(shardIsolatedLeaderCheckIntervalInMillis);
370 public Builder shardElectionTimeoutFactor(long shardElectionTimeoutFactor){
371 datastoreContext.setElectionTimeoutFactor(shardElectionTimeoutFactor);
375 public Builder transactionCreationInitialRateLimit(long initialRateLimit){
376 datastoreContext.transactionCreationInitialRateLimit = initialRateLimit;
380 public Builder dataStoreType(String dataStoreType){
381 datastoreContext.dataStoreType = dataStoreType;
382 datastoreContext.dataStoreMXBeanType = "Distributed" + WordUtils.capitalize(dataStoreType) + "Datastore";
386 public Builder shardBatchedModificationCount(int shardBatchedModificationCount) {
387 datastoreContext.shardBatchedModificationCount = shardBatchedModificationCount;
391 public Builder writeOnlyTransactionOptimizationsEnabled(boolean value) {
392 datastoreContext.writeOnlyTransactionOptimizationsEnabled = value;
396 public Builder shardCommitQueueExpiryTimeoutInMillis(long value) {
397 datastoreContext.shardCommitQueueExpiryTimeoutInMillis = value;
401 public Builder shardCommitQueueExpiryTimeoutInSeconds(long value) {
402 datastoreContext.shardCommitQueueExpiryTimeoutInMillis = TimeUnit.MILLISECONDS.convert(
403 value, TimeUnit.SECONDS);
407 public Builder transactionDebugContextEnabled(boolean value) {
408 datastoreContext.transactionDebugContextEnabled = value;
412 public Builder maxShardDataChangeExecutorPoolSize(int maxShardDataChangeExecutorPoolSize) {
413 this.maxShardDataChangeExecutorPoolSize = maxShardDataChangeExecutorPoolSize;
417 public Builder maxShardDataChangeExecutorQueueSize(int maxShardDataChangeExecutorQueueSize) {
418 this.maxShardDataChangeExecutorQueueSize = maxShardDataChangeExecutorQueueSize;
422 public Builder maxShardDataChangeListenerQueueSize(int maxShardDataChangeListenerQueueSize) {
423 this.maxShardDataChangeListenerQueueSize = maxShardDataChangeListenerQueueSize;
427 public Builder maxShardDataStoreExecutorQueueSize(int maxShardDataStoreExecutorQueueSize) {
428 this.maxShardDataStoreExecutorQueueSize = maxShardDataStoreExecutorQueueSize;
433 * For unit tests only.
436 public Builder shardManagerPersistenceId(String id) {
437 datastoreContext.shardManagerPersistenceId = id;
441 public DatastoreContext build() {
442 datastoreContext.dataStoreProperties = InMemoryDOMDataStoreConfigProperties.create(
443 maxShardDataChangeExecutorPoolSize, maxShardDataChangeExecutorQueueSize,
444 maxShardDataChangeListenerQueueSize, maxShardDataStoreExecutorQueueSize);
446 if(datastoreContext.dataStoreType != null) {
447 globalDatastoreTypes.add(datastoreContext.dataStoreType);
450 return datastoreContext;
453 public Builder customRaftPolicyImplementation(String customRaftPolicyImplementation) {
454 datastoreContext.setCustomRaftPolicyImplementation(customRaftPolicyImplementation);
458 public Builder shardSnapshotChunkSize(int shardSnapshotChunkSize) {
459 datastoreContext.setShardSnapshotChunkSize(shardSnapshotChunkSize);
463 public Builder shardPeerAddressResolver(PeerAddressResolver resolver) {
464 datastoreContext.setPeerAddressResolver(resolver);