Package org.apache.pulsar.client.api
Interface ConsumerStats
-
- All Superinterfaces:
java.io.Serializable
@Public @Stable public interface ConsumerStats extends java.io.Serializable
Consumer statistics recorded by client.All the stats are relative to the last recording period. The interval of the stats refreshes is configured with
ClientBuilder.statsInterval(long, java.util.concurrent.TimeUnit)with a default of 1 minute.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.IntegergetMsgNumInReceiverQueue()Get the size of receiver queue.java.util.Map<java.lang.Long,java.lang.Integer>getMsgNumInSubReceiverQueue()Get the receiver queue size of sub-consumers.longgetNumAcksFailed()longgetNumAcksSent()longgetNumBatchReceiveFailed()longgetNumBytesReceived()longgetNumMsgsReceived()longgetNumReceiveFailed()doublegetRateBytesReceived()doublegetRateMsgsReceived()longgetTotaBatchReceivedFailed()longgetTotalAcksFailed()longgetTotalAcksSent()longgetTotalBytesReceived()longgetTotalMsgsReceived()longgetTotalReceivedFailed()
-
-
-
Method Detail
-
getNumMsgsReceived
long getNumMsgsReceived()
- Returns:
- Number of messages received in the last interval
-
getNumBytesReceived
long getNumBytesReceived()
- Returns:
- Number of bytes received in the last interval
-
getRateMsgsReceived
double getRateMsgsReceived()
- Returns:
- Rate of bytes per second received in the last interval
-
getRateBytesReceived
double getRateBytesReceived()
- Returns:
- Rate of bytes per second received in the last interval
-
getNumAcksSent
long getNumAcksSent()
- Returns:
- Number of message acknowledgments sent in the last interval
-
getNumAcksFailed
long getNumAcksFailed()
- Returns:
- Number of message acknowledgments failed in the last interval
-
getNumReceiveFailed
long getNumReceiveFailed()
- Returns:
- Number of message receive failed in the last interval
-
getNumBatchReceiveFailed
long getNumBatchReceiveFailed()
- Returns:
- Number of message batch receive failed in the last interval
-
getTotalMsgsReceived
long getTotalMsgsReceived()
- Returns:
- Total number of messages received by this consumer
-
getTotalBytesReceived
long getTotalBytesReceived()
- Returns:
- Total number of bytes received by this consumer
-
getTotalReceivedFailed
long getTotalReceivedFailed()
- Returns:
- Total number of messages receive failures
-
getTotaBatchReceivedFailed
long getTotaBatchReceivedFailed()
- Returns:
- Total number of messages batch receive failures
-
getTotalAcksSent
long getTotalAcksSent()
- Returns:
- Total number of message acknowledgments sent by this consumer
-
getTotalAcksFailed
long getTotalAcksFailed()
- Returns:
- Total number of message acknowledgments failures on this consumer
-
getMsgNumInReceiverQueue
java.lang.Integer getMsgNumInReceiverQueue()
Get the size of receiver queue.- Returns:
-
getMsgNumInSubReceiverQueue
java.util.Map<java.lang.Long,java.lang.Integer> getMsgNumInSubReceiverQueue()
Get the receiver queue size of sub-consumers.- Returns:
-
-