Constant Field Values

Contents

• org.apache.*

org.apache.*

org.apache.ratis.server.RaftServerConfigKeys

Modifier and Type	Constant Field	Value
public static final String	PREFIX	"raft.server"
public static final int	SLEEP_DEVIATION_THRESHOLD_DEFAULT	300
public static final String	SLEEP_DEVIATION_THRESHOLD_KEY	"raft.server.sleep.deviation.threshold"
public static final int	STAGING_CATCHUP_GAP_DEFAULT	1000
public static final String	STAGING_CATCHUP_GAP_KEY	"raft.server.staging.catchup.gap"
public static final String	STORAGE_DIR_KEY	"raft.server.storage.dir"

org.apache.ratis.server.RaftServerConfigKeys.Log

Modifier and Type	Constant Field	Value
public static final String	CORRUPTION_POLICY_KEY	"raft.server.log.corruption.policy"
public static final int	FORCE_SYNC_NUM_DEFAULT	128
public static final String	FORCE_SYNC_NUM_KEY	"raft.server.log.force.sync.num"
public static final String	PREALLOCATED_SIZE_KEY	"raft.server.log.preallocated.size"
public static final String	PREFIX	"raft.server.log"
public static final int	PURGE_GAP_DEFAULT	1024
public static final String	PURGE_GAP_KEY	"raft.server.log.purge.gap"
public static final boolean	PURGE_UPTO_SNAPSHOT_INDEX_DEFAULT	false
public static final String	PURGE_UPTO_SNAPSHOT_INDEX_KEY	"raft.server.log.purge.upto.snapshot.index"
public static final String	QUEUE_BYTE_LIMIT_KEY	"raft.server.log.queue.byte-limit"
public static final int	QUEUE_ELEMENT_LIMIT_DEFAULT	4096
public static final String	QUEUE_ELEMENT_LIMIT_KEY	"raft.server.log.queue.element-limit"
public static final int	SEGMENT_CACHE_NUM_MAX_DEFAULT	6
public static final String	SEGMENT_CACHE_NUM_MAX_KEY	"raft.server.log.segment.cache.num.max"
public static final String	SEGMENT_SIZE_MAX_KEY	"raft.server.log.segment.size.max"
public static final boolean	USE_MEMORY_DEFAULT	false
public static final String	USE_MEMORY_KEY	"raft.server.log.use.memory"
public static final String	WRITE_BUFFER_SIZE_KEY	"raft.server.log.write.buffer.size"

org.apache.ratis.server.RaftServerConfigKeys.Log.Appender

Modifier and Type	Constant Field	Value
public static final String	BUFFER_BYTE_LIMIT_KEY	"raft.server.log.appender.buffer.byte-limit"
public static final int	BUFFER_ELEMENT_LIMIT_DEFAULT	0
public static final String	BUFFER_ELEMENT_LIMIT_KEY	"raft.server.log.appender.buffer.element-limit"
public static final boolean	INSTALL_SNAPSHOT_ENABLED_DEFAULT	true
public static final String	INSTALL_SNAPSHOT_ENABLED_KEY	"raft.server.log.appender.install.snapshot.enabled"
public static final String	PREFIX	"raft.server.log.appender"
public static final String	SNAPSHOT_CHUNK_SIZE_MAX_KEY	"raft.server.log.appender.snapshot.chunk.size.max"

org.apache.ratis.server.RaftServerConfigKeys.Log.StateMachineData

Modifier and Type	Constant Field	Value
public static final boolean	CACHING_ENABLED_DEFAULT	false
public static final String	CACHING_ENABLED_KEY	"raft.server.log.statemachine.data.caching.enabled"
public static final String	PREFIX	"raft.server.log.statemachine.data"
public static final boolean	SYNC_DEFAULT	true
public static final String	SYNC_KEY	"raft.server.log.statemachine.data.sync"
public static final String	SYNC_TIMEOUT_KEY	"raft.server.log.statemachine.data.sync.timeout"
public static final int	SYNC_TIMEOUT_RETRY_DEFAULT	-1
public static final String	SYNC_TIMEOUT_RETRY_KEY	"raft.server.log.statemachine.data.sync.timeout.retry"

org.apache.ratis.server.RaftServerConfigKeys.RetryCache

Modifier and Type	Constant Field	Value
public static final String	EXPIRY_TIME_KEY	"raft.server.retrycache.expirytime"
public static final String	PREFIX	"raft.server.retrycache"

org.apache.ratis.server.RaftServerConfigKeys.Rpc

Modifier and Type	Constant Field	Value
public static final String	PREFIX	"raft.server.rpc"
public static final String	REQUEST_TIMEOUT_KEY	"raft.server.rpc.request.timeout"
public static final String	SLEEP_TIME_KEY	"raft.server.rpc.sleep.time"
public static final String	SLOWNESS_TIMEOUT_KEY	"raft.server.rpcslowness.timeout"
public static final String	TIMEOUT_MAX_KEY	"raft.server.rpc.timeout.max"
public static final String	TIMEOUT_MIN_KEY	"raft.server.rpc.timeout.min"

org.apache.ratis.server.RaftServerConfigKeys.Snapshot

Modifier and Type	Constant Field	Value
public static final boolean	AUTO_TRIGGER_ENABLED_DEFAULT	false
public static final String	AUTO_TRIGGER_ENABLED_KEY	"raft.server.snapshot.auto.trigger.enabled"
public static final long	AUTO_TRIGGER_THRESHOLD_DEFAULT	400000L
public static final String	AUTO_TRIGGER_THRESHOLD_KEY	"raft.server.snapshot.auto.trigger.threshold"
public static final String	PREFIX	"raft.server.snapshot"
public static final int	RETENTION_FILE_NUM_DEFAULT	-1
public static final String	RETENTION_FILE_NUM_KEY	"raft.server.snapshot.retention.file.num"

org.apache.ratis.server.RaftServerConfigKeys.Watch

Modifier and Type	Constant Field	Value
public static final int	ELEMENT_LIMIT_DEFAULT	65536
public static final String	ELEMENT_LIMIT_KEY	"raft.server.watch.element-limit"
public static final String	PREFIX	"raft.server.watch"
public static final String	TIMEOUT_DENOMINATION_KEY	"raft.server.watch.timeout.denomination"
public static final String	TIMEOUT_KEY	"raft.server.watch.timeout"

org.apache.ratis.server.RaftServerConfigKeys.Write

Modifier and Type	Constant Field	Value
public static final String	BYTE_LIMIT_KEY	"raft.server.write.byte-limit"
public static final int	ELEMENT_LIMIT_DEFAULT	4096
public static final String	ELEMENT_LIMIT_KEY	"raft.server.write.element-limit"
public static final String	PREFIX	"raft.server.write"

org.apache.ratis.server.impl.RaftServerConstants

Modifier and Type	Constant Field	Value
public static final long	DEFAULT_CALLID	0L
public static final long	INVALID_LOG_INDEX	-1L

org.apache.ratis.server.impl.RaftServerMetrics

Modifier and Type	Constant Field	Value
public static final String	FOLLOWER_LAST_HEARTBEAT_ELAPSED_TIME_METRIC	"%s_lastHeartbeatElapsedTime"
public static final String	LEADER_METRIC_PEER_COMMIT_INDEX	"%s_peerCommitIndex"
public static final String	RAFT_CLIENT_READ_REQUEST	"clientReadRequest"
public static final String	RAFT_CLIENT_STALE_READ_REQUEST	"clientStaleReadRequest"
public static final String	RAFT_CLIENT_WATCH_REQUEST	"clientWatch%sRequest"
public static final String	RAFT_CLIENT_WRITE_REQUEST	"clientWriteRequest"
public static final String	RATIS_SERVER_METRICS	"server"
public static final String	RATIS_SERVER_METRICS_DESC	"Metrics for Raft server"
public static final String	REQUEST_BYTE_SIZE	"numPendingRequestByteSize"
public static final String	REQUEST_BYTE_SIZE_LIMIT_HIT_COUNTER	"numRequestsByteSizeLimitHits"
public static final String	REQUEST_QUEUE_LIMIT_HIT_COUNTER	"numRequestQueueLimitHits"
public static final String	REQUEST_QUEUE_SIZE	"numPendingRequestInQueue"
public static final String	RESOURCE_LIMIT_HIT_COUNTER	"leaderNumResourceLimitHits"
public static final String	RETRY_CACHE_ENTRY_COUNT_METRIC	"retryCacheEntryCount"
public static final String	RETRY_CACHE_HIT_COUNT_METRIC	"retryCacheHitCount"
public static final String	RETRY_CACHE_HIT_RATE_METRIC	"retryCacheHitRate"
public static final String	RETRY_CACHE_MISS_COUNT_METRIC	"retryCacheMissCount"
public static final String	RETRY_CACHE_MISS_RATE_METRIC	"retryCacheMissRate"

org.apache.ratis.server.impl.StateMachineMetrics

Modifier and Type	Constant Field	Value
public static final String	RATIS_STATEMACHINE_METRICS	"state_machine"
public static final String	RATIS_STATEMACHINE_METRICS_DESC	"Metrics for State Machine Updater"
public static final String	STATEMACHINE_APPLIED_INDEX_GAUGE	"appliedIndex"
public static final String	STATEMACHINE_APPLY_COMPLETED_GAUGE	"applyCompletedIndex"
public static final String	STATEMACHINE_TAKE_SNAPSHOT_TIMER	"takeSnapshot"

org.apache.ratis.server.metrics.LeaderElectionMetrics

Modifier and Type	Constant Field	Value
public static final String	LAST_LEADER_ELAPSED_TIME	"lastLeaderElapsedTime"
public static final String	LEADER_ELECTION_COUNT_METRIC	"electionCount"
public static final String	LEADER_ELECTION_LATENCY	"electionLatency"
public static final String	LEADER_ELECTION_TIMEOUT_COUNT_METRIC	"electionTimeoutCount"
public static final String	RATIS_LEADER_ELECTION_METRICS	"leader_election"
public static final String	RATIS_LEADER_ELECTION_METRICS_DESC	"Metrics for Ratis Leader Election."

org.apache.ratis.server.metrics.LogAppenderMetrics

Modifier and Type	Constant Field	Value
public static final String	RATIS_LOG_APPENDER_METRICS	"log_appender"
public static final String	RATIS_LOG_APPENDER_METRICS_DESC	"Metrics for log appender"

org.apache.ratis.server.metrics.RaftLogMetrics

Modifier and Type	Constant Field	Value
public static final String	CONFIG_LOG_ENTRY_COUNT	"configLogEntryCount"
public static final String	FOLLOWER_APPEND_ENTRIES_LATENCY	"follower_append_entry_latency"
public static final String	FOLLOWER_MATCH_INDEX	"follower_%s_match_index"
public static final String	FOLLOWER_NEXT_INDEX	"follower_%s_next_index"
public static final String	FOLLOWER_RPC_RESP_TIME	"follower_%s_rpc_response_time"
public static final String	LOG_APPENDER_INSTALL_SNAPSHOT_METRIC	"numInstallSnapshot"
public static final String	METADATA_LOG_ENTRY_COUNT	"metadataLogEntryCount"
public static final String	RAFT_LOG_APPEND_ENTRY_COUNT	"appendEntryCount"
public static final String	RAFT_LOG_APPEND_ENTRY_LATENCY	"appendEntryLatency"
public static final String	RAFT_LOG_CACHE_CLOSED_SEGMENTS_NUM	"closedSegmentsNum"
public static final String	RAFT_LOG_CACHE_CLOSED_SEGMENTS_SIZE_IN_BYTES	"closedSegmentsSizeInBytes"
public static final String	RAFT_LOG_CACHE_HIT_COUNT	"cacheHitCount"
public static final String	RAFT_LOG_CACHE_MISS_COUNT	"cacheMissCount"
public static final String	RAFT_LOG_CACHE_OPEN_SEGMENT_SIZE_IN_BYTES	"openSegmentSizeInBytes"
public static final String	RAFT_LOG_DATA_QUEUE_SIZE	"dataQueueSize"
public static final String	RAFT_LOG_FLUSH_COUNT	"flushCount"
public static final String	RAFT_LOG_FLUSH_TIME	"flushTime"
public static final String	RAFT_LOG_LOAD_SEGMENT_LATENCY	"segmentLoadLatency"
public static final String	RAFT_LOG_PURGE_METRIC	"purgeLog"
public static final String	RAFT_LOG_READ_ENTRY_LATENCY	"readEntryLatency"
public static final String	RAFT_LOG_SYNC_BATCH_SIZE	"syncBatchSize"
public static final String	RAFT_LOG_SYNC_TIME	"syncTime"
public static final String	RAFT_LOG_TASK_ENQUEUE_DELAY	"queueingDelay"
public static final String	RAFT_LOG_TASK_EXECUTION_TIME	"%sExecutionTime"
public static final String	RAFT_LOG_TASK_QUEUE_TIME	"enqueuedTime"
public static final String	RAFT_LOG_WORKER_QUEUE_SIZE	"workerQueueSize"
public static final String	RATIS_LOG_WORKER_METRICS	"log_worker"
public static final String	RATIS_LOG_WORKER_METRICS_DESC	"Metrics for Log Worker"
public static final String	STATE_MACHINE_LOG_ENTRY_COUNT	"stateMachineLogEntryCount"

org.apache.ratis.server.raftlog.RaftLog

Modifier and Type	Constant Field	Value
public static final long	INVALID_LOG_INDEX	-1L
public static final long	LEAST_VALID_LOG_INDEX	0L

org.apache.ratis.statemachine.impl.SnapshotRetentionPolicy

Modifier and Type	Constant Field	Value
public static final int	DEFAULT_ALL_SNAPSHOTS_RETAINED	-1