TopicStatsImpl (Pulsar Common 2.10.0-rc-202203222205 API)

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

All Implemented Interfaces:

TopicStats

Direct Known Subclasses:

NonPersistentTopicStatsImpl, PartitionedTopicStatsImpl
```
public class TopicStatsImpl
extends Object
implements TopicStats
```
Statistics for a Pulsar topic.

Field Summary

Fields
Modifier and Type	Field and Description
`double`	`averageMsgSize` Average size of published messages (bytes).
`long`	`backlogSize` Get estimated total unconsumed or backlog size in bytes.
`long`	`bytesInCounter` Total bytes published to the topic (bytes).
`long`	`bytesOutCounter` Total bytes delivered to consumer (bytes).
`CompactionStatsImpl`	`compaction` The compaction stats.
`String`	`deduplicationStatus`
`long`	`earliestMsgPublishTimeInBacklogs` Get the publish time of the earliest message over all the backlogs.
`long`	`lastOffloadFailureTimeStamp` record last failed offloaded timestamp.
`long`	`lastOffloadLedgerId` record last successful offloaded ledgerId.
`long`	`lastOffloadSuccessTimeStamp` record last successful offloaded timestamp.
`boolean`	`msgChunkPublished` Topic has chunked message published on it.
`long`	`msgInCounter` Total messages published to the topic (msg).
`long`	`msgOutCounter` Total messages delivered to consumer (msg).
`double`	`msgRateIn` Total rate of messages published on the topic (msg/s).
`double`	`msgRateOut` Total rate of messages dispatched for the topic (msg/s).
`double`	`msgThroughputIn` Total throughput of messages published on the topic (byte/s).
`double`	`msgThroughputOut` Total throughput of messages dispatched for the topic (byte/s).
`int`	`nonContiguousDeletedMessagesRanges` The number of non-contiguous deleted messages ranges.
`int`	`nonContiguousDeletedMessagesRangesSerializedSize` The serialized size of non-contiguous deleted messages ranges.
`long`	`offloadedStorageSize` Space used to store the offloaded messages for the topic/.
`long`	`publishRateLimitedTimes` The number of times the publishing rate limit was triggered.
`Map<String,ReplicatorStatsImpl>`	`replication` Map of replication statistics by remote cluster context.
`long`	`storageSize` Space used to store the messages for the topic (bytes).
`Map<String,SubscriptionStatsImpl>`	`subscriptions` Map of subscriptions with their individual statistics.
`Long`	`topicEpoch` The topic epoch or empty if not set.
`int`	`waitingPublishers`

Constructor Summary

Constructors
Constructor and Description

TopicStatsImpl()

Constructors
Constructor and Description
`TopicStatsImpl()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TopicStatsImpl`	`add(TopicStats ts)`
`void`	`addPublisher(PublisherStatsImpl stats)`
`List<? extends PublisherStats>`	`getPublishers()`
`Map<String,? extends ReplicatorStats>`	`getReplication()`
`Map<String,? extends SubscriptionStats>`	`getSubscriptions()`
`void`	`reset()`
`void`	`setPublishers(List<? extends PublisherStats> statsList)`

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.TopicStats
getAverageMsgSize, getBacklogSize, getBytesInCounter, getBytesOutCounter, getCompaction, getDeduplicationStatus, getEarliestMsgPublishTimeInBacklogs, getMsgInCounter, getMsgOutCounter, getMsgRateIn, getMsgRateOut, getMsgThroughputIn, getMsgThroughputOut, getNonContiguousDeletedMessagesRanges, getNonContiguousDeletedMessagesRangesSerializedSize, getOffloadedStorageSize, getStorageSize, getTopicEpoch, getWaitingPublishers, isMsgChunkPublished

- Field Detail
  - msgRateIn
```
public double msgRateIn
```
    Total rate of messages published on the topic (msg/s).
  - msgThroughputIn
```
public double msgThroughputIn
```
    Total throughput of messages published on the topic (byte/s).
  - msgRateOut
```
public double msgRateOut
```
    Total rate of messages dispatched for the topic (msg/s).
  - msgThroughputOut
```
public double msgThroughputOut
```
    Total throughput of messages dispatched for the topic (byte/s).
  - bytesInCounter
```
public long bytesInCounter
```
    Total bytes published to the topic (bytes).
  - msgInCounter
```
public long msgInCounter
```
    Total messages published to the topic (msg).
  - bytesOutCounter
```
public long bytesOutCounter
```
    Total bytes delivered to consumer (bytes).
  - msgOutCounter
```
public long msgOutCounter
```
    Total messages delivered to consumer (msg).
  - averageMsgSize
```
public double averageMsgSize
```
    Average size of published messages (bytes).
  - msgChunkPublished
```
public boolean msgChunkPublished
```
    Topic has chunked message published on it.
  - storageSize
```
public long storageSize
```
    Space used to store the messages for the topic (bytes).
  - backlogSize
```
public long backlogSize
```
    Get estimated total unconsumed or backlog size in bytes.
  - publishRateLimitedTimes
```
public long publishRateLimitedTimes
```
    The number of times the publishing rate limit was triggered.
  - earliestMsgPublishTimeInBacklogs
```
public long earliestMsgPublishTimeInBacklogs
```
    Get the publish time of the earliest message over all the backlogs.
  - offloadedStorageSize
```
public long offloadedStorageSize
```
    Space used to store the offloaded messages for the topic/.
  - lastOffloadLedgerId
```
public long lastOffloadLedgerId
```
    record last successful offloaded ledgerId. If no offload ledger, the value should be 0
  - lastOffloadSuccessTimeStamp
```
public long lastOffloadSuccessTimeStamp
```
    record last successful offloaded timestamp. If no successful offload, the value should be 0
  - lastOffloadFailureTimeStamp
```
public long lastOffloadFailureTimeStamp
```
    record last failed offloaded timestamp. If no failed offload, the value should be 0
  - waitingPublishers
```
public int waitingPublishers
```
  - subscriptions
```
public Map<String,SubscriptionStatsImpl> subscriptions
```
    Map of subscriptions with their individual statistics.
  - replication
```
public Map<String,ReplicatorStatsImpl> replication
```
    Map of replication statistics by remote cluster context.
  - deduplicationStatus
```
public String deduplicationStatus
```
  - topicEpoch
```
public Long topicEpoch
```
    The topic epoch or empty if not set.
  - 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.
  - compaction
```
public CompactionStatsImpl compaction
```
    The compaction stats.
- Constructor Detail
  - TopicStatsImpl
```
public TopicStatsImpl()
```
- Method Detail
  - getPublishers
```
public List<? extends PublisherStats> getPublishers()
```
    Specified by:
    
    getPublishers in interface TopicStats
  - setPublishers
```
public void setPublishers(List<? extends PublisherStats> statsList)
```
  - addPublisher
```
public void addPublisher(PublisherStatsImpl stats)
```
  - getSubscriptions
```
public Map<String,? extends SubscriptionStats> getSubscriptions()
```
    Specified by:
    
    getSubscriptions in interface TopicStats
  - getReplication
```
public Map<String,? extends ReplicatorStats> getReplication()
```
    Specified by:
    
    getReplication in interface TopicStats
  - reset
```
public void reset()
```
  - add
```
public TopicStatsImpl add(TopicStats ts)
```

Class TopicStatsImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

msgRateIn

msgThroughputIn

msgRateOut

msgThroughputOut

bytesInCounter

msgInCounter

bytesOutCounter

msgOutCounter

averageMsgSize

msgChunkPublished

storageSize

backlogSize

publishRateLimitedTimes

earliestMsgPublishTimeInBacklogs

offloadedStorageSize

lastOffloadLedgerId

lastOffloadSuccessTimeStamp

lastOffloadFailureTimeStamp

waitingPublishers

subscriptions

replication

deduplicationStatus

topicEpoch

nonContiguousDeletedMessagesRanges

nonContiguousDeletedMessagesRangesSerializedSize

compaction

Constructor Detail

TopicStatsImpl

Method Detail

getPublishers

setPublishers

addPublisher

getSubscriptions

getReplication

reset

add