This is an automated email from the ASF dual-hosted git repository.
liuyu 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 64e36a77601 [feat][doc] Add Observability Guide (#502)
64e36a77601 is described below
commit 64e36a7760189b30113a62bbecf6bd74e3381ad7
Author: Anonymitaet <[email protected]>
AuthorDate: Thu Apr 6 12:19:29 2023 +0800
[feat][doc] Add Observability Guide (#502)
---
docs/administration-stats.md | 16 ++++++++--------
docs/deploy-monitoring.md | 2 +-
docs/reference-metrics.md | 2 +-
sidebars.json | 14 ++++++++++----
versioned_docs/version-2.10.x/administration-stats.md | 9 ++++++++-
versioned_docs/version-2.11.x/administration-stats.md | 15 +++++++--------
6 files changed, 35 insertions(+), 23 deletions(-)
diff --git a/docs/administration-stats.md b/docs/administration-stats.md
index b1dfaa53524..76e3854e71e 100644
--- a/docs/administration-stats.md
+++ b/docs/administration-stats.md
@@ -1,7 +1,7 @@
---
id: administration-stats
title: Pulsar stats
-sidebar_label: "Pulsar statistics"
+sidebar_label: "Statistics"
---
## Topic stats
@@ -10,7 +10,7 @@ The following table outlines the stats of a topic. For more
details about how to
:::note
-All metrics below are *reset* to 0 upon broker restart, *except* gauges marked
as "Not reset upon restart".
+All stats below are **reset** to 0 upon broker restart or topic unloading,
**except** the stats marked with asterisks * (the values of them **keep
unchanged**).
:::
@@ -22,15 +22,15 @@ All metrics below are *reset* to 0 upon broker restart,
*except* gauges marked a
| 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
|
+| storageSize* | The sum of the ledgers'
storage size **in BookKeeper** for a topic (in bytes). <br/><br/>**Note**: the
`total storage size of a topic` = `storageSize` + `offloadedStorageSize`. |
+| offloadedStorageSize* | The sum of the storage
size **in tiered storage** for a topic (in bytes).<br/><br/>**Note**: the
`total storage size of a topic` = `storageSize` + `offloadedStorageSize`.
+| 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). Not reset upon restart
|
-| offloadedStorageSize | Space that is used to
store the offloaded messages for the topic (in bytes). Not reset upon restart
|
+| backlogSize* | The estimated total
unconsumed or backlog size (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.
|
@@ -74,7 +74,7 @@ All metrics below are *reset* to 0 upon broker restart,
*except* gauges marked a
| 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). Note
that **this metric is not reset upon restart**.
|
+| 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.
|
@@ -93,7 +93,7 @@ All metrics below are *reset* to 0 upon broker restart,
*except* gauges marked a
| 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). Note that **this metric is not reset upon
restart**.
|
+| 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.
|
diff --git a/docs/deploy-monitoring.md b/docs/deploy-monitoring.md
index 241b735bbdd..3f038d0abfd 100644
--- a/docs/deploy-monitoring.md
+++ b/docs/deploy-monitoring.md
@@ -1,7 +1,7 @@
---
id: deploy-monitoring
title: Monitor
-sidebar_label: "Monitor"
+sidebar_label: "Monitoring"
---
You can use different ways to monitor a Pulsar cluster, exposing both metrics
related to the usage of topics and the overall health of the individual
components of the cluster.
diff --git a/docs/reference-metrics.md b/docs/reference-metrics.md
index a43e6a7c2f7..e282065ed87 100644
--- a/docs/reference-metrics.md
+++ b/docs/reference-metrics.md
@@ -1,7 +1,7 @@
---
id: reference-metrics
title: Pulsar metrics
-sidebar_label: "Pulsar metrics"
+sidebar_label: "Metrics"
---
diff --git a/sidebars.json b/sidebars.json
index 8e4234b1917..d5724f7a9f4 100644
--- a/sidebars.json
+++ b/sidebars.json
@@ -234,8 +234,7 @@
},
"deploy-bare-metal",
"deploy-bare-metal-multi-cluster",
- "deploy-docker",
- "deploy-monitoring"
+ "deploy-docker"
]
},
{
@@ -247,7 +246,6 @@
"administration-geo",
"administration-pulsar-manager",
"administration-pulsar-shell",
- "administration-stats",
"administration-load-balance",
"administration-proxy",
"administration-upgrade",
@@ -265,6 +263,15 @@
}
]
},
+ {
+ "type": "category",
+ "label": "Observability",
+ "items": [
+ "administration-stats",
+ "reference-metrics",
+ "deploy-monitoring"
+ ]
+ },
{
"type": "category",
"label": "Security",
@@ -506,7 +513,6 @@
"reference-terminology",
"reference-cli-tools",
"reference-configuration",
- "reference-metrics",
{
"type": "link",
"href": "/release-notes/",
diff --git a/versioned_docs/version-2.10.x/administration-stats.md
b/versioned_docs/version-2.10.x/administration-stats.md
index ac0c03602f3..d39f05917b0 100644
--- a/versioned_docs/version-2.10.x/administration-stats.md
+++ b/versioned_docs/version-2.10.x/administration-stats.md
@@ -5,6 +5,12 @@ sidebar_label: "Pulsar statistics"
original_id: administration-stats
---
+:::note
+
+All stats below are **reset** to 0 upon broker restart or topic unloading,
**except** the stats marked with asterisks * (the values of them **keep
unchanged**).
+
+:::
+
## Partitioned topics
|Stat|Description|
@@ -14,7 +20,8 @@ original_id: administration-stats
|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.|
+| storageSize* | The sum of the ledgers'
storage size **in BookKeeper** for a topic (in bytes). <br/><br/>**Note**: the
`total storage size of a topic` = `storageSize` + `offloadedStorageSize`. |
+| offloadedStorageSize* | The sum of the storage
size **in tiered storage** for a topic (in bytes).<br/><br/>**Note**: the
`total storage size of a topic` = `storageSize` + `offloadedStorageSize`.
|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.|
diff --git a/versioned_docs/version-2.11.x/administration-stats.md
b/versioned_docs/version-2.11.x/administration-stats.md
index b1dfaa53524..2d756f8fa93 100644
--- a/versioned_docs/version-2.11.x/administration-stats.md
+++ b/versioned_docs/version-2.11.x/administration-stats.md
@@ -10,11 +10,10 @@ The following table outlines the stats of a topic. For more
details about how to
:::note
-All metrics below are *reset* to 0 upon broker restart, *except* gauges marked
as "Not reset upon restart".
+All stats below are **reset** to 0 upon broker restart or topic unloading,
**except** the stats marked with asterisks * (the values of them **keep
unchanged**).
:::
-
| Stat | Description
|
|--------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------|
| msgRateIn | The sum of all local and
replication publishers' publish rates (message per second).
|
@@ -22,15 +21,15 @@ All metrics below are *reset* to 0 upon broker restart,
*except* gauges marked a
| 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
|
+| storageSize* | The sum of the ledgers'
storage size **in BookKeeper** for a topic (in bytes). <br/><br/>**Note**: the
`total storage size of a topic` = `storageSize` + `offloadedStorageSize`. |
+| offloadedStorageSize* | The sum of the storage
size **in tiered storage** for a topic (in bytes).<br/><br/>**Note**: the
`total storage size of a topic` = `storageSize` + `offloadedStorageSize`.
+| 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). Not reset upon restart
|
-| offloadedStorageSize | Space that is used to
store the offloaded messages for the topic (in bytes). Not reset upon restart
|
+| backlogSize* | The estimated total
unconsumed or backlog size (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.
|
@@ -74,7 +73,7 @@ All metrics below are *reset* to 0 upon broker restart,
*except* gauges marked a
| 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). Note
that **this metric is not reset upon restart**.
|
+| 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.
|
@@ -93,7 +92,7 @@ All metrics below are *reset* to 0 upon broker restart,
*except* gauges marked a
| 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). Note that **this metric is not reset upon
restart**.
|
+| 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.
|
