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 fdf9023be28 docs(administration-stats): clarify
messagesConsumedCounter tracks entries, not messages (#1126)
fdf9023be28 is described below
commit fdf9023be28bdd148763490e34b00cd646abac67
Author: Vishal Kumar Singh <[email protected]>
AuthorDate: Wed Apr 22 14:31:52 2026 +0530
docs(administration-stats): clarify messagesConsumedCounter tracks entries,
not messages (#1126)
The internal cursor counter is incremented from getNumberOfEntries(...) in
ManagedCursorImpl, NonDurableCursorImpl, and ReadOnlyCursorImpl, so what it
actually reports is the number of managed-ledger entries the cursor has
acknowledged. In Pulsar an entry can hold a batch of user-visible messages, so
the previous wording was off by a batching factor. Reword the row and add a
short inline note so users of topic internal stats are not misled.
Closes apache/pulsar#23702.
---
docs/administration-stats.md | 2 +-
versioned_docs/version-3.3.x/administration-stats.md | 2 +-
versioned_docs/version-4.1.x/administration-stats.md | 2 +-
versioned_docs/version-4.2.x/administration-stats.md | 2 +-
4 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/docs/administration-stats.md b/docs/administration-stats.md
index 1f5f3a48a7b..49cfea2c2ab 100644
--- a/docs/administration-stats.md
+++ b/docs/administration-stats.md
@@ -176,7 +176,7 @@ The following table outlines the internal stats inside a
topic. For more details
| 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.
|
+| messagesConsumedCounter | The number of entries (not messages --
an entry can contain a batch of messages) this cursor has acknowledged since
this broker loaded 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. |
diff --git a/versioned_docs/version-3.3.x/administration-stats.md
b/versioned_docs/version-3.3.x/administration-stats.md
index ab701f6bd31..18946730545 100644
--- a/versioned_docs/version-3.3.x/administration-stats.md
+++ b/versioned_docs/version-3.3.x/administration-stats.md
@@ -168,7 +168,7 @@ The following table outlines the internal stats inside a
topic. For more details
| 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.
|
+| messagesConsumedCounter | The number of entries (not messages --
an entry can contain a batch of messages) this cursor has acknowledged since
this broker loaded 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. |
diff --git a/versioned_docs/version-4.1.x/administration-stats.md
b/versioned_docs/version-4.1.x/administration-stats.md
index 1f5f3a48a7b..49cfea2c2ab 100644
--- a/versioned_docs/version-4.1.x/administration-stats.md
+++ b/versioned_docs/version-4.1.x/administration-stats.md
@@ -176,7 +176,7 @@ The following table outlines the internal stats inside a
topic. For more details
| 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.
|
+| messagesConsumedCounter | The number of entries (not messages --
an entry can contain a batch of messages) this cursor has acknowledged since
this broker loaded 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. |
diff --git a/versioned_docs/version-4.2.x/administration-stats.md
b/versioned_docs/version-4.2.x/administration-stats.md
index 1f5f3a48a7b..49cfea2c2ab 100644
--- a/versioned_docs/version-4.2.x/administration-stats.md
+++ b/versioned_docs/version-4.2.x/administration-stats.md
@@ -176,7 +176,7 @@ The following table outlines the internal stats inside a
topic. For more details
| 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.
|
+| messagesConsumedCounter | The number of entries (not messages --
an entry can contain a batch of messages) this cursor has acknowledged since
this broker loaded 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. |
