org.apache.ratis.server.impl

Class RaftServerMetrics

java.lang.Object

org.apache.ratis.metrics.RatisMetrics

org.apache.ratis.server.impl.RaftServerMetrics

public final class RaftServerMetrics
extends RatisMetrics

Metric Registry for Raft Group Server. One instance per leader/follower.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FOLLOWER_LAST_HEARTBEAT_ELAPSED_TIME_METRIC
static String	LEADER_METRIC_PEER_COMMIT_INDEX
static String	RAFT_CLIENT_READ_REQUEST
static String	RAFT_CLIENT_STALE_READ_REQUEST
static String	RAFT_CLIENT_WATCH_REQUEST
static String	RAFT_CLIENT_WRITE_REQUEST
static String	RATIS_SERVER_METRICS
static String	RATIS_SERVER_METRICS_DESC
static String	REQUEST_BYTE_SIZE
static String	REQUEST_BYTE_SIZE_LIMIT_HIT_COUNTER
static String	REQUEST_QUEUE_LIMIT_HIT_COUNTER
static String	REQUEST_QUEUE_SIZE
static String	RESOURCE_LIMIT_HIT_COUNTER
static String	RETRY_CACHE_ENTRY_COUNT_METRIC
static String	RETRY_CACHE_HIT_COUNT_METRIC
static String	RETRY_CACHE_HIT_RATE_METRIC
static String	RETRY_CACHE_MISS_COUNT_METRIC
static String	RETRY_CACHE_MISS_RATE_METRIC

Fields inherited from class org.apache.ratis.metrics.RatisMetrics

RATIS_APPLICATION_NAME_METRICS, registry

Method Summary

Modifier and Type	Method and Description
void	addFollower(RaftPeer peer) Register a follower with this Leader Metrics registry instance.
void	addPeerCommitIndexGauge(RaftPeerId peerId) Register a commit index tracker for the peer in cluster.
com.codahale.metrics.Timer	getClientRequestTimer(RaftClientRequest request)
com.codahale.metrics.Counter	getCounter(String counterName)
com.codahale.metrics.Timer	getFollowerAppendEntryTimer(boolean isHeartbeat)
static com.codahale.metrics.Gauge	getPeerCommitIndexGauge(RaftServerImpl server, RaftServerImpl peerServer) Get the commit index gauge for the given peer of the server
static RaftServerMetrics	getRaftServerMetrics(RaftServerImpl raftServer)
RatisMetricRegistry	getRegistry()
com.codahale.metrics.Timer	getTimer(String timerName)
void	onRequestQueueLimitHit()
void	recordFollowerHeartbeatElapsedTime(RaftPeer peer, long elapsedTime) Record heartbeat elapsed time for a follower within a Raft group.
static void	removeRaftServerMetrics(RaftServerImpl raftServer)

Methods inherited from class org.apache.ratis.metrics.RatisMetrics

create, unregister

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RATIS_SERVER_METRICS

public static final String RATIS_SERVER_METRICS

See Also:

Constant Field Values

RATIS_SERVER_METRICS_DESC

public static final String RATIS_SERVER_METRICS_DESC

See Also:

Constant Field Values

FOLLOWER_LAST_HEARTBEAT_ELAPSED_TIME_METRIC

public static final String FOLLOWER_LAST_HEARTBEAT_ELAPSED_TIME_METRIC

See Also:

Constant Field Values

LEADER_METRIC_PEER_COMMIT_INDEX

public static final String LEADER_METRIC_PEER_COMMIT_INDEX

See Also:

Constant Field Values

RAFT_CLIENT_READ_REQUEST

public static final String RAFT_CLIENT_READ_REQUEST

See Also:

Constant Field Values

RAFT_CLIENT_STALE_READ_REQUEST

public static final String RAFT_CLIENT_STALE_READ_REQUEST

See Also:

Constant Field Values

RAFT_CLIENT_WRITE_REQUEST

public static final String RAFT_CLIENT_WRITE_REQUEST

See Also:

Constant Field Values

RAFT_CLIENT_WATCH_REQUEST

public static final String RAFT_CLIENT_WATCH_REQUEST

See Also:

Constant Field Values

REQUEST_QUEUE_LIMIT_HIT_COUNTER

public static final String REQUEST_QUEUE_LIMIT_HIT_COUNTER

See Also:

Constant Field Values

RESOURCE_LIMIT_HIT_COUNTER

public static final String RESOURCE_LIMIT_HIT_COUNTER

See Also:

Constant Field Values

REQUEST_BYTE_SIZE_LIMIT_HIT_COUNTER

public static final String REQUEST_BYTE_SIZE_LIMIT_HIT_COUNTER

See Also:

Constant Field Values

REQUEST_QUEUE_SIZE

public static final String REQUEST_QUEUE_SIZE

See Also:

Constant Field Values

REQUEST_BYTE_SIZE

public static final String REQUEST_BYTE_SIZE

See Also:

Constant Field Values

RETRY_CACHE_ENTRY_COUNT_METRIC

public static final String RETRY_CACHE_ENTRY_COUNT_METRIC

See Also:

Constant Field Values

RETRY_CACHE_HIT_COUNT_METRIC

public static final String RETRY_CACHE_HIT_COUNT_METRIC

See Also:

Constant Field Values

RETRY_CACHE_HIT_RATE_METRIC

public static final String RETRY_CACHE_HIT_RATE_METRIC

See Also:

Constant Field Values

RETRY_CACHE_MISS_COUNT_METRIC

public static final String RETRY_CACHE_MISS_COUNT_METRIC

See Also:

Constant Field Values

RETRY_CACHE_MISS_RATE_METRIC

public static final String RETRY_CACHE_MISS_RATE_METRIC

See Also:

Constant Field Values

Method Detail

getRaftServerMetrics

public static RaftServerMetrics getRaftServerMetrics(RaftServerImpl raftServer)

removeRaftServerMetrics

public static void removeRaftServerMetrics(RaftServerImpl raftServer)

addFollower

public void addFollower(RaftPeer peer)

Register a follower with this Leader Metrics registry instance.

Parameters:

peer - representing the follower

addPeerCommitIndexGauge

public void addPeerCommitIndexGauge(RaftPeerId peerId)

Register a commit index tracker for the peer in cluster.

getPeerCommitIndexGauge

public static com.codahale.metrics.Gauge getPeerCommitIndexGauge(RaftServerImpl server,
                                                                 RaftServerImpl peerServer)

Get the commit index gauge for the given peer of the server

Parameters:

server -

peerServer -

Returns:

Metric Gauge holding the value of commit index of the peer

recordFollowerHeartbeatElapsedTime

public void recordFollowerHeartbeatElapsedTime(RaftPeer peer,
                                               long elapsedTime)

Record heartbeat elapsed time for a follower within a Raft group.

Parameters:

peer - representing the follower.

elapsedTime - Elapsed time in Nanos.

getFollowerAppendEntryTimer

public com.codahale.metrics.Timer getFollowerAppendEntryTimer(boolean isHeartbeat)

getTimer

public com.codahale.metrics.Timer getTimer(String timerName)

getCounter

public com.codahale.metrics.Counter getCounter(String counterName)

getClientRequestTimer

public com.codahale.metrics.Timer getClientRequestTimer(RaftClientRequest request)

onRequestQueueLimitHit

public void onRequestQueueLimitHit()

getRegistry

public RatisMetricRegistry getRegistry()

Overrides:

getRegistry in class RatisMetrics