SubscriptionStats (Pulsar Common 2.8.0-rc-202105182205 API)

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

Direct Known Subclasses:

NonPersistentSubscriptionStats
```
public class SubscriptionStats
extends Object
```
Statistics about subscription.

Field Summary

Fields
Modifier and Type	Field and Description
`String`	`activeConsumerName` The name of the consumer that is active for single active consumer subscriptions i.e.
`long`	`backlogSize` Size of backlog in byte.
`boolean`	`blockedSubscriptionOnUnackedMsgs` Flag to verify if subscription is blocked due to reaching threshold of unacked messages.
`long`	`bytesOutCounter` Total bytes delivered to consumer (bytes).
`int`	`chuckedMessageRate` Deprecated. use `chunkedMessageRate)`
`int`	`chunkedMessageRate` Chunked message dispatch rate.
`List<ConsumerStats>`	`consumers` List of connected consumers on this subscription w/ their stats.
`Map<String,String>`	`consumersAfterMarkDeletePosition` This is for Key_Shared subscription to get the recentJoinedConsumers in the Key_Shared subscription.
`boolean`	`isDurable` Tells whether this subscription is durable or ephemeral (eg.: from a reader).
`boolean`	`isReplicated` Mark that the subscription state is kept in sync across different regions.
`long`	`lastAckedTimestamp` Last acked message timestamp.
`long`	`lastConsumedFlowTimestamp` Last received consume flow command timestamp.
`long`	`lastConsumedTimestamp` Last consume message timestamp.
`long`	`lastExpireTimestamp` Last message expire execution timestamp.
`long`	`lastMarkDeleteAdvancedTimestamp` Last MarkDelete position advanced timesetamp.
`long`	`msgBacklog` Number of messages in the subscription backlog.
`long`	`msgBacklogNoDelayed` Number of messages in the subscription backlog that do not contain the delay messages.
`long`	`msgDelayed` Number of delayed messages currently being tracked.
`long`	`msgOutCounter` Total messages delivered to consumer (msg).
`double`	`msgRateExpired` Total rate of messages expired on this subscription (msg/s).
`double`	`msgRateOut` Total rate of messages delivered on this subscription (msg/s).
`double`	`msgRateRedeliver` Total rate of messages redelivered on this subscription (msg/s).
`double`	`msgThroughputOut` Total throughput delivered on this subscription (bytes/s).
`int`	`nonContiguousDeletedMessagesRanges` The number of non-contiguous deleted messages ranges.
`int`	`nonContiguousDeletedMessagesRangesSerializedSize` The serialized size of non-contiguous deleted messages ranges.
`long`	`totalMsgExpired` Total messages expired on this subscription.
`CommandSubscribe.SubType`	`type` Whether this subscription is Exclusive or Shared or Failover.
`long`	`unackedMessages` Number of unacknowledged messages for the subscription.

Constructor Summary

Constructors
Constructor and Description

SubscriptionStats()

Constructors
Constructor and Description
`SubscriptionStats()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method and Description

SubscriptionStats add(SubscriptionStats stats)

void reset()
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SubscriptionStats`	`add(SubscriptionStats stats)`
`void`	`reset()`

- Field Detail
  - msgRateOut
```
public double msgRateOut
```
    Total rate of messages delivered on this subscription (msg/s).
  - msgThroughputOut
```
public double msgThroughputOut
```
    Total throughput delivered on this subscription (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 on this subscription (msg/s).
  - chuckedMessageRate
```
@Deprecated
public int chuckedMessageRate
```
    Deprecated. use chunkedMessageRate)
    
    Chunked message dispatch rate.
  - chunkedMessageRate
```
public int chunkedMessageRate
```
    Chunked message dispatch rate.
  - msgBacklog
```
public long msgBacklog
```
    Number of messages in the subscription backlog.
  - backlogSize
```
public long backlogSize
```
    Size of backlog in byte.
  - msgBacklogNoDelayed
```
public long msgBacklogNoDelayed
```
    Number of messages in the subscription backlog that do not contain the delay messages.
  - blockedSubscriptionOnUnackedMsgs
```
public boolean blockedSubscriptionOnUnackedMsgs
```
    Flag to verify if subscription is blocked due to reaching threshold of unacked messages.
  - msgDelayed
```
public long msgDelayed
```
    Number of delayed messages currently being tracked.
  - unackedMessages
```
public long unackedMessages
```
    Number of unacknowledged messages for the subscription.
  - type
```
public CommandSubscribe.SubType type
```
    Whether this subscription is Exclusive or Shared or Failover.
  - activeConsumerName
```
public String activeConsumerName
```
    The name of the consumer that is active for single active consumer subscriptions i.e. failover or exclusive.
  - msgRateExpired
```
public double msgRateExpired
```
    Total rate of messages expired on this subscription (msg/s).
  - totalMsgExpired
```
public long totalMsgExpired
```
    Total messages expired on this subscription.
  - lastExpireTimestamp
```
public long lastExpireTimestamp
```
    Last message expire execution timestamp.
  - lastConsumedFlowTimestamp
```
public long lastConsumedFlowTimestamp
```
    Last received consume flow command timestamp.
  - lastConsumedTimestamp
```
public long lastConsumedTimestamp
```
    Last consume message timestamp.
  - lastAckedTimestamp
```
public long lastAckedTimestamp
```
    Last acked message timestamp.
  - lastMarkDeleteAdvancedTimestamp
```
public long lastMarkDeleteAdvancedTimestamp
```
    Last MarkDelete position advanced timesetamp.
  - consumers
```
public List<ConsumerStats> consumers
```
    List of connected consumers on this subscription w/ their stats.
  - isDurable
```
public boolean isDurable
```
    Tells whether this subscription is durable or ephemeral (eg.: from a reader).
  - isReplicated
```
public boolean isReplicated
```
    Mark that the subscription state is kept in sync across different regions.
  - consumersAfterMarkDeletePosition
```
public Map<String,String> consumersAfterMarkDeletePosition
```
    This is for Key_Shared subscription to get the recentJoinedConsumers in the Key_Shared subscription.
  - nonContiguousDeletedMessagesRanges
```
public int nonContiguousDeletedMessagesRanges
```
    The number of non-contiguous deleted messages ranges.
  - nonContiguousDeletedMessagesRangesSerializedSize
```
public int nonContiguousDeletedMessagesRangesSerializedSize
```
    The serialized size of non-contiguous deleted messages ranges.
- Constructor Detail
  - SubscriptionStats
```
public SubscriptionStats()
```
- Method Detail
  - reset
```
public void reset()
```
  - add
```
public SubscriptionStats add(SubscriptionStats stats)
```

Class SubscriptionStats

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

msgRateOut

msgThroughputOut

bytesOutCounter

msgOutCounter

msgRateRedeliver

chuckedMessageRate

chunkedMessageRate

msgBacklog

backlogSize

msgBacklogNoDelayed

blockedSubscriptionOnUnackedMsgs

msgDelayed

unackedMessages

type

activeConsumerName

msgRateExpired

totalMsgExpired

lastExpireTimestamp

lastConsumedFlowTimestamp

lastConsumedTimestamp

lastAckedTimestamp

lastMarkDeleteAdvancedTimestamp

consumers

isDurable

isReplicated

consumersAfterMarkDeletePosition

nonContiguousDeletedMessagesRanges

nonContiguousDeletedMessagesRangesSerializedSize

Constructor Detail

SubscriptionStats

Method Detail

reset

add