SubscriptionStatsImpl (Pulsar Common 2.10.0-rc-202203222205 API)

java.lang.Object
- org.apache.pulsar.common.policies.data.stats.SubscriptionStatsImpl

All Implemented Interfaces:

SubscriptionStats

Direct Known Subclasses:

NonPersistentSubscriptionStatsImpl
```
public class SubscriptionStatsImpl
extends Object
implements SubscriptionStats
```
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.
`boolean`	`allowOutOfOrderDelivery` Whether out of order delivery is allowed on the Key_Shared subscription.
`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`	`chunkedMessageRate` Chunked message dispatch rate.
`List<ConsumerStatsImpl>`	`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.
`long`	`earliestMsgPublishTimeInBacklog` Get the publish time of the earliest message in the backlog.
`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.
`String`	`keySharedMode` Whether the Key_Shared subscription mode is AUTO_SPLIT or STICKY.
`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 entries in the subscription backlog.
`long`	`msgBacklogNoDelayed` Number of entries 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.
`Map<String,String>`	`subscriptionProperties` SubscriptionProperties (key/value strings) associated with this subscribe.
`long`	`totalMsgExpired` Total messages expired on this subscription.
`String`	`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

SubscriptionStatsImpl()

Constructors
Constructor and Description
`SubscriptionStatsImpl()`

Method Summary

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

SubscriptionStatsImpl add(SubscriptionStatsImpl stats)

void reset()
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
- Methods inherited from interface org.apache.pulsar.common.policies.data.SubscriptionStats
  getActiveConsumerName, getBacklogSize, getBytesOutCounter, getChunkedMessageRate, getConsumers, getConsumersAfterMarkDeletePosition, getEarliestMsgPublishTimeInBacklog, getKeySharedMode, getLastAckedTimestamp, getLastConsumedFlowTimestamp, getLastConsumedTimestamp, getLastExpireTimestamp, getLastMarkDeleteAdvancedTimestamp, getMsgBacklog, getMsgBacklogNoDelayed, getMsgDelayed, getMsgOutCounter, getMsgRateExpired, getMsgRateOut, getMsgRateRedeliver, getMsgThroughputOut, getNonContiguousDeletedMessagesRanges, getNonContiguousDeletedMessagesRangesSerializedSize, getSubscriptionProperties, getTotalMsgExpired, getType, getUnackedMessages, isAllowOutOfOrderDelivery, isBlockedSubscriptionOnUnackedMsgs, isDurable, isReplicated

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SubscriptionStatsImpl`	`add(SubscriptionStatsImpl 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).
  - chunkedMessageRate
```
public int chunkedMessageRate
```
    Chunked message dispatch rate.
  - msgBacklog
```
public long msgBacklog
```
    Number of entries in the subscription backlog.
  - backlogSize
```
public long backlogSize
```
    Size of backlog in byte.
  - earliestMsgPublishTimeInBacklog
```
public long earliestMsgPublishTimeInBacklog
```
    Get the publish time of the earliest message in the backlog.
  - msgBacklogNoDelayed
```
public long msgBacklogNoDelayed
```
    Number of entries 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 String 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<ConsumerStatsImpl> 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.
  - allowOutOfOrderDelivery
```
public boolean allowOutOfOrderDelivery
```
    Whether out of order delivery is allowed on the Key_Shared subscription.
  - keySharedMode
```
public String keySharedMode
```
    Whether the Key_Shared subscription mode is AUTO_SPLIT or STICKY.
  - 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.
  - subscriptionProperties
```
public Map<String,String> subscriptionProperties
```
    SubscriptionProperties (key/value strings) associated with this subscribe.
- Constructor Detail
  - SubscriptionStatsImpl
```
public SubscriptionStatsImpl()
```
- Method Detail
  - reset
```
public void reset()
```
  - add
```
public SubscriptionStatsImpl add(SubscriptionStatsImpl stats)
```

Class SubscriptionStatsImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.pulsar.common.policies.data.SubscriptionStats

Field Detail

msgRateOut

msgThroughputOut

bytesOutCounter

msgOutCounter

msgRateRedeliver

chunkedMessageRate

msgBacklog

backlogSize

earliestMsgPublishTimeInBacklog

msgBacklogNoDelayed

blockedSubscriptionOnUnackedMsgs

msgDelayed

unackedMessages

type

activeConsumerName

msgRateExpired

totalMsgExpired

lastExpireTimestamp

lastConsumedFlowTimestamp

lastConsumedTimestamp

lastAckedTimestamp

lastMarkDeleteAdvancedTimestamp

consumers

isDurable

isReplicated

allowOutOfOrderDelivery

keySharedMode

consumersAfterMarkDeletePosition

nonContiguousDeletedMessagesRanges

nonContiguousDeletedMessagesRangesSerializedSize

subscriptionProperties

Constructor Detail

SubscriptionStatsImpl

Method Detail

reset

add