250a8149ff1e0b77e6f203c275beb473c03d8c2e
[controller.git] / opendaylight / md-sal / sal-clustering-config / src / main / resources / initial / datastore.cfg
1 # This file specifies property settings for the clustered data store to control its behavior. A
2 # property may be applied to every data store type ("config" and "operational") or can be customized
3 # differently for each data store type by prefixing the data store type + '.'. For example, specifying
4 # the "shard-election-timeout-factor" property would be applied to both data stores whereas specifying
5 # "operational.shard-election-timeout-factor" would only apply to the "operational" data store. Similarly,
6 # specifying "config.shard-election-timeout-factor" would only apply to the "config" data store.
7
8 # The multiplication factor to be used to determine shard election timeout. The shard election timeout
9 # is determined by multiplying shardHeartbeatIntervalInMillis with the shardElectionTimeoutFactor.
10 shard-election-timeout-factor=20
11
12 # The interval at which a shard will send a heart beat message to its remote shard.
13 #shard-heartbeat-interval-in-millis=500
14
15 # The amount by which to divide election timeout in case of a candidate. This serves as a counter-balance
16 # to shard-election-timeout-factor. The default value is 1, i.e. election timeout is the same in all
17 # situations.
18 #shard-candidate-election-timeout-divisor=1
19
20 # The maximum amount of time to wait for a shard to elect a leader before failing an operation (eg transaction create).
21 #shard-leader-election-timeout-in-seconds=30
22
23 # Enable or disable data persistence.
24 #persistent=true
25
26 # Disable persistence for the operational data store by default.
27 operational.persistent=false
28
29 # The maximum amount of time a shard transaction can be idle without receiving any messages before it self-destructs.
30 #shard-transaction-idle-timeout-in-minutes=10
31
32 # The maximum amount of time a shard transaction three-phase commit can be idle without receiving the
33 # next messages before it aborts the transaction.
34 #shard-transaction-commit-timeout-in-seconds=30
35
36 # The maximum allowed capacity for each shard's transaction commit queue.
37 #shard-transaction-commit-queue-capacity=20000
38
39 # The maximum amount of time to wait for a shard to initialize from persistence on startup before
40 # failing an operation (eg transaction create and change listener registration).
41 #shard-initialization-timeout-in-seconds=300
42
43 # The minimum number of entries to be present in the in-memory journal log before a snapshot is to be taken.
44 #shard-snapshot-batch-count=20000
45
46 # The percentage of Runtime.totalMemory() used by the in-memory journal log before a snapshot is to be taken.
47 #shard-snapshot-data-threshold-percentage=12
48
49 # The interval at which the leader of the shard will check if its majority followers are active and
50 # term itself as isolated.
51 #shard-isolated-leader-check-interval-in-millis=5000
52
53 # The number of transaction modification operations (put, merge, delete) to batch before sending to the
54 # shard transaction actor. Batching improves performance as less modifications messages are sent to the
55 # actor and thus lessens the chance that the transaction actor's mailbox queue could get full.
56 #shard-batched-modification-count=1000
57
58 # The maximum amount of time for akka operations (remote or local) to complete before failing.
59 #operation-timeout-in-seconds=5
60
61 # The initial number of transactions per second that are allowed before the data store should begin
62 # applying back pressure. This number is only used as an initial guidance, subsequently the datastore
63 # measures the latency for a commit and auto-adjusts the rate limit.
64 #transaction-creation-initial-rate-limit=100
65
66 # The maximum thread pool size for each shard's data store data change notification executor.
67 #max-shard-data-change-executor-pool-size=20
68
69 # The maximum queue size for each shard's data store data change notification executor.
70 #max-shard-data-change-executor-queue-size=1000
71
72 # The maximum queue size for each shard's data store data change listener.
73 #max-shard-data-change-listener-queue-size=1000
74
75 # The maximum queue size for each shard's data store executor.
76 #max-shard-data-store-executor-queue-size=5000
77
78 # A fully qualified java class name. The class should implement
79 # org.opendaylight.controller.cluster.raft.policy.RaftPolicy. This java class should be
80 # accessible to the distributed data store OSGi module so that it can be dynamically loaded via
81 # reflection. For now let's assume that these classes to customize raft behaviors should be
82 # present in the distributed data store module itself. If this property is set to a class which
83 # cannot be found then the default raft policy will be applied
84 #custom-raft-policy-implementation=
85
86 # When fragmenting messages thru the akka remoting framework, this is the maximum size in bytes
87 # for a message slice.
88 #maximum-message-slice-size=20480000
89
90 # Enable tell-based protocol between frontend (applications) and backend (shards). Using this protocol
91 # should avoid AskTimeoutExceptions seen under heavy load. Defaults to false (use ask-based protocol).
92 #use-tell-based-protocol=true
93
94 # Tune the maximum number of entries a follower is allowed to lag behind the leader before it is
95 # considered out-of-sync. This flag may require tuning in face of a large number of small transactions.
96 #sync-index-threshold=10
97
98 # Record new transaction allocation stack trace, useful for debugging.  This makes the log include
99 # the stack trace of the creator of the Tx when there is an exception when the transaction is submitted 
100 # (e.g. for a failed validation).  Defaults to false due to performance impact.
101 #transaction-debug-context-enabled=true

©2013 OpenDaylight, A Linux Foundation Collaborative Project. All Rights Reserved.
OpenDaylight is a registered trademark of The OpenDaylight Project, Inc.
Linux Foundation and OpenDaylight are registered trademarks of the Linux Foundation.
Linux is a registered trademark of Linus Torvalds.