ReliableStateManagerReplicatorSettings Class

Definition

Settings that configure the replicator

public class ReliableStateManagerReplicatorSettings
type ReliableStateManagerReplicatorSettings = class
Public Class ReliableStateManagerReplicatorSettings
Inheritance
System.Object
ReliableStateManagerReplicatorSettings
Derived

Constructors

ReliableStateManagerReplicatorSettings()

Properties

BatchAcknowledgementInterval

Gets or sets the amount of time that the replicator waits after receiving an operation before sending back an acknowledgment. The default value is 5 milliseconds.

CheckpointThresholdInMB

Gets or sets the checkpoint threshold. A checkpoint will be initiated when the log usage exceeds this value. Default value is 50. The unit is MB.

InitialCopyQueueSize

Gets or sets the initial size of the copy operation queue inside the replicator, which contains copy operations. Default value is 64. The value is the number of operations in the copy operation queue. Must be a power of 2.

InitialPrimaryReplicationQueueSize

Gets or sets the initial primary replication queue size. Default value is 64. The value is the number of operations in the primary replication queue. Must be a power of 2.

InitialSecondaryReplicationQueueSize

Gets or sets the initial secondary replication queue size. Default value is 64. The value is the number of operations in the secondary replication queue. Must be a power of 2.

MaxAccumulatedBackupLogSizeInMB

Gets or sets the max size for an accumulated backup log across backups. An incremental backup requests will fail if the backup logs generated by the request causes the total amount of logs accumulated including the last full backup to be greater than MaxAccumulatedBackupLogSizeInMB. In such cases, user is required to take a full backup. Default value is 800. The unit is MB.

MaxCopyQueueSize

Gets or sets the maximum size of the copy operation queue inside replicator, which contains copy operations. Default value is 1024. The value is the max number of operations in the copy operation queue. Must be a power of 2.

MaxMetadataSizeInKB

Gets or sets the amount of extra persistent storage space reserved for the replicator specified in kilobytes that is associated with this replica. This value must be a multiple of 4. The default value is 4. The unit is KB.

MaxPrimaryReplicationQueueMemorySize

Gets or sets the max primary replication queue memory size. Default value is 0, which implies there is no memory limitation. The unit is Bytes.

MaxPrimaryReplicationQueueSize

Gets or sets the max primary replication queue size. Default value is 1024. The value is the max number of operations in the primary replication queue. Must be a power of 2.

MaxRecordSizeInKB

Gets or sets the largest record size which the replicator may write specified in kilobytes for the log that is associated with this replica. This value must be a multiple of 4 and greater than or equal to 128. The default value is 1024. The unit is KB.

MaxReplicationMessageSize

Gets or sets the max replication message size. Default value is 50MB. The unit is Bytes.

MaxSecondaryReplicationQueueMemorySize

Gets or sets the max secondary replication queue memory size. Default value is 0, which implies there is no memory limitation. The unit is Bytes.

MaxSecondaryReplicationQueueSize

Gets or sets the max secondary replication queue size. Default value is 2048. The value is the max number of operations in the secondary replication queue. Must be a power of 2.

MaxStreamSizeInMB

Deprecated

MaxWriteQueueDepthInKB

Gets or sets the maximum write queue depth that the core logger can use as specified in kilobytes for the log that is associated with this replica. This value is the maximum number of bytes that can be outstanding during core logger updates. It may be 0 for the core logger to compute an appropriate value or a multiple of 4. The default value is 0. The unit is KB.

MinLogSizeInMB

Gets or sets the minimum log size. A truncation will not be initiated if it would reduce the size of the log to below this value. Default value is 0.

OptimizeForLocalSSD

Deprecated

OptimizeLogForLowerDiskUsage

Gets or sets a flag, when true indicates the log should optimize in a way where less disk space is used for the log at the cost of IO performance. If false, the log will use more disk space but have better IO performance. Default value is true.

ReplicatorAddress

Gets or sets the address in {ip}:{port} format that this replicator will use when communicating with other replicators. The default value is "localhost:0", which picks a dynamic port number in runtime. If replicator is running inside a container, you should try setting up ReplicatorListenAddress and ReplicatorPublishAddress.

ReplicatorListenAddress

Gets or sets the address in {ip}:{port} format that this replicator will use to receive information from other replicators. The default value is "localhost:0", which picks a dynamic port number in runtime. {ip} part of the listen address can be obtained from ServiceListenAddress.

ReplicatorPublishAddress

Gets or sets the address in {ip}:{port} format that this replicator will use to send information to other replicators. The default value is "localhost:0", which picks a dynamic port number in runtime. {ip} part of the publish address can be obtained from ServicePublishAddress.

RetryInterval

Gets or sets how long the replicator waits after it transmits a message from the primary to the secondary for the secondary to acknowledge that it has received the message. The default value is 5 seconds.

SecondaryClearAcknowledgedOperations

Gets or sets a flag, when true indicates the secondary replicator should clear the in-memory queue after acknowledging the operations to the primary (After the operations are flushed to disk). Default value is false. Settings this to "TRUE" can result in additional disk reads on the new primary, while catching up replicas after a failover.

SecurityCredentials

Gets or sets the security credentials for securing the traffic between replicators.

SharedLogId

Gets or sets the GUID identifier for the log container that is shared by a number of replicas on the windows fabric node including this one. Default value is "" which causes the replicator to use the global shared log for the node.

SharedLogPath

Gets or sets the full pathname to the log container that is shared by a number of replicas on the node including this one. Default value is "" which causes the replicator to use the global shared log for the node.

SlowApiMonitoringDuration

Sets the interval after which the replicator sends a warning health report that the API is slow and is taking longer than expected duration. Default value is 5 minutes.

ThrottlingThresholdFactor

Gets or sets the throttling threshold factor. Throttling will be initiated when the log usage exceeds this value times MinLogSizeInMB. Default value is 3.

TruncationThresholdFactor

Gets or sets the truncation threshold factor. A truncation will be initiated when the log usage exceeds this value times MinLogSizeInMB. Default value is 2.

Methods

Equals(Object)

Determines whether the specified ReplicatorSettings is equal to the current object.

GetHashCode()

Serves as a hash function for this type.

ToString()

Returns a string that represents the current object.

Applies to