This is an automated email from the ASF dual-hosted git repository.
urfree pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pulsar-site.git
The following commit(s) were added to refs/heads/main by this push:
new 77ca028f92b Docs sync done from apache/pulsar(#b5946f1)
77ca028f92b is described below
commit 77ca028f92b596cdc9df99711c274c5a94d016b5
Author: Pulsar Site Updater <[email protected]>
AuthorDate: Mon Nov 28 06:01:33 2022 +0000
Docs sync done from apache/pulsar(#b5946f1)
---
site2/website-next/docs/admin-api-topics.md | 292 +-----------------------
site2/website-next/docs/administration-stats.md | 211 ++++++++++++-----
2 files changed, 165 insertions(+), 338 deletions(-)
diff --git a/site2/website-next/docs/admin-api-topics.md
b/site2/website-next/docs/admin-api-topics.md
index ec80a3b04ea..a46d93be310 100644
--- a/site2/website-next/docs/admin-api-topics.md
+++ b/site2/website-next/docs/admin-api-topics.md
@@ -252,209 +252,7 @@ admin.topics().unload(topic);
### Get stats
-You can check the following statistics of a given non-partitioned topic.
-
- - **msgRateIn**: The sum of all local and replication publishers' publish
rates (msg/s).
-
- - **msgThroughputIn**: The sum of all local and replication publishers'
publish rates (bytes/s).
-
- - **msgRateOut**: The sum of all local and replication consumers' dispatch
rates(msg/s).
-
- - **msgThroughputOut**: The sum of all local and replication consumers'
dispatch rates (bytes/s).
-
- - **averageMsgSize**: The average size (in bytes) of messages published
within the last interval.
-
- - **storageSize**: The sum of the ledgers' storage size for this topic.
The space used to store the messages for the topic.
-
- - **earliestMsgPublishTimeInBacklogs**: The publish time of the earliest
message in the backlog (ms).
-
- - **bytesInCounter**: Total bytes published to the topic.
-
- - **msgInCounter**: Total messages published to the topic.
-
- - **bytesOutCounter**: Total bytes delivered to consumers.
-
- - **msgOutCounter**: Total messages delivered to consumers.
-
- - **msgChunkPublished**: Topic has chunked message published on it.
-
- - **backlogSize**: Estimated total unconsumed or backlog size (in bytes).
-
- - **offloadedStorageSize**: Space that is used to store the offloaded
messages for the topic (in bytes).
-
- - **waitingPublishers**: The number of publishers waiting in a queue in
exclusive access mode.
-
- - **deduplicationStatus**: The status of message deduplication for the
topic.
-
- - **topicEpoch**: The topic epoch or empty if not set.
-
- - **filteredEntriesCount**: The count of skipped entries for the topic.
-
- - **nonContiguousDeletedMessagesRanges**: The number of non-contiguous
deleted messages ranges.
-
- - **nonContiguousDeletedMessagesRangesSerializedSize**: The serialized
size of non-contiguous deleted messages ranges.
-
- - **ownerBroker**: The broker that owns this topic.
-
- - **publishers**: The list of all local publishers on the topic. The list
ranges from zero to thousands.
-
- - **accessMode**: The type of access to the topic that the producer
requires.
-
- - **msgRateIn**: The total rate of messages (msg/s) published by this
publisher.
-
- - **msgThroughputIn**: The total throughput (bytes/s) of the messages
published by this publisher.
-
- - **averageMsgSize**: The average message size in bytes from this
publisher within the last interval.
-
- - **chunkedMessageRate**: The total rate of chunked messages published
by this publisher.
-
- - **producerId**: The internal identifier for this producer on this
topic.
-
- - **producerName**: The internal identifier for this producer,
generated by the client library.
-
- - **address**: The IP address and source port for the connection of
this producer.
-
- - **connectedSince**: The timestamp when this producer is created or
reconnected last time.
-
- - **clientVersion**: The client library version of this producer.
-
- - **metadata**: Metadata (key/value strings) associated with this
publisher.
-
- - **subscriptions**: The list of all local subscriptions to the topic.
-
- - **my-subscription**: The name of this subscription. It is defined by
the client.
-
- - **msgRateOut**: The total rate of messages (msg/s) delivered on
this subscription.
-
- - **msgThroughputOut**: The total throughput (bytes/s) delivered
on this subscription.
-
- - **msgBacklog**: The number of messages in the subscription
backlog.
-
- - **type**: The subscription type.
-
- - **msgRateExpired**: The rate at which messages were discarded
instead of dispatched from this subscription due to TTL.
-
- - **lastExpireTimestamp**: The timestamp of the last message
expire execution.
-
- - **lastConsumedFlowTimestamp**: The timestamp of the last flow
command received.
-
- - **lastConsumedTimestamp**: The latest timestamp of all the
consumed timestamps of the consumers.
-
- - **lastAckedTimestamp**: The latest timestamp of all the
acknowledged timestamps of the consumers.
-
- - **bytesOutCounter**: Total bytes delivered to a consumer.
-
- - **msgOutCounter**: Total messages delivered to a consumer.
-
- - **msgRateRedeliver**: Total rate of messages redelivered on this
subscription (msg/s).
-
- - **chunkedMessageRate**: Chunked message dispatch rate.
-
- - **backlogSize**: Size of backlog for this subscription (in
bytes).
-
- - **earliestMsgPublishTimeInBacklog**: The publish time of the
earliest message in the backlog for the subscription (ms).
-
- - **msgBacklogNoDelayed**: Number of messages in the subscription
backlog that do not contain the delay messages.
-
- - **blockedSubscriptionOnUnackedMsgs**: Flag to verify if a
subscription is blocked due to reaching the threshold of unacked messages.
-
- - **msgDelayed**: Number of delayed messages currently being
tracked.
-
- - **unackedMessages**: Number of unacknowledged messages for the
subscription, where an unacknowledged message is one that has been sent to a
consumer but not yet acknowledged. This field is only meaningful when using a
subscription that tracks individual message acknowledgment.
-
- - **activeConsumerName**: The name of the consumer that is active
for single active consumer subscriptions. For example, failover or exclusive.
-
- - **totalMsgExpired**: Total messages expired on this
subscription.
-
- - **lastMarkDeleteAdvancedTimestamp**: Last MarkDelete position
advanced timestamp.
-
- - **durable**: Whether the subscription is durable or ephemeral
(for example, from a reader).
-
- - **replicated**: Mark that the subscription state is kept in sync
across different regions.
-
- - **allowOutOfOrderDelivery**: Whether out-of-order delivery is
allowed on the Key_Shared subscription.
-
- - **keySharedMode**: Whether the Key_Shared subscription mode is
AUTO_SPLIT or STICKY.
-
- - **consumersAfterMarkDeletePosition**: This is for Key_Shared
subscription to get the recentJoinedConsumers in the Key_Shared subscription.
-
- - **nonContiguousDeletedMessagesRanges**: The number of
non-contiguous deleted messages ranges.
-
- - **nonContiguousDeletedMessagesRangesSerializedSize**: The
serialized size of non-contiguous deleted messages ranges.
-
- - **filterProcessedMsgCount**: The number of messages processed by
`EntryFilter`.
-
- - **filterAcceptedMsgCount**: The number of messages accepted by
`EntryFilter`.
-
- - **filterRejectedMsgCount**: The number of messages rejected by
`EntryFilter`.
-
- - **filterRescheduledMsgCount**: The number of messages
rescheduled by `EntryFilter`.
-
- - **consumers**: The list of connected consumers for this
subscription.
-
- - **msgRateOut**: The total rate of messages (msg/s)
delivered to the consumer.
-
- - **msgThroughputOut**: The total throughput (bytes/s)
delivered to the consumer.
-
- - **consumerName**: The internal identifier for this
consumer, generated by the client library.
-
- - **availablePermits**: The number of messages that the
consumer has space for in the client library's listening queue. `0` means the
client library's queue is full and `receive()` isn't being called. A non-zero
value means this consumer is ready for dispatched messages.
-
- - **unackedMessages**: The number of unacknowledged messages
for the consumer, where an unacknowledged message has been sent to the consumer
but not yet acknowledged. This field is only meaningful when using a
subscription that tracks individual message acknowledgment.
-
- - **blockedConsumerOnUnackedMsgs**: The flag used to verify
if the consumer is blocked due to reaching the threshold of the unacknowledged
messages.
-
- - **lastConsumedTimestamp**: The timestamp when the consumer
reads a message the last time.
-
- - **lastAckedTimestamp**: The timestamp when the consumer
acknowledges a message the last time.
-
- - **address**: The IP address and source port for the
connection of this consumer.
-
- - **connectedSince**: The timestamp when this consumer is
created or reconnected last time.
-
- - **clientVersion**: The client library version of this
consumer.
-
- - **bytesOutCounter**: Total bytes delivered to a consumer.
-
- - **msgOutCounter**: Total messages delivered to a consumer.
-
- - **msgRateRedeliver**: Total rate of messages redelivered
by this consumer (msg/s).
-
- - **chunkedMessageRate**: The total rate of chunked messages
delivered to this consumer.
-
- - **avgMessagesPerEntry**: Number of average messages per
entry for the consumer consumed.
-
- - **readPositionWhenJoining**: The read position of the
cursor when the consumer joins.
-
- - **keyHashRanges**: Hash ranges assigned to this consumer
if is Key_Shared sub mode.
-
- - **metadata**: Metadata (key/value strings) associated with
this consumer.
-
- - **replication**: This section gives the stats for cross-colo replication
of this topic
-
- - **msgRateIn**: The total rate (msg/s) of messages received from the
remote cluster.
-
- - **msgThroughputIn**: The total throughput (bytes/s) received from
the remote cluster.
-
- - **msgRateOut**: The total rate of messages (msg/s) delivered to the
replication-subscriber.
-
- - **msgThroughputOut**: The total throughput (bytes/s) delivered to
the replication-subscriber.
-
- - **msgRateExpired**: The total rate of messages (msg/s) expired.
-
- - **replicationBacklog**: The number of messages pending to be
replicated to remote cluster.
-
- - **connected**: Whether the outbound replicator is connected.
-
- - **replicationDelayInSeconds**: How long the oldest message has been
waiting to be sent through the connection, if connected is `true`.
-
- - **inboundConnection**: The IP and port of the broker in the remote
cluster's publisher connection to this broker.
-
- - **inboundConnectedSince**: The TCP connection being used to publish
messages to the remote cluster. If there are no local publishers connected,
this connection is automatically closed after a minute.
-
- - **outboundConnection**: The address of the outbound replication
connection.
-
- - **outboundConnectedSince**: The timestamp of establishing an
outbound connection.
+For the detailed statistics of a topic, see [Pulsar
statistics](administration-stats.md#topic-stats).
The following is an example of a topic status.
@@ -584,87 +382,9 @@ admin.topics().getStats(topic);
### Get internal stats
-You can get the detailed statistics of a topic.
-
- - **entriesAddedCounter**: Messages published since this broker loaded
this topic.
-
- - **numberOfEntries**: The total number of messages being tracked.
-
- - **totalSize**: The total storage size in bytes of all messages.
-
- - **currentLedgerEntries**: The count of messages written to the ledger
that is currently open for writing.
-
- - **currentLedgerSize**: The size in bytes of messages written to the
ledger that is currently open for writing.
-
- - **lastLedgerCreatedTimestamp**: The time when the last ledger is created.
-
- - **lastLedgerCreationFailureTimestamp:** The time when the last ledger
failed.
-
- - **waitingCursorsCount**: The number of cursors that are "caught up" and
waiting for a new message to be published.
-
- - **pendingAddEntriesCount**: The number of messages that complete
(asynchronous) write requests.
-
- - **lastConfirmedEntry**: The `ledgerid:entryid` of the last message that
is written successfully. If the `entryid` is `-1`, then the ledger is open, yet
no entries are written.
-
- - **state**: The state of this ledger for writing. The state
`LedgerOpened` means that a ledger is open for saving published messages.
-
- - **ledgers**: The ordered list of all ledgers for this topic holding
messages.
-
- - **ledgerId**: The ID of this ledger.
-
- - **entries**: The total number of entries that belong to this ledger.
-
- - **size**: The size of messages written to this ledger (in bytes).
-
- - **offloaded**: Whether this ledger is offloaded.
-
- - **metadata**: The ledger metadata.
-
- - **schemaLedgers**: The ordered list of all ledgers for this topic schema.
-
- - **ledgerId**: The ID of this ledger.
-
- - **entries**: The total number of entries that belong to this ledger.
-
- - **size**: The size of messages written to this ledger (in bytes).
-
- - **offloaded**: Whether this ledger is offloaded.
-
- - **metadata**: The ledger metadata.
-
- - **compactedLedger**: The ledgers holding un-acked messages after topic
compaction.
-
- - **ledgerId**: The ID of this ledger.
-
- - **entries**: The total number of entries that belong to this ledger.
-
- - **size**: The size of messages written to this ledger (in bytes).
-
- - **offloaded**: Whether this ledger is offloaded. The value is
`false` for the compacted topic ledger.
-
- - **cursors**: The list of all cursors on this topic. Each subscription in
the topic stats has a cursor.
-
- - **markDeletePosition**: All messages before the markDeletePosition
are acknowledged by the subscriber.
-
- - **readPosition**: The latest position of subscriber for reading
messages.
-
- - **waitingReadOp**: This is true when the subscription has read the
latest message published to the topic and is waiting for new messages to be
published.
-
- - **pendingReadOps**: The counter for how many outstanding read
requests to the BookKeepers in progress.
-
- - **messagesConsumedCounter**: The number of messages this cursor has
acknowledged since this broker loaded this topic.
-
- - **cursorLedger**: The ledger being used to persistently store the
current markDeletePosition.
-
- - **cursorLedgerLastEntry**: The last `entryid` used to persistently
store the current markDeletePosition.
-
- - **individuallyDeletedMessages**: If acknowledges are being done out
of order, the ranges of messages acknowledged between the markDeletePosition
and the read-position shows.
-
- - **lastLedgerSwitchTimestamp**: The last time the cursor ledger is
rolled over.
-
- - **state**: The state of the cursor ledger: `Open` means you have a
cursor ledger for saving updates of the markDeletePosition.
+For the detailed internal statistics inside a topic, see [Pulsar
statistics](administration-stats.md#topic-internal-stats).
-The following is an example of the detailed statistics of a topic.
+The following is an example of the internal statistics of a topic.
```json
{
@@ -1708,7 +1428,7 @@ admin.topics().getStats(topic, false /* is precise
backlog */);
</Tabs>
````
-The following is an example. For the description of each stats, refer to [get
stats](#get-stats).
+The following is an example. For the description of topic stats, see [Pulsar
statistics](administration-stats.md#topic-stats).
```json
{
@@ -2023,7 +1743,7 @@ admin.topics().getPartitionedStats(topic, true /* per
partition */, false /* is
</Tabs>
````
-The following is an example. For the description of each stats, refer to [get
stats](#get-stats).
+The following is an example. For the description of each topic stats, see
[Pulsar statistics](administration-stats.md#topic-stats).
Note that in the subscription JSON object, `chuckedMessageRate` is deprecated.
Please use `chunkedMessageRate`. Both will be sent in the JSON for now.
@@ -2082,7 +1802,7 @@ Note that in the subscription JSON object,
`chuckedMessageRate` is deprecated. P
### Internal stats
-You can check the detailed statistics of a topic. The following is an example.
For the description of each stats, refer to [get internal
stats](#get-internal-stats).
+You can check the detailed statistics of a topic. The following is an example.
For the description of each internal topic stats, see [Pulsar
statistics](administration-stats.md#topic-internal-stats).
```json
{
diff --git a/site2/website-next/docs/administration-stats.md
b/site2/website-next/docs/administration-stats.md
index 2ccd73c67f9..ec2d6dd1202 100644
--- a/site2/website-next/docs/administration-stats.md
+++ b/site2/website-next/docs/administration-stats.md
@@ -4,60 +4,167 @@ title: Pulsar stats
sidebar_label: "Pulsar statistics"
---
-## Partitioned topics
+## Topic stats
+
+The following table outlines the stats of a topic. For more details about how
to get these stats, see [Get stats](admin-api-topics.md#get-stats).
+
+| Stat | Description
|
+|--------------------------------------------------|----------------------------------------------------------------------------------------------------------|
+| msgRateIn | The sum of all local and
replication publishers' publish rates (message per second).
|
+| msgThroughputIn | The sum of all local and
replication publishers' publish rates (byte per second).
|
+| msgRateOut | The sum of all local and
replication consumers' dispatch rates (message per second).
|
+| msgThroughputOut | The sum of all local and
replication consumers' dispatch rates (byte per second).
|
+| averageMsgSize | The average size (bytes)
of messages published within the last interval.
|
+| storageSize | The sum of the ledgers'
storage size for this topic. The space used to store the messages for the
topic. |
+| earliestMsgPublishTimeInBacklogs | The publish time of the
earliest message in the backlog (in milliseconds).
|
+| bytesInCounter | The total bytes published
to the topic. |
+| msgInCounter | The total messages
published to the topic.
|
+| bytesOutCounter | The total bytes delivered
to consumers. |
+| msgOutCounter | The total messages
delivered to consumers.
|
+| msgChunkPublished | The topics that have
chunked messages published on it.
|
+| backlogSize | The estimated total
unconsumed or backlog size (in bytes).
|
+| offloadedStorageSize | Space that is used to
store the offloaded messages for the topic (in bytes).
|
+| waitingPublishers | The number of publishers
waiting in a queue in exclusive access mode.
|
+| deduplicationStatus | The status of message
deduplication for the topic.
|
+| topicEpoch | The topic epoch or empty
if not set.
|
+| filteredEntriesCount | The count of skipped
entries for the topic.
|
+| nonContiguousDeletedMessagesRanges | The number of
non-contiguous deleted messages ranges.
|
+| nonContiguousDeletedMessagesRangesSerializedSize | The serialized size of
non-contiguous deleted messages ranges.
|
+| ownerBroker | The broker that owns this
topic. |
+| [publishers](#producer-stats) | The list of all local
publishers on the topic, ranging from zero to thousands.
|
+| [subscriptions](#subscription-stats) | The list of all local
subscriptions to the topic.
|
+| [replication](#replication-stats) | This section gives the
stats for cross-colo replication of this topic.
|
+
+### Producer stats
|Stat|Description|
|---|---|
-|msgRateIn| The sum of publish rates of all local and replication publishers
in messages per second.|
-|msgThroughputIn| Same as msgRateIn but in bytes per second instead of
messages per second.|
-|msgRateOut| The sum of dispatch rates of all local and replication consumers
in messages per second.|
-|msgThroughputOut| Same as msgRateOut but in bytes per second instead of
messages per second.|
-|averageMsgSize| Average message size, in bytes, from this publisher within
the last interval.|
-|storageSize| The sum of storage size of the ledgers for this topic.|
-|publishers| The list of all local publishers into the topic. Publishers can
be anywhere from zero to thousands.|
-|producerId| Internal identifier for this producer on this topic.|
-|producerName| Internal identifier for this producer, generated by the client
library.|
+|producerId| The internal identifier for this producer on this topic.|
+|producerName| The internal identifier for this producer, generated by the
client library.|
|address| IP address and source port for the connection of this producer.|
-|connectedSince| Timestamp this producer is created or last reconnected.|
-|subscriptions| The list of all local subscriptions to the topic.|
-|my-subscription| The name of this subscription (client defined).|
-|msgBacklog| The count of messages in backlog for this subscription.|
-|type| This subscription type.|
-|msgRateExpired| The rate at which messages are discarded instead of
dispatched from this subscription due to TTL.|
-|consumers| The list of connected consumers for this subscription.|
-|consumerName| Internal identifier for this consumer, generated by the client
library.|
-|availablePermits| The number of messages this consumer has space for in the
listen queue of client library. A value of 0 means the queue of client library
is full and receive() is not being called. A nonzero value means this consumer
is ready to be dispatched messages.|
-|replication| This section gives the stats for cross-colo replication of this
topic.|
-|replicationBacklog| The outbound replication backlog in messages.|
-|connected| Whether the outbound replicator is connected.|
-|replicationDelayInSeconds| How long the oldest message has been waiting to be
sent through the connection, if connected is true.|
-|inboundConnection| The IP and port of the broker in the publisher connection
of remote cluster to this broker. |
-|inboundConnectedSince| The TCP connection being used to publish messages to
the remote cluster. If no local publishers are connected, this connection is
automatically closed after a minute.|
-
-
-## Topics
+|connectedSince| The timestamp when this producer is created or reconnected
last time.|
+|accessMode| The type of access to the topic that the producer requires.|
+|msgRateIn| The total rate of messages (message per second) published by this
publisher.|
+|msgThroughputIn| The total throughput (byte per second) of the messages
published by this publisher.|
+|averageMsgSize| The average message size in bytes from this publisher within
the last interval.|
+|chunkedMessageRate| The total rate of chunked messages published by this
publisher.|
+|clientVersion| The client library version of this producer.|
+|metadata| The metadata (key/value strings) associated with this publisher.|
-|Stat|Description|
-|---|---|
-|entriesAddedCounter| Messages published since this broker loads this topic.|
-|numberOfEntries| Total number of messages being tracked.|
-|totalSize| Total storage size in bytes of all messages.|
-|currentLedgerEntries| Count of messages written to the ledger currently open
for writing.|
-|currentLedgerSize| Size in bytes of messages written to ledger currently open
for writing.|
-|lastLedgerCreatedTimestamp| Time when last ledger is created.|
-|lastLedgerCreationFailureTimestamp| Time when last ledger is failed.|
-|waitingCursorsCount| How many cursors are caught up and waiting for a new
message to be published.|
-|pendingAddEntriesCount| How many messages have (asynchronous) write requests
you are waiting on completion.|
-|lastConfirmedEntry| The ledgerid:entryid of the last message successfully
written. If the entryid is -1, then the ledger is opened or is being currently
opened but has no entries written yet.|
-|state| The state of the cursor ledger. Open means you have a cursor ledger
for saving updates of the markDeletePosition.|
-|ledgers| The ordered list of all ledgers for this topic holding its messages.|
-|cursors| The list of all cursors on this topic. Every subscription you saw in
the topic stats has one.|
-|markDeletePosition| The ack position: the last message the subscriber
acknowledges receiving.|
-|readPosition| The latest position of subscriber for reading message.|
-|waitingReadOp| This is true when the subscription reads the latest message
that is published to the topic and waits on new messages to be published.|
-|pendingReadOps| The counter for how many outstanding read requests to the
BookKeepers you have in progress.|
-|messagesConsumedCounter| Number of messages this cursor acks since this
broker loads this topic.|
-|cursorLedger| The ledger used to persistently store the current
markDeletePosition.|
-|cursorLedgerLastEntry| The last entryid used to persistently store the
current markDeletePosition.|
-|individuallyDeletedMessages| If Acks are done out of order, shows the ranges
of messages Acked between the markDeletePosition and the read-position.|
-|lastLedgerSwitchTimestamp| The last time the cursor ledger is rolled over.|
+### Subscription stats
+
+| Stat | Description
|
+|--------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| my-subscription | The name of this
subscription. It is defined by the client.
|
+| msgRateOut | The total rate of
messages (message per second) delivered on this subscription.
|
+| msgThroughputOut | The total throughput
(byte per second) delivered on this subscription.
|
+| msgBacklog | The number of messages in
the subscription backlog.
|
+| type | This subscription type.
|
+| msgRateExpired | The rate at which
messages are discarded instead of dispatched from this subscription due to TTL.
|
+| lastExpireTimestamp | The timestamp of the last
message expiration.
|
+| lastConsumedFlowTimestamp | The timestamp of the last
flow command received.
|
+| lastConsumedTimestamp | The latest timestamp of
all the consumed timestamps of the consumers.
|
+| lastAckedTimestamp | The latest timestamp of
all the acknowledged timestamps of the consumers.
|
+| msgRateRedeliver | The total rate of
messages redelivered on this subscription (message per second).
|
+| chunkedMessageRate | The chunked message
dispatch rate.
|
+| earliestMsgPublishTimeInBacklog | The publish time of the
earliest message in the backlog for the subscription (in milliseconds).
|
+| msgBacklogNoDelayed | The number of messages in
the subscription backlog that do not contain the delay messages.
|
+| blockedSubscriptionOnUnackedMsgs | The flag to verify if a
subscription is blocked due to reaching the threshold of unacked messages.
|
+| msgDelayed | The number of delayed
messages that are currently tracked.
|
+| unackedMessages | The number of
unacknowledged messages for the subscription, where an unacknowledged message
is one that has been sent to a consumer but not yet acknowledged. This field is
only meaningful when using a subscription that tracks individual message
acknowledgment. |
+| activeConsumerName | The name of the consumer
that is active for single active consumer subscriptions (such as failover or
exclusive).
|
+| totalMsgExpired | The total messages
expired on this subscription.
|
+| lastMarkDeleteAdvancedTimestamp | The last `MarkDelete`
position advanced timestamp.
|
+| durable | Whether the subscription
is durable or ephemeral (for example, from a reader).
|
+| replicated | Mark that the
subscription state is kept in sync across different regions.
|
+| allowOutOfOrderDelivery | Whether out-of-order
delivery is allowed on the Key_Shared subscription.
|
+| keySharedMode | The options of the
Key_Shared subscription mode include `AUTO_SPLIT` or `STICKY`.
|
+| consumersAfterMarkDeletePosition | Get
`recentJoinedConsumers` for the Key_Shared subscription.
|
+| filterProcessedMsgCount | The number of messages
processed by `EntryFilter`.
|
+| filterAcceptedMsgCount | The number of messages
accepted by `EntryFilter`.
|
+| filterRejectedMsgCount | The number of messages
rejected by `EntryFilter`.
|
+| filterRescheduledMsgCount | The number of messages
rescheduled by `EntryFilter`.
|
+| bytesOutCounter | The total bytes delivered
to a consumer.
|
+| msgOutCounter | The total messages
delivered to a consumer.
|
+| backlogSize | The size of backlog for
this subscription (in bytes).
|
+| nonContiguousDeletedMessagesRanges | The number of
non-contiguous deleted messages ranges.
|
+| nonContiguousDeletedMessagesRangesSerializedSize | The serialized size of
non-contiguous deleted messages ranges.
|
+| [consumers](#consumer-stats) | The list of connected
consumers for this subscription.
|
+
+### Consumer stats
+
+| Stat | Description
|
+|------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| consumerName | Internal identifier for this consumer,
generated by the client library.
|
+| msgRateOut | The total rate of messages (message per
second) delivered to the consumer.
|
+| msgThroughputOut | The total throughput (byte per second)
delivered to the consumer.
|
+| availablePermits | The number of messages that the consumer has
space for in the client library's listening queue. `0` means the client
library's queue is full and `receive()` isn't called. A non-zero value means
this consumer is ready for dispatched messages. |
+| unackedMessages | The number of unacknowledged messages for the
consumer, where an unacknowledged message has been sent to the consumer but not
yet acknowledged. This field is only meaningful when using a subscription that
tracks individual message acknowledgment. |
+| blockedConsumerOnUnackedMsgs | The flag used to verify if the consumer is
blocked due to reaching the threshold of the unacknowledged messages.
|
+| lastConsumedTimestamp | The timestamp when the consumer reads a
message the last time.
|
+| lastAckedTimestamp | The timestamp when the consumer acknowledges
a message the last time.
|
+| address | The IP address and source port for the
connection of this consumer.
|
+| connectedSince | The timestamp when this consumer is created
or reconnected last time.
|
+| clientVersion | The client library version of this consumer.
|
+| bytesOutCounter | The total bytes delivered to a consumer.
|
+| msgOutCounter | The total messages delivered to a consumer.
|
+| msgRateRedeliver | The total rate of messages redelivered by
this consumer (message per second).
|
+| chunkedMessageRate | The total rate of chunked messages delivered
to this consumer.
|
+| avgMessagesPerEntry | The number of average messages per entry for
the consumer consumed.
|
+| readPositionWhenJoining | The read position of the cursor when the
consumer joins.
|
+| keyHashRanges | The hash ranges assigned to this consumer if
it uses Key_Shared sub mode.
|
+| metadata | The metadata (key/value strings) associated
with this consumer.
|
+
+### Replication stats
+
+| Stat | Description
|
+|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| msgRateIn | The total rate (message per second) of messages
received from the remote cluster.
|
+| msgThroughputIn | The total throughput (byte per second) received
from the remote cluster.
|
+| msgRateOut | The total rate of messages (message per second)
delivered to the replication-subscriber.
|
+| msgThroughputOut | The total throughput (byte per second) delivered
to the replication-subscriber.
|
+| msgRateExpired | The total rate of messages (message per second)
expired.
|
+| replicationBacklog | The number of messages pending to be replicated
to remote cluster.
|
+| connected | Whether the outbound replicator is connected.
|
+| replicationDelayInSeconds | How long the oldest message has been waiting to
be sent through the connection when connected.
|
+| inboundConnection | The IP and port of the broker in the remote
cluster's publisher connection to this broker.
|
+| inboundConnectedSince | The TCP connection used to publish messages to
the remote cluster. If no local publishers are connected, this connection is
automatically closed after a minute. |
+| outboundConnection | The address of the outbound replication
connection.
|
+| outboundConnectedSince | The timestamp of establishing an outbound
connection.
|
+
+## Topic internal stats
+
+The following table outlines the internal stats inside a topic. For more
details about how to get these stats, see [Get
stats](admin-api-topics.md#get-internal-stats).
+
+| Stat | Description
|
+|------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| entriesAddedCounter | Messages published since this broker
loads this topic.
|
+| numberOfEntries | The total number of messages tracked.
|
+| totalSize | The total storage size in bytes of all
messages.
|
+| currentLedgerEntries | The count of messages written to the
ledger that is currently open for writing.
|
+| currentLedgerSize | The size in bytes of messages written
to the ledger that is currently open for writing.
|
+| lastLedgerCreatedTimestamp | The time when the last ledger is
created.
|
+| lastLedgerCreationFailureTimestamp | The time when the last ledger is
failed.
|
+| waitingCursorsCount | The number of cursors that are caught
up and waiting for a new message to be published.
|
+| pendingAddEntriesCount | The number of messages that have write
requests (asynchronous) waiting on completion.
|
+| lastConfirmedEntry | The `ledgerid:entryid` of the last
message that is written successfully. If the `entryid` is `-1`, then the ledger
is opened or is currently opened but has no entries written yet. |
+| state | The state of the cursor ledger. The
state `LedgerOpened` means that a ledger is open for saving published messages.
|
+| ledgers | The ordered list of all ledgers for
this topic that holds its messages.
|
+| cursors | The list of all cursors on this topic.
Each subscription in the topic stats has a cursor.
|
+| markDeletePosition | The ack position: the last message that
the subscriber acknowledges. All messages before this position are acknowledged
by the subscriber. |
+| readPosition | The latest position of the subscriber
for reading messages.
|
+| waitingReadOp | This is true when the subscription
reads the latest message that is published to the topic and waits for new
messages to be published. |
+| pendingReadOps | The count of outstanding read requests
to the BookKeepers in progress.
|
+| messagesConsumedCounter | The number of messages this cursor has
acknowledged since this broker loads this topic.
|
+| cursorLedger | The ledger used to persistently store
the current `markDeletePosition`.
|
+| cursorLedgerLastEntry | The last `entryid` used to persistently
store the current `markDeletePosition`.
|
+| individuallyDeletedMessages | The range of messages acknowledged
between `markDeletePosition` and the `readPosition` when acknowledges are done
out of order. |
+| lastLedgerSwitchTimestamp | The last time when the cursor ledger is
rolled over.
|
+| ledgers | The ordered list of all ledgers for
this topic that holds messages.
|
+| schemaLedgers | The ordered list of all ledgers for
this topic schema.
|
+| compactedLedger | The ledgers holding un-acked messages
after topic compaction.
|
+| ledgerId | The ID of this ledger.
|
+| entries | The total number of entries that belong
to this ledger.
|
+| size | The size of messages written to this
ledger (in bytes).
|
+| offloaded | Whether this ledger is offloaded. The
value is `false` for the compacted topic ledger.
|
+| metadata | The ledger metadata.
|
\ No newline at end of file
