This is an automated email from the ASF dual-hosted git repository.
junma 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 ffac3c899ea Indicate metrics are reset upon restart and mark the ones
the don't (#363)
ffac3c899ea is described below
commit ffac3c899ea4051a35495e69938bfd45891da32b
Author: Asaf Mesika <[email protected]>
AuthorDate: Wed Jan 11 05:03:22 2023 +0200
Indicate metrics are reset upon restart and mark the ones the don't (#363)
* Indicate metrics are reset upon restart and mark the one the don't
* Fix preview instructions
* Update docs/administration-stats.md
Co-authored-by: Anonymitaet <[email protected]>
* Update docs/administration-stats.md
Co-authored-by: Anonymitaet <[email protected]>
* Update versioned_docs/version-2.10.x/admin-api-topics.md
Co-authored-by: Anonymitaet <[email protected]>
* Update versioned_docs/version-2.10.x/admin-api-topics.md
Co-authored-by: Anonymitaet <[email protected]>
* Update versioned_docs/version-2.10.x/admin-api-topics.md
Co-authored-by: Anonymitaet <[email protected]>
* Update contribute/document-preview.md
Co-authored-by: Anonymitaet <[email protected]>
Co-authored-by: Anonymitaet <[email protected]>
---
contribute/document-preview.md | 3 ++
docs/administration-stats.md | 63 +++++++++++++----------
versioned_docs/version-2.10.x/admin-api-topics.md | 16 ++++--
3 files changed, 49 insertions(+), 33 deletions(-)
diff --git a/contribute/document-preview.md b/contribute/document-preview.md
index c935883fe53..3976beae9cb 100644
--- a/contribute/document-preview.md
+++ b/contribute/document-preview.md
@@ -60,6 +60,9 @@ By default, a browser window will open at
[http://localhost:3000](http://localho
+::: tip
+When you click on `Docs`, you are taken to the latest stable version (e.g.,
`http://localhost:3000/docs/2.10.x/`). If you want to preview changes on
`master`, change the URL to `http://localhost:3000/docs/next`
+:::
### Stop preview
Switch to your command-line interface and press **Control+C**.
diff --git a/docs/administration-stats.md b/docs/administration-stats.md
index ff6a5588a0a..b1dfaa53524 100644
--- a/docs/administration-stats.md
+++ b/docs/administration-stats.md
@@ -8,32 +8,39 @@ sidebar_label: "Pulsar statistics"
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.
|
+:::note
+
+All metrics below are *reset* to 0 upon broker restart, *except* gauges marked
as "Not reset upon restart".
+
+:::
+
+
+| 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. Not reset upon restart |
+| earliestMsgPublishTimeInBacklogs | The publish time of the
earliest message in the backlog (in milliseconds). Not reset upon restart
|
+| 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). Not reset upon restart
|
+| offloadedStorageSize | Space that is used to
store the offloaded messages for the topic (in bytes). Not reset upon restart
|
+| 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
@@ -67,7 +74,7 @@ The following table outlines the stats of a topic. For more
details about how to
| 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).
|
+| earliestMsgPublishTimeInBacklog | The publish time of the
earliest message in the backlog for the subscription (in milliseconds). Note
that **this metric is not reset upon restart**.
|
| 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.
|
@@ -86,7 +93,7 @@ The following table outlines the stats of a topic. For more
details about how to
| 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).
|
+| backlogSize | The size of backlog for
this subscription (in bytes). Note that **this metric is not reset upon
restart**.
|
| 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.
|
diff --git a/versioned_docs/version-2.10.x/admin-api-topics.md
b/versioned_docs/version-2.10.x/admin-api-topics.md
index 0625d1c58da..1910a337aca 100644
--- a/versioned_docs/version-2.10.x/admin-api-topics.md
+++ b/versioned_docs/version-2.10.x/admin-api-topics.md
@@ -290,7 +290,13 @@ admin.topics().unload(topic);
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).
+:::note
+
+All metrics below are *reset* to 0 upon broker restart, *except* gauges marked
as "Not reset upon restart".
+
+:::
+
+- **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).
@@ -300,7 +306,7 @@ You can check the following statistics of a given
non-partitioned topic.
- **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.
+ - **storageSize**: The sum of the ledgers' storage size for this topic.
The space used to store the messages for the topic. Not reset upon restart.
- **earliestMsgPublishTimeInBacklogs**: The publish time of the earliest
message in the backlog (ms).
@@ -314,9 +320,9 @@ You can check the following statistics of a given
non-partitioned topic.
- **msgChunkPublished**: Topic has chunked message published on it.
- - **backlogSize**: Estimated total unconsumed or backlog size (in bytes).
+ - **backlogSize**: Estimated total unconsumed or backlog size (in bytes).
Note that **this metric is not reset upon restart**.
- - **offloadedStorageSize**: Space used to store the offloaded messages for
the topic (in bytes).
+ - **offloadedStorageSize**: Space used to store the offloaded messages for
the topic (in bytes). Note that **this metric is not reset upon restart**.
- **waitingPublishers**: The number of publishers waiting in a queue in
exclusive access mode.
@@ -384,7 +390,7 @@ You can check the following statistics of a given
non-partitioned topic.
- **backlogSize**: Size of backlog for this subscription (in
bytes).
- - **earliestMsgPublishTimeInBacklog**: The publish time of the
earliest message in the backlog for the subscription (ms).
+ - **earliestMsgPublishTimeInBacklog**: The publish time of the
earliest message in the backlog for the subscription (ms). Note that **this
metric is not reset upon restart**.
- **msgBacklogNoDelayed**: Number of messages in the subscription
backlog that do not contain the delay messages.
