ConsumerStats (Pulsar Common 2.8.0-rc-202105182205 API)

java.lang.Object
- org.apache.pulsar.common.policies.data.ConsumerStats

public class ConsumerStats
extends Object

Consumer statistics.

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`availablePermits` Number of available message permits for the consumer.
`int`	`avgMessagesPerEntry` Number of average messages per entry for the consumer consumed.
`boolean`	`blockedConsumerOnUnackedMsgs` Flag to verify if consumer is blocked due to reaching threshold of unacked messages.
`long`	`bytesOutCounter` Total bytes delivered to consumer (bytes).
`double`	`chuckedMessageRate` Deprecated. use `chunkedMessageRate)`
`double`	`chunkedMessageRate` Total chunked messages dispatched.
`String`	`consumerName` Name of the consumer.
`List<String>`	`keyHashRanges` Hash ranges assigned to this consumer if is Key_Shared sub mode.
`long`	`lastAckedTimestamp`
`long`	`lastConsumedTimestamp`
`Map<String,String>`	`metadata` Metadata (key/value strings) associated with this consumer.
`long`	`msgOutCounter` Total messages delivered to consumer (msg).
`double`	`msgRateOut` Total rate of messages delivered to the consumer (msg/s).
`double`	`msgRateRedeliver` Total rate of messages redelivered by this consumer (msg/s).
`double`	`msgThroughputOut` Total throughput delivered to the consumer (bytes/s).
`String`	`readPositionWhenJoining` The read position of the cursor when the consumer joining.
`int`	`unackedMessages` Number of unacknowledged messages for the consumer.

Constructor Summary

Constructors
Constructor and Description

ConsumerStats()

Constructors
Constructor and Description
`ConsumerStats()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ConsumerStats`	`add(ConsumerStats stats)`
`String`	`getAddress()`
`String`	`getClientVersion()`
`String`	`getConnectedSince()`
`String`	`getReadPositionWhenJoining()`
`void`	`setAddress(String address)`
`void`	`setClientVersion(String clientVersion)`
`void`	`setConnectedSince(String connectedSince)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - msgRateOut
```
public double msgRateOut
```
    Total rate of messages delivered to the consumer (msg/s).
  - msgThroughputOut
```
public double msgThroughputOut
```
    Total throughput delivered to the consumer (bytes/s).
  - bytesOutCounter
```
public long bytesOutCounter
```
    Total bytes delivered to consumer (bytes).
  - msgOutCounter
```
public long msgOutCounter
```
    Total messages delivered to consumer (msg).
  - msgRateRedeliver
```
public double msgRateRedeliver
```
    Total rate of messages redelivered by this consumer (msg/s).
  - chuckedMessageRate
```
@Deprecated
public double chuckedMessageRate
```
    Deprecated. use chunkedMessageRate)
    
    Total chunked messages dispatched.
  - chunkedMessageRate
```
public double chunkedMessageRate
```
    Total chunked messages dispatched.
  - consumerName
```
public String consumerName
```
    Name of the consumer.
  - availablePermits
```
public int availablePermits
```
    Number of available message permits for the consumer.
  - unackedMessages
```
public int unackedMessages
```
    Number of unacknowledged messages for the consumer.
  - avgMessagesPerEntry
```
public int avgMessagesPerEntry
```
    Number of average messages per entry for the consumer consumed.
  - blockedConsumerOnUnackedMsgs
```
public boolean blockedConsumerOnUnackedMsgs
```
    Flag to verify if consumer is blocked due to reaching threshold of unacked messages.
  - readPositionWhenJoining
```
public String readPositionWhenJoining
```
    The read position of the cursor when the consumer joining.
  - lastAckedTimestamp
```
public long lastAckedTimestamp
```
  - lastConsumedTimestamp
```
public long lastConsumedTimestamp
```
  - keyHashRanges
```
public List<String> keyHashRanges
```
    Hash ranges assigned to this consumer if is Key_Shared sub mode.
  - metadata
```
public Map<String,String> metadata
```
    Metadata (key/value strings) associated with this consumer.
- Constructor Detail
  - ConsumerStats
```
public ConsumerStats()
```
- Method Detail
  - add
```
public ConsumerStats add(ConsumerStats stats)
```
  - getAddress
```
public String getAddress()
```
  - setAddress
```
public void setAddress(String address)
```
  - getConnectedSince
```
public String getConnectedSince()
```
  - setConnectedSince
```
public void setConnectedSince(String connectedSince)
```
  - getClientVersion
```
public String getClientVersion()
```
  - setClientVersion
```
public void setClientVersion(String clientVersion)
```
  - getReadPositionWhenJoining
```
public String getReadPositionWhenJoining()
```

Class ConsumerStats

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

msgRateOut

msgThroughputOut

bytesOutCounter

msgOutCounter

msgRateRedeliver

chuckedMessageRate

chunkedMessageRate

consumerName

availablePermits

unackedMessages

avgMessagesPerEntry

blockedConsumerOnUnackedMsgs

readPositionWhenJoining

lastAckedTimestamp

lastConsumedTimestamp

keyHashRanges

metadata

Constructor Detail

ConsumerStats

Method Detail

add

getAddress

setAddress

getConnectedSince

setConnectedSince

getClientVersion

setClientVersion

getReadPositionWhenJoining