This is an automated email from the ASF dual-hosted git repository. lhotari 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 9e42c494ab5 [fix][doc] Update Topic stats for PIP-379 (#998)
9e42c494ab5 is described below
commit 9e42c494ab5cdea2419fb88f1227526b58b2057e
Author: Hideaki Oguni <[email protected]>
AuthorDate: Sat Apr 5 01:19:05 2025 +0900
[fix][doc] Update Topic stats for PIP-379 (#998)
* update stats for pip-379
* update versioned_docs
---
docs/administration-stats.md | 56 ++++++++++++----------
.../version-4.0.x/administration-stats.md | 56 ++++++++++++----------
2 files changed, 62 insertions(+), 50 deletions(-)
diff --git a/docs/administration-stats.md b/docs/administration-stats.md
index 0e9c851af6d..1f5f3a48a7b 100644
--- a/docs/administration-stats.md
+++ b/docs/administration-stats.md
@@ -91,8 +91,9 @@ All stats below are **reset** to 0 upon broker restart or
topic unloading, **exc
| 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
`recentlyJoinedConsumers` for the Key_Shared subscription.
|
-| lastSentPosition | The position that all
messages up to that position have been dispatched to the consumers. This is for
Key_Shared subscription.
|
-| individuallySentPositions | Set of individually sent
ranges. This is for Key_Shared subscription.
|
+| drainingHashesCount | The current number of
hashes in the draining state for the Key_Shared AUTO_SPLIT ordered
subscription.
|
+| drainingHashesClearedTotal | The total number of
hashes cleared from the draining state for the connected consumers for the
Key_Shared AUTO_SPLIT ordered subscription.
|
+| drainingHashesUnackedMessages | The total number of
unacked messages for all draining hashes for the Key_Shared AUTO_SPLIT ordered
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`.
|
@@ -106,29 +107,34 @@ All stats below are **reset** to 0 upon broker restart or
topic unloading, **exc
### 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 (Deprecated) | The timestamp when the consumer reads a
message the last time.
|
-| lastConsumedTime | The time when the consumer reads a
message the last time.
|
-| lastAckedTimestamp (Deprecated) | The timestamp when the consumer
acknowledges a message the last time.
|
-| lastAckedTime | The time 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.
|
-| lastSentPositionWhenJoining | The last sent 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.
|
+| 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 (Deprecated) | The timestamp when the consumer reads
a message the last time.
|
+| lastConsumedTime | The time when the consumer reads a
message the last time.
|
+| lastAckedTimestamp (Deprecated) | The timestamp when the consumer
acknowledges a message the last time.
|
+| lastAckedTime | The time 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 (Deprecated) | The read position of the cursor when
the consumer joins.
|
+| drainingHashesCount | The current number of hashes in the
draining stated for the Key_Shared AUTO_SPLIT ordered subscription.
|
+| drainingHashesClearedTotal | The total number of hashes cleared
from the draining state for this consumer for the Key_Shared AUTO_SPLIT ordered
subscription.
|
+| drainingHashesUnackedMessages | The total number of unacked messages
for all draining hashes for the Key_Shared AUTO_SPLIT ordered subscription.
|
+| drainingHashes | The draining hashes of this consumer
for the Key_Shared AUTO_SPLIT ordered subscription.
|
+| keyHashRanges | The hash ranges assigned to this
consumer if it uses Key_Shared sub mode (used when
`subscriptionKeySharedUseClassicPersistentImplementation` is set to `true`).
|
+| keyHashRangeArrays | The hash ranges assigned to this
consumer if it uses Key_Shared sub mode (used when
`subscriptionKeySharedUseClassicPersistentImplementation` is set to `false`).
|
+| metadata | The metadata (key/value strings)
associated with this consumer.
|
### Replication stats
diff --git a/versioned_docs/version-4.0.x/administration-stats.md
b/versioned_docs/version-4.0.x/administration-stats.md
index 0e9c851af6d..1f5f3a48a7b 100644
--- a/versioned_docs/version-4.0.x/administration-stats.md
+++ b/versioned_docs/version-4.0.x/administration-stats.md
@@ -91,8 +91,9 @@ All stats below are **reset** to 0 upon broker restart or
topic unloading, **exc
| 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
`recentlyJoinedConsumers` for the Key_Shared subscription.
|
-| lastSentPosition | The position that all
messages up to that position have been dispatched to the consumers. This is for
Key_Shared subscription.
|
-| individuallySentPositions | Set of individually sent
ranges. This is for Key_Shared subscription.
|
+| drainingHashesCount | The current number of
hashes in the draining state for the Key_Shared AUTO_SPLIT ordered
subscription.
|
+| drainingHashesClearedTotal | The total number of
hashes cleared from the draining state for the connected consumers for the
Key_Shared AUTO_SPLIT ordered subscription.
|
+| drainingHashesUnackedMessages | The total number of
unacked messages for all draining hashes for the Key_Shared AUTO_SPLIT ordered
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`.
|
@@ -106,29 +107,34 @@ All stats below are **reset** to 0 upon broker restart or
topic unloading, **exc
### 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 (Deprecated) | The timestamp when the consumer reads a
message the last time.
|
-| lastConsumedTime | The time when the consumer reads a
message the last time.
|
-| lastAckedTimestamp (Deprecated) | The timestamp when the consumer
acknowledges a message the last time.
|
-| lastAckedTime | The time 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.
|
-| lastSentPositionWhenJoining | The last sent 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.
|
+| 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 (Deprecated) | The timestamp when the consumer reads
a message the last time.
|
+| lastConsumedTime | The time when the consumer reads a
message the last time.
|
+| lastAckedTimestamp (Deprecated) | The timestamp when the consumer
acknowledges a message the last time.
|
+| lastAckedTime | The time 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 (Deprecated) | The read position of the cursor when
the consumer joins.
|
+| drainingHashesCount | The current number of hashes in the
draining stated for the Key_Shared AUTO_SPLIT ordered subscription.
|
+| drainingHashesClearedTotal | The total number of hashes cleared
from the draining state for this consumer for the Key_Shared AUTO_SPLIT ordered
subscription.
|
+| drainingHashesUnackedMessages | The total number of unacked messages
for all draining hashes for the Key_Shared AUTO_SPLIT ordered subscription.
|
+| drainingHashes | The draining hashes of this consumer
for the Key_Shared AUTO_SPLIT ordered subscription.
|
+| keyHashRanges | The hash ranges assigned to this
consumer if it uses Key_Shared sub mode (used when
`subscriptionKeySharedUseClassicPersistentImplementation` is set to `true`).
|
+| keyHashRangeArrays | The hash ranges assigned to this
consumer if it uses Key_Shared sub mode (used when
`subscriptionKeySharedUseClassicPersistentImplementation` is set to `false`).
|
+| metadata | The metadata (key/value strings)
associated with this consumer.
|
### Replication stats
