[Doc] Fix doc for chunked message related stats. (#13598)
Motivation
The current documentation has some errors in the description of the stats related to chunked messages
Modification
Fix doc for chunked message related stats.
Signed-off-by: Zike Yang <zkyang@streamnative.io>
diff --git a/pulsar-client-admin-api/src/main/java/org/apache/pulsar/common/policies/data/ConsumerStats.java b/pulsar-client-admin-api/src/main/java/org/apache/pulsar/common/policies/data/ConsumerStats.java
index 7204af6..c78c17c 100644
--- a/pulsar-client-admin-api/src/main/java/org/apache/pulsar/common/policies/data/ConsumerStats.java
+++ b/pulsar-client-admin-api/src/main/java/org/apache/pulsar/common/policies/data/ConsumerStats.java
@@ -40,7 +40,7 @@
/** Total rate of messages redelivered by this consumer (msg/s). */
double getMsgRateRedeliver();
- /** Total chunked messages dispatched. */
+ /** The total rate of chunked messages delivered to this consumer. */
double getChunkedMessageRate();
/** Name of the consumer. */
diff --git a/pulsar-client-admin-api/src/main/java/org/apache/pulsar/common/policies/data/PublisherStats.java b/pulsar-client-admin-api/src/main/java/org/apache/pulsar/common/policies/data/PublisherStats.java
index b20c128..f3cf614 100644
--- a/pulsar-client-admin-api/src/main/java/org/apache/pulsar/common/policies/data/PublisherStats.java
+++ b/pulsar-client-admin-api/src/main/java/org/apache/pulsar/common/policies/data/PublisherStats.java
@@ -37,7 +37,7 @@
/** Average message size published by this publisher. */
double getAverageMsgSize();
- /** total chunked message count received. **/
+ /** The total rate of chunked messages published by this publisher. **/
double getChunkedMessageRate();
/** Id of this publisher. */
diff --git a/pulsar-common/src/main/java/org/apache/pulsar/common/policies/data/stats/ConsumerStatsImpl.java b/pulsar-common/src/main/java/org/apache/pulsar/common/policies/data/stats/ConsumerStatsImpl.java
index 47f6148..81fd6d3 100644
--- a/pulsar-common/src/main/java/org/apache/pulsar/common/policies/data/stats/ConsumerStatsImpl.java
+++ b/pulsar-common/src/main/java/org/apache/pulsar/common/policies/data/stats/ConsumerStatsImpl.java
@@ -45,7 +45,7 @@
/** Total rate of messages redelivered by this consumer (msg/s). */
public double msgRateRedeliver;
- /** Total chunked messages dispatched. */
+ /** The total rate of chunked messages delivered to this consumer. */
public double chunkedMessageRate;
/** Name of the consumer. */
diff --git a/pulsar-common/src/main/java/org/apache/pulsar/common/policies/data/stats/PublisherStatsImpl.java b/pulsar-common/src/main/java/org/apache/pulsar/common/policies/data/stats/PublisherStatsImpl.java
index ac0318d..e66bc9a 100644
--- a/pulsar-common/src/main/java/org/apache/pulsar/common/policies/data/stats/PublisherStatsImpl.java
+++ b/pulsar-common/src/main/java/org/apache/pulsar/common/policies/data/stats/PublisherStatsImpl.java
@@ -43,7 +43,7 @@
/** Average message size published by this publisher. */
public double averageMsgSize;
- /** total chunked message count received. **/
+ /** The total rate of chunked messages published by this publisher. **/
public double chunkedMessageRate;
/** Id of this publisher. */
diff --git a/site2/docs/admin-api-topics.md b/site2/docs/admin-api-topics.md
index c21a04c..73bf850 100644
--- a/site2/docs/admin-api-topics.md
+++ b/site2/docs/admin-api-topics.md
@@ -233,7 +233,7 @@
- **averageMsgSize**: The average message size in bytes from this publisher within the last interval.
- - **chunkedMessageRate**: Total chunked message count received for this producer on this topic.
+ - **chunkedMessageRate**: The total rate of chunked messages published by this publisher.
- **producerId**: The internal identifier for this producer on this topic.
@@ -339,7 +339,7 @@
- **msgRateRedeliver**: Total rate of messages redelivered by this consumer (msg/s).
- - **chunkedMessageRate**: Total chunked messages dispatched.
+ - **chunkedMessageRate**: The total rate of chunked messages delivered to this consumer.
- **avgMessagesPerEntry**: Number of average messages per entry for the consumer consumed.
diff --git a/site2/website-next/docs/admin-api-topics.md b/site2/website-next/docs/admin-api-topics.md
index 9568e4d..f5dc896 100644
--- a/site2/website-next/docs/admin-api-topics.md
+++ b/site2/website-next/docs/admin-api-topics.md
@@ -321,7 +321,7 @@
- **averageMsgSize**: The average message size in bytes from this publisher within the last interval.
- - **chunkedMessageRate**: Total chunked message count received for this producer on this topic.
+ - **chunkedMessageRate**: The total rate of chunked messages published by this publisher. The totoal rate of
- **producerId**: The internal identifier for this producer on this topic.
@@ -425,7 +425,7 @@
- **msgRateRedeliver**: Total rate of messages redelivered by this consumer (msg/s).
- - **chunkedMessageRate**: Total chunked messages dispatched.
+ - **chunkedMessageRate**: The total rate of chunked messages delivered to this consumer.
- **avgMessagesPerEntry**: Number of average messages per entry for the consumer consumed.
diff --git a/site2/website-next/versioned_docs/version-2.9.0/admin-api-topics.md b/site2/website-next/versioned_docs/version-2.9.0/admin-api-topics.md
index cdf838c..495f914 100644
--- a/site2/website-next/versioned_docs/version-2.9.0/admin-api-topics.md
+++ b/site2/website-next/versioned_docs/version-2.9.0/admin-api-topics.md
@@ -322,7 +322,7 @@
- **averageMsgSize**: The average message size in bytes from this publisher within the last interval.
- - **chunkedMessageRate**: Total chunked message count received for this producer on this topic.
+ - **chunkedMessageRate**: The total rate of chunked messages published by this publisher.
- **producerId**: The internal identifier for this producer on this topic.
@@ -426,7 +426,7 @@
- **msgRateRedeliver**: Total rate of messages redelivered by this consumer (msg/s).
- - **chunkedMessageRate**: Total chunked messages dispatched.
+ - **chunkedMessageRate**: The total rate of chunked messages delivered to this consumer.
- **avgMessagesPerEntry**: Number of average messages per entry for the consumer consumed.
diff --git a/site2/website-next/versioned_docs/version-2.9.1/admin-api-topics.md b/site2/website-next/versioned_docs/version-2.9.1/admin-api-topics.md
index cdf838c..495f914 100644
--- a/site2/website-next/versioned_docs/version-2.9.1/admin-api-topics.md
+++ b/site2/website-next/versioned_docs/version-2.9.1/admin-api-topics.md
@@ -322,7 +322,7 @@
- **averageMsgSize**: The average message size in bytes from this publisher within the last interval.
- - **chunkedMessageRate**: Total chunked message count received for this producer on this topic.
+ - **chunkedMessageRate**: The total rate of chunked messages published by this publisher.
- **producerId**: The internal identifier for this producer on this topic.
@@ -426,7 +426,7 @@
- **msgRateRedeliver**: Total rate of messages redelivered by this consumer (msg/s).
- - **chunkedMessageRate**: Total chunked messages dispatched.
+ - **chunkedMessageRate**: The total rate of chunked messages delivered to this consumer.
- **avgMessagesPerEntry**: Number of average messages per entry for the consumer consumed.
diff --git a/site2/website/versioned_docs/version-2.9.0/admin-api-topics.md b/site2/website/versioned_docs/version-2.9.0/admin-api-topics.md
index 424827d..2e820ba 100644
--- a/site2/website/versioned_docs/version-2.9.0/admin-api-topics.md
+++ b/site2/website/versioned_docs/version-2.9.0/admin-api-topics.md
@@ -232,7 +232,7 @@
- **averageMsgSize**: The average message size in bytes from this publisher within the last interval.
- - **chunkedMessageRate**: Total chunked message count received for this producer on this topic.
+ - **chunkedMessageRate**: The total rate of chunked messages published by this publisher.
- **producerId**: The internal identifier for this producer on this topic.
@@ -336,7 +336,7 @@
- **msgRateRedeliver**: Total rate of messages redelivered by this consumer (msg/s).
- - **chunkedMessageRate**: Total chunked messages dispatched.
+ - **chunkedMessageRate**: The total rate of chunked messages delivered to this consumer.
- **avgMessagesPerEntry**: Number of average messages per entry for the consumer consumed.
diff --git a/site2/website/versioned_docs/version-2.9.1/admin-api-topics.md b/site2/website/versioned_docs/version-2.9.1/admin-api-topics.md
index e709a16..b298974 100644
--- a/site2/website/versioned_docs/version-2.9.1/admin-api-topics.md
+++ b/site2/website/versioned_docs/version-2.9.1/admin-api-topics.md
@@ -232,7 +232,7 @@
- **averageMsgSize**: The average message size in bytes from this publisher within the last interval.
- - **chunkedMessageRate**: Total chunked message count received for this producer on this topic.
+ - **chunkedMessageRate**: The total rate of chunked messages published by this publisher.
- **producerId**: The internal identifier for this producer on this topic.
@@ -336,7 +336,7 @@
- **msgRateRedeliver**: Total rate of messages redelivered by this consumer (msg/s).
- - **chunkedMessageRate**: Total chunked messages dispatched.
+ - **chunkedMessageRate**: The total rate of chunked messages delivered to this consumer.
- **avgMessagesPerEntry**: Number of average messages per entry for the consumer consumed.
