org.apache.ratis.server.metrics

Class RaftServerMetricsImpl

java.lang.Object

org.apache.ratis.metrics.RatisMetrics

org.apache.ratis.server.metrics.RaftServerMetricsImpl

All Implemented Interfaces:

RaftServerMetrics

public final class RaftServerMetricsImpl
extends RatisMetrics
implements RaftServerMetrics

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	FOLLOWER_APPEND_ENTRIES_LATENCY
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_FAILED_CLIENT_READ_COUNT
static String	RATIS_SERVER_FAILED_CLIENT_STALE_READ_COUNT
static String	RATIS_SERVER_FAILED_CLIENT_STREAM_COUNT
static String	RATIS_SERVER_FAILED_CLIENT_WATCH_COUNT
static String	RATIS_SERVER_FAILED_CLIENT_WRITE_COUNT
static String	RATIS_SERVER_INSTALL_SNAPSHOT_COUNT
static String	RATIS_SERVER_METRICS
static String	RATIS_SERVER_METRICS_DESC
static String	REQUEST_BYTE_SIZE_LIMIT_HIT_COUNTER
static String	REQUEST_MEGA_BYTE_SIZE
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

Constructor Summary

Constructors

Constructor and Description
RaftServerMetricsImpl(RaftGroupMemberId serverId, Supplier<Function<RaftPeerId,org.apache.ratis.proto.RaftProtos.CommitInfoProto>> commitInfoCache, Supplier<RetryCache.Statistics> retryCacheStatistics)

Method Summary

Modifier and Type	Method and Description
void	addFollower(RaftPeerId followerName) Register a follower with this Leader Metrics registry instance.
void	addNumPendingRequestsGauge(com.codahale.metrics.Gauge queueSize)
void	addNumPendingRequestsMegaByteSize(com.codahale.metrics.Gauge megabyteSize)
void	addPeerCommitIndexGauge(RaftPeerId peerId) Register a commit index tracker for the peer in cluster.
static RaftServerMetricsImpl	computeIfAbsentRaftServerMetrics(RaftGroupMemberId serverId, Supplier<Function<RaftPeerId,org.apache.ratis.proto.RaftProtos.CommitInfoProto>> commitInfoCache, Supplier<RetryCache.Statistics> retryCacheStatistics)
com.codahale.metrics.Timer	getClientRequestTimer(RaftClientRequest.Type request)
com.codahale.metrics.Counter	getCounter(String counterName)
com.codahale.metrics.Timer	getFollowerAppendEntryTimer(boolean isHeartbeat)
static com.codahale.metrics.Gauge	getPeerCommitIndexGauge(RaftGroupMemberId serverId, RaftPeerId peerId) Get the commit index gauge for the given peer of the server
RatisMetricRegistry	getRegistry()
com.codahale.metrics.Timer	getTimer(String timerName)
void	incFailedRequestCount(RaftClientRequest.Type type)
void	onRequestByteSizeLimitHit()
void	onRequestQueueLimitHit()
void	onResourceLimitHit()
void	onSnapshotInstalled()
void	recordFollowerHeartbeatElapsedTime(RaftPeerId followerId, long elapsedTimeNs) Record heartbeat elapsed time for a follower within a Raft group.
boolean	removeNumPendingRequestsByteSize()
boolean	removeNumPendingRequestsGauge()
static void	removeRaftServerMetrics(RaftGroupMemberId serverId)

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

FOLLOWER_APPEND_ENTRIES_LATENCY

public static final String FOLLOWER_APPEND_ENTRIES_LATENCY

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_MEGA_BYTE_SIZE

public static final String REQUEST_MEGA_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

RATIS_SERVER_FAILED_CLIENT_STALE_READ_COUNT

public static final String RATIS_SERVER_FAILED_CLIENT_STALE_READ_COUNT

See Also:

Constant Field Values

RATIS_SERVER_FAILED_CLIENT_READ_COUNT

public static final String RATIS_SERVER_FAILED_CLIENT_READ_COUNT

See Also:

Constant Field Values

RATIS_SERVER_FAILED_CLIENT_WRITE_COUNT

public static final String RATIS_SERVER_FAILED_CLIENT_WRITE_COUNT

See Also:

Constant Field Values

RATIS_SERVER_FAILED_CLIENT_WATCH_COUNT

public static final String RATIS_SERVER_FAILED_CLIENT_WATCH_COUNT

See Also:

Constant Field Values

RATIS_SERVER_FAILED_CLIENT_STREAM_COUNT

public static final String RATIS_SERVER_FAILED_CLIENT_STREAM_COUNT

See Also:

Constant Field Values

RATIS_SERVER_INSTALL_SNAPSHOT_COUNT

public static final String RATIS_SERVER_INSTALL_SNAPSHOT_COUNT

See Also:

Constant Field Values

Constructor Detail

RaftServerMetricsImpl

public RaftServerMetricsImpl(RaftGroupMemberId serverId,
                             Supplier<Function<RaftPeerId,org.apache.ratis.proto.RaftProtos.CommitInfoProto>> commitInfoCache,
                             Supplier<RetryCache.Statistics> retryCacheStatistics)

Method Detail

computeIfAbsentRaftServerMetrics

public static RaftServerMetricsImpl computeIfAbsentRaftServerMetrics(RaftGroupMemberId serverId,
                                                                     Supplier<Function<RaftPeerId,org.apache.ratis.proto.RaftProtos.CommitInfoProto>> commitInfoCache,
                                                                     Supplier<RetryCache.Statistics> retryCacheStatistics)

removeRaftServerMetrics

public static void removeRaftServerMetrics(RaftGroupMemberId serverId)

addFollower

public void addFollower(RaftPeerId followerName)

Register a follower with this Leader Metrics registry instance.

addPeerCommitIndexGauge

public void addPeerCommitIndexGauge(RaftPeerId peerId)

Register a commit index tracker for the peer in cluster.

getPeerCommitIndexGauge

public static com.codahale.metrics.Gauge getPeerCommitIndexGauge(RaftGroupMemberId serverId,
                                                                 RaftPeerId peerId)

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

Returns:

Metric Gauge holding the value of commit index of the peer

recordFollowerHeartbeatElapsedTime

public void recordFollowerHeartbeatElapsedTime(RaftPeerId followerId,
                                               long elapsedTimeNs)

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

Parameters:

followerId - the follower id.

elapsedTimeNs - 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.Type request)

onRequestQueueLimitHit

public void onRequestQueueLimitHit()

addNumPendingRequestsGauge

public void addNumPendingRequestsGauge(com.codahale.metrics.Gauge queueSize)

removeNumPendingRequestsGauge

public boolean removeNumPendingRequestsGauge()

addNumPendingRequestsMegaByteSize

public void addNumPendingRequestsMegaByteSize(com.codahale.metrics.Gauge megabyteSize)

removeNumPendingRequestsByteSize

public boolean removeNumPendingRequestsByteSize()

onRequestByteSizeLimitHit

public void onRequestByteSizeLimitHit()

onResourceLimitHit

public void onResourceLimitHit()

incFailedRequestCount

public void incFailedRequestCount(RaftClientRequest.Type type)

onSnapshotInstalled

public void onSnapshotInstalled()

Specified by:

onSnapshotInstalled in interface RaftServerMetrics

getRegistry

public RatisMetricRegistry getRegistry()

Overrides:

getRegistry in class RatisMetrics