You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by pe...@apache.org on 2022/06/27 06:52:56 UTC
[pulsar] branch master updated: [doc][stats] Improve documentation for unackedMessages stat (#16213)
This is an automated email from the ASF dual-hosted git repository.
penghui pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar.git
The following commit(s) were added to refs/heads/master by this push:
new 0c2fe5a9100 [doc][stats] Improve documentation for unackedMessages stat (#16213)
0c2fe5a9100 is described below
commit 0c2fe5a9100ccf760db46500f2c076118254807f
Author: Michael Marshall <mm...@apache.org>
AuthorDate: Mon Jun 27 01:52:49 2022 -0500
[doc][stats] Improve documentation for unackedMessages stat (#16213)
---
.../org/apache/pulsar/common/policies/data/ConsumerStats.java | 8 +++++++-
.../org/apache/pulsar/common/policies/data/SubscriptionStats.java | 8 ++++++--
.../pulsar/common/policies/data/stats/ConsumerStatsImpl.java | 8 +++++++-
.../pulsar/common/policies/data/stats/SubscriptionStatsImpl.java | 8 ++++++--
site2/docs/admin-api-topics.md | 4 ++--
site2/website/versioned_docs/version-2.10.0/admin-api-topics.md | 4 ++--
site2/website/versioned_docs/version-2.7.0/admin-api-topics.md | 2 +-
site2/website/versioned_docs/version-2.7.1/admin-api-topics.md | 2 +-
site2/website/versioned_docs/version-2.7.2/admin-api-topics.md | 2 +-
site2/website/versioned_docs/version-2.7.3/admin-api-topics.md | 2 +-
site2/website/versioned_docs/version-2.7.4/admin-api-topics.md | 2 +-
site2/website/versioned_docs/version-2.8.0/admin-api-topics.md | 2 +-
site2/website/versioned_docs/version-2.8.1/admin-api-topics.md | 2 +-
site2/website/versioned_docs/version-2.8.2/admin-api-topics.md | 2 +-
site2/website/versioned_docs/version-2.8.3/admin-api-topics.md | 2 +-
site2/website/versioned_docs/version-2.9.0/admin-api-topics.md | 4 ++--
site2/website/versioned_docs/version-2.9.1/admin-api-topics.md | 4 ++--
site2/website/versioned_docs/version-2.9.2/admin-api-topics.md | 4 ++--
18 files changed, 45 insertions(+), 25 deletions(-)
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 4c165083ab1..b796ae504b9 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
@@ -54,7 +54,13 @@ public interface ConsumerStats {
/** Number of available message permits for the consumer. */
int getAvailablePermits();
- /** Number of unacknowledged messages for the consumer. */
+ /**
+ * Number of unacknowledged messages for the consumer, where an unacknowledged message is one that has been
+ * sent to the consumer but not yet acknowledged. This field is only meaningful when using a
+ * {@link org.apache.pulsar.client.api.SubscriptionType} that tracks individual message acknowledgement, like
+ * {@link org.apache.pulsar.client.api.SubscriptionType#Shared} or
+ * {@link org.apache.pulsar.client.api.SubscriptionType#Key_Shared}.
+ */
int getUnackedMessages();
/** Number of average messages per entry for the consumer consumed. */
diff --git a/pulsar-client-admin-api/src/main/java/org/apache/pulsar/common/policies/data/SubscriptionStats.java b/pulsar-client-admin-api/src/main/java/org/apache/pulsar/common/policies/data/SubscriptionStats.java
index ec4a090b7a6..4e7e9e0e1e6 100644
--- a/pulsar-client-admin-api/src/main/java/org/apache/pulsar/common/policies/data/SubscriptionStats.java
+++ b/pulsar-client-admin-api/src/main/java/org/apache/pulsar/common/policies/data/SubscriptionStats.java
@@ -66,10 +66,14 @@ public interface SubscriptionStats {
/** Number of delayed messages currently being tracked. */
long getMsgDelayed();
- /** Number of unacknowledged messages for the subscription. */
+ /**
+ * Number of unacknowledged messages for the subscription, where an unacknowledged message is one that has been
+ * sent to a consumer but not yet acknowledged. Calculated by summing all {@link ConsumerStats#getUnackedMessages()}
+ * for this subscription. See {@link ConsumerStats#getUnackedMessages()} for additional details.
+ */
long getUnackedMessages();
- /** Whether this subscription is Exclusive or Shared or Failover. */
+ /** The subscription type as defined by {@link org.apache.pulsar.client.api.SubscriptionType}. */
String getType();
/** The name of the consumer that is active for single active consumer subscriptions i.e. failover or exclusive. */
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 ae9ba67148f..b52f7234b3c 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
@@ -59,7 +59,13 @@ public class ConsumerStatsImpl implements ConsumerStats {
/** Number of available message permits for the consumer. */
public int availablePermits;
- /** Number of unacknowledged messages for the consumer. */
+ /**
+ * Number of unacknowledged messages for the consumer, where an unacknowledged message is one that has been
+ * sent to the consumer but not yet acknowledged. This field is only meaningful when using a
+ * {@link org.apache.pulsar.client.api.SubscriptionType} that tracks individual message acknowledgement, like
+ * {@link org.apache.pulsar.client.api.SubscriptionType#Shared} or
+ * {@link org.apache.pulsar.client.api.SubscriptionType#Key_Shared}.
+ */
public int unackedMessages;
/** Number of average messages per entry for the consumer consumed. */
diff --git a/pulsar-common/src/main/java/org/apache/pulsar/common/policies/data/stats/SubscriptionStatsImpl.java b/pulsar-common/src/main/java/org/apache/pulsar/common/policies/data/stats/SubscriptionStatsImpl.java
index c2ad49df3a0..6a049522da4 100644
--- a/pulsar-common/src/main/java/org/apache/pulsar/common/policies/data/stats/SubscriptionStatsImpl.java
+++ b/pulsar-common/src/main/java/org/apache/pulsar/common/policies/data/stats/SubscriptionStatsImpl.java
@@ -73,10 +73,14 @@ public class SubscriptionStatsImpl implements SubscriptionStats {
/** Number of delayed messages currently being tracked. */
public long msgDelayed;
- /** Number of unacknowledged messages for the subscription. */
+ /**
+ * Number of unacknowledged messages for the subscription, where an unacknowledged message is one that has been
+ * sent to a consumer but not yet acknowledged. Calculated by summing all {@link ConsumerStatsImpl#unackedMessages}
+ * for this subscription. See {@link ConsumerStatsImpl#unackedMessages} for additional details.
+ */
public long unackedMessages;
- /** Whether this subscription is Exclusive or Shared or Failover. */
+ /** The subscription type as defined by {@link org.apache.pulsar.client.api.SubscriptionType}. */
public String type;
/** The name of the consumer that is active for single active consumer subscriptions i.e. failover or exclusive. */
diff --git a/site2/docs/admin-api-topics.md b/site2/docs/admin-api-topics.md
index 7a77f06333a..2cb3f55e7fa 100644
--- a/site2/docs/admin-api-topics.md
+++ b/site2/docs/admin-api-topics.md
@@ -391,7 +391,7 @@ You can check the following statistics of a given non-partitioned topic.
- **msgDelayed**: Number of delayed messages currently being tracked.
- - **unackedMessages**: Number of unacknowledged messages for the subscription.
+ - **unackedMessages**: Number of unacknowledged messages for the subscription, where an unacknowledged message is one that has been sent to a consumer but not yet acknowledged. This field is only meaningful when using a subscription that tracks individual message acknowledgement.
- **activeConsumerName**: The name of the consumer that is active for single active consumer subscriptions. For example, failover or exclusive.
@@ -423,7 +423,7 @@ You can check the following statistics of a given non-partitioned topic.
- **availablePermits**: The number of messages that the consumer has space for in the client library's listen queue. `0` means the client library's queue is full and `receive()` isn't being called. A non-zero value means this consumer is ready for dispatched messages.
- - **unackedMessages**: The number of unacknowledged messages for the consumer.
+ - **unackedMessages**: The number of unacknowledged messages for the consumer, where an unacknowledged message is one that has been sent to the consumer but not yet acknowledged. This field is only meaningful when using a subscription that tracks individual message acknowledgement.
- **blockedConsumerOnUnackedMsgs**: The flag used to verify if the consumer is blocked due to reaching threshold of the unacknowledged messages.
diff --git a/site2/website/versioned_docs/version-2.10.0/admin-api-topics.md b/site2/website/versioned_docs/version-2.10.0/admin-api-topics.md
index 4e20864e4ec..eee187eb567 100644
--- a/site2/website/versioned_docs/version-2.10.0/admin-api-topics.md
+++ b/site2/website/versioned_docs/version-2.10.0/admin-api-topics.md
@@ -392,7 +392,7 @@ You can check the following statistics of a given non-partitioned topic.
- **msgDelayed**: Number of delayed messages currently being tracked.
- - **unackedMessages**: Number of unacknowledged messages for the subscription.
+ - **unackedMessages**: Number of unacknowledged messages for the subscription, where an unacknowledged message is one that has been sent to a consumer but not yet acknowledged. This field is only meaningful when using a subscription that tracks individual message acknowledgement.
- **activeConsumerName**: The name of the consumer that is active for single active consumer subscriptions. For example, failover or exclusive.
@@ -424,7 +424,7 @@ You can check the following statistics of a given non-partitioned topic.
- **availablePermits**: The number of messages that the consumer has space for in the client library's listen queue. `0` means the client library's queue is full and `receive()` isn't being called. A non-zero value means this consumer is ready for dispatched messages.
- - **unackedMessages**: The number of unacknowledged messages for the consumer.
+ - **unackedMessages**: The number of unacknowledged messages for the consumer, where an unacknowledged message is one that has been sent to the consumer but not yet acknowledged. This field is only meaningful when using a subscription that tracks individual message acknowledgement.
- **blockedConsumerOnUnackedMsgs**: The flag used to verify if the consumer is blocked due to reaching threshold of the unacknowledged messages.
diff --git a/site2/website/versioned_docs/version-2.7.0/admin-api-topics.md b/site2/website/versioned_docs/version-2.7.0/admin-api-topics.md
index e143fbfa90f..d2d755b3b34 100644
--- a/site2/website/versioned_docs/version-2.7.0/admin-api-topics.md
+++ b/site2/website/versioned_docs/version-2.7.0/admin-api-topics.md
@@ -340,7 +340,7 @@ You can check the following statistics of a given non-partitioned topic.
- **availablePermits**: The number of messages that the consumer has space for in the client library's listen queue. `0` means the client library's queue is full and `receive()` isn't being called. A non-zero value means this consumer is ready for dispatched messages.
- - **unackedMessages**: The number of unacknowledged messages for the consumer.
+ - **unackedMessages**: The number of unacknowledged messages for the consumer, where an unacknowledged message is one that has been sent to the consumer but not yet acknowledged. This field is only meaningful when using a subscription that tracks individual message acknowledgement.
- **blockedConsumerOnUnackedMsgs**: The flag used to verify if the consumer is blocked due to reaching threshold of the unacknowledged messages.
diff --git a/site2/website/versioned_docs/version-2.7.1/admin-api-topics.md b/site2/website/versioned_docs/version-2.7.1/admin-api-topics.md
index a28cc4d7790..bfcd7fe64cc 100644
--- a/site2/website/versioned_docs/version-2.7.1/admin-api-topics.md
+++ b/site2/website/versioned_docs/version-2.7.1/admin-api-topics.md
@@ -340,7 +340,7 @@ You can check the following statistics of a given non-partitioned topic.
- **availablePermits**: The number of messages that the consumer has space for in the client library's listen queue. `0` means the client library's queue is full and `receive()` isn't being called. A non-zero value means this consumer is ready for dispatched messages.
- - **unackedMessages**: The number of unacknowledged messages for the consumer.
+ - **unackedMessages**: The number of unacknowledged messages for the consumer, where an unacknowledged message is one that has been sent to the consumer but not yet acknowledged. This field is only meaningful when using a subscription that tracks individual message acknowledgement.
- **blockedConsumerOnUnackedMsgs**: The flag used to verify if the consumer is blocked due to reaching threshold of the unacknowledged messages.
diff --git a/site2/website/versioned_docs/version-2.7.2/admin-api-topics.md b/site2/website/versioned_docs/version-2.7.2/admin-api-topics.md
index a28cc4d7790..bfcd7fe64cc 100644
--- a/site2/website/versioned_docs/version-2.7.2/admin-api-topics.md
+++ b/site2/website/versioned_docs/version-2.7.2/admin-api-topics.md
@@ -340,7 +340,7 @@ You can check the following statistics of a given non-partitioned topic.
- **availablePermits**: The number of messages that the consumer has space for in the client library's listen queue. `0` means the client library's queue is full and `receive()` isn't being called. A non-zero value means this consumer is ready for dispatched messages.
- - **unackedMessages**: The number of unacknowledged messages for the consumer.
+ - **unackedMessages**: The number of unacknowledged messages for the consumer, where an unacknowledged message is one that has been sent to the consumer but not yet acknowledged. This field is only meaningful when using a subscription that tracks individual message acknowledgement.
- **blockedConsumerOnUnackedMsgs**: The flag used to verify if the consumer is blocked due to reaching threshold of the unacknowledged messages.
diff --git a/site2/website/versioned_docs/version-2.7.3/admin-api-topics.md b/site2/website/versioned_docs/version-2.7.3/admin-api-topics.md
index a28cc4d7790..bfcd7fe64cc 100644
--- a/site2/website/versioned_docs/version-2.7.3/admin-api-topics.md
+++ b/site2/website/versioned_docs/version-2.7.3/admin-api-topics.md
@@ -340,7 +340,7 @@ You can check the following statistics of a given non-partitioned topic.
- **availablePermits**: The number of messages that the consumer has space for in the client library's listen queue. `0` means the client library's queue is full and `receive()` isn't being called. A non-zero value means this consumer is ready for dispatched messages.
- - **unackedMessages**: The number of unacknowledged messages for the consumer.
+ - **unackedMessages**: The number of unacknowledged messages for the consumer, where an unacknowledged message is one that has been sent to the consumer but not yet acknowledged. This field is only meaningful when using a subscription that tracks individual message acknowledgement.
- **blockedConsumerOnUnackedMsgs**: The flag used to verify if the consumer is blocked due to reaching threshold of the unacknowledged messages.
diff --git a/site2/website/versioned_docs/version-2.7.4/admin-api-topics.md b/site2/website/versioned_docs/version-2.7.4/admin-api-topics.md
index a28cc4d7790..bfcd7fe64cc 100644
--- a/site2/website/versioned_docs/version-2.7.4/admin-api-topics.md
+++ b/site2/website/versioned_docs/version-2.7.4/admin-api-topics.md
@@ -340,7 +340,7 @@ You can check the following statistics of a given non-partitioned topic.
- **availablePermits**: The number of messages that the consumer has space for in the client library's listen queue. `0` means the client library's queue is full and `receive()` isn't being called. A non-zero value means this consumer is ready for dispatched messages.
- - **unackedMessages**: The number of unacknowledged messages for the consumer.
+ - **unackedMessages**: The number of unacknowledged messages for the consumer, where an unacknowledged message is one that has been sent to the consumer but not yet acknowledged. This field is only meaningful when using a subscription that tracks individual message acknowledgement.
- **blockedConsumerOnUnackedMsgs**: The flag used to verify if the consumer is blocked due to reaching threshold of the unacknowledged messages.
diff --git a/site2/website/versioned_docs/version-2.8.0/admin-api-topics.md b/site2/website/versioned_docs/version-2.8.0/admin-api-topics.md
index 311bfab19a2..9b7edd5de66 100644
--- a/site2/website/versioned_docs/version-2.8.0/admin-api-topics.md
+++ b/site2/website/versioned_docs/version-2.8.0/admin-api-topics.md
@@ -340,7 +340,7 @@ You can check the following statistics of a given non-partitioned topic.
- **availablePermits**: The number of messages that the consumer has space for in the client library's listen queue. `0` means the client library's queue is full and `receive()` isn't being called. A non-zero value means this consumer is ready for dispatched messages.
- - **unackedMessages**: The number of unacknowledged messages for the consumer.
+ - **unackedMessages**: The number of unacknowledged messages for the consumer, where an unacknowledged message is one that has been sent to the consumer but not yet acknowledged. This field is only meaningful when using a subscription that tracks individual message acknowledgement.
- **blockedConsumerOnUnackedMsgs**: The flag used to verify if the consumer is blocked due to reaching threshold of the unacknowledged messages.
diff --git a/site2/website/versioned_docs/version-2.8.1/admin-api-topics.md b/site2/website/versioned_docs/version-2.8.1/admin-api-topics.md
index a198cdcaa31..166fdcefd2e 100644
--- a/site2/website/versioned_docs/version-2.8.1/admin-api-topics.md
+++ b/site2/website/versioned_docs/version-2.8.1/admin-api-topics.md
@@ -340,7 +340,7 @@ You can check the following statistics of a given non-partitioned topic.
- **availablePermits**: The number of messages that the consumer has space for in the client library's listen queue. `0` means the client library's queue is full and `receive()` isn't being called. A non-zero value means this consumer is ready for dispatched messages.
- - **unackedMessages**: The number of unacknowledged messages for the consumer.
+ - **unackedMessages**: The number of unacknowledged messages for the consumer, where an unacknowledged message is one that has been sent to the consumer but not yet acknowledged. This field is only meaningful when using a subscription that tracks individual message acknowledgement.
- **blockedConsumerOnUnackedMsgs**: The flag used to verify if the consumer is blocked due to reaching threshold of the unacknowledged messages.
diff --git a/site2/website/versioned_docs/version-2.8.2/admin-api-topics.md b/site2/website/versioned_docs/version-2.8.2/admin-api-topics.md
index 787c7f45053..61cf1228412 100644
--- a/site2/website/versioned_docs/version-2.8.2/admin-api-topics.md
+++ b/site2/website/versioned_docs/version-2.8.2/admin-api-topics.md
@@ -350,7 +350,7 @@ You can check the following statistics of a given non-partitioned topic.
- **availablePermits**: The number of messages that the consumer has space for in the client library's listen queue. `0` means the client library's queue is full and `receive()` isn't being called. A non-zero value means this consumer is ready for dispatched messages.
- - **unackedMessages**: The number of unacknowledged messages for the consumer.
+ - **unackedMessages**: The number of unacknowledged messages for the consumer, where an unacknowledged message is one that has been sent to the consumer but not yet acknowledged. This field is only meaningful when using a subscription that tracks individual message acknowledgement.
- **blockedConsumerOnUnackedMsgs**: The flag used to verify if the consumer is blocked due to reaching threshold of the unacknowledged messages.
diff --git a/site2/website/versioned_docs/version-2.8.3/admin-api-topics.md b/site2/website/versioned_docs/version-2.8.3/admin-api-topics.md
index 787c7f45053..61cf1228412 100644
--- a/site2/website/versioned_docs/version-2.8.3/admin-api-topics.md
+++ b/site2/website/versioned_docs/version-2.8.3/admin-api-topics.md
@@ -350,7 +350,7 @@ You can check the following statistics of a given non-partitioned topic.
- **availablePermits**: The number of messages that the consumer has space for in the client library's listen queue. `0` means the client library's queue is full and `receive()` isn't being called. A non-zero value means this consumer is ready for dispatched messages.
- - **unackedMessages**: The number of unacknowledged messages for the consumer.
+ - **unackedMessages**: The number of unacknowledged messages for the consumer, where an unacknowledged message is one that has been sent to the consumer but not yet acknowledged. This field is only meaningful when using a subscription that tracks individual message acknowledgement.
- **blockedConsumerOnUnackedMsgs**: The flag used to verify if the consumer is blocked due to reaching threshold of the unacknowledged messages.
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 0f4a8fe8e8b..4051f633909 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
@@ -388,7 +388,7 @@ You can check the following statistics of a given non-partitioned topic.
- **msgDelayed**: Number of delayed messages currently being tracked.
- - **unackedMessages**: Number of unacknowledged messages for the subscription.
+ - **unackedMessages**: Number of unacknowledged messages for the subscription, where an unacknowledged message is one that has been sent to a consumer but not yet acknowledged. This field is only meaningful when using a subscription that tracks individual message acknowledgement.
- **activeConsumerName**: The name of the consumer that is active for single active consumer subscriptions. For example, failover or exclusive.
@@ -420,7 +420,7 @@ You can check the following statistics of a given non-partitioned topic.
- **availablePermits**: The number of messages that the consumer has space for in the client library's listen queue. `0` means the client library's queue is full and `receive()` isn't being called. A non-zero value means this consumer is ready for dispatched messages.
- - **unackedMessages**: The number of unacknowledged messages for the consumer.
+ - **unackedMessages**: The number of unacknowledged messages for the consumer, where an unacknowledged message is one that has been sent to the consumer but not yet acknowledged. This field is only meaningful when using a subscription that tracks individual message acknowledgement.
- **blockedConsumerOnUnackedMsgs**: The flag used to verify if the consumer is blocked due to reaching threshold of the unacknowledged messages.
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 87a141d9e25..c0eab96468c 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
@@ -388,7 +388,7 @@ You can check the following statistics of a given non-partitioned topic.
- **msgDelayed**: Number of delayed messages currently being tracked.
- - **unackedMessages**: Number of unacknowledged messages for the subscription.
+ - **unackedMessages**: Number of unacknowledged messages for the subscription, where an unacknowledged message is one that has been sent to a consumer but not yet acknowledged. This field is only meaningful when using a subscription that tracks individual message acknowledgement.
- **activeConsumerName**: The name of the consumer that is active for single active consumer subscriptions. For example, failover or exclusive.
@@ -420,7 +420,7 @@ You can check the following statistics of a given non-partitioned topic.
- **availablePermits**: The number of messages that the consumer has space for in the client library's listen queue. `0` means the client library's queue is full and `receive()` isn't being called. A non-zero value means this consumer is ready for dispatched messages.
- - **unackedMessages**: The number of unacknowledged messages for the consumer.
+ - **unackedMessages**: The number of unacknowledged messages for the consumer, where an unacknowledged message is one that has been sent to the consumer but not yet acknowledged. This field is only meaningful when using a subscription that tracks individual message acknowledgement.
- **blockedConsumerOnUnackedMsgs**: The flag used to verify if the consumer is blocked due to reaching threshold of the unacknowledged messages.
diff --git a/site2/website/versioned_docs/version-2.9.2/admin-api-topics.md b/site2/website/versioned_docs/version-2.9.2/admin-api-topics.md
index 87a141d9e25..c0eab96468c 100644
--- a/site2/website/versioned_docs/version-2.9.2/admin-api-topics.md
+++ b/site2/website/versioned_docs/version-2.9.2/admin-api-topics.md
@@ -388,7 +388,7 @@ You can check the following statistics of a given non-partitioned topic.
- **msgDelayed**: Number of delayed messages currently being tracked.
- - **unackedMessages**: Number of unacknowledged messages for the subscription.
+ - **unackedMessages**: Number of unacknowledged messages for the subscription, where an unacknowledged message is one that has been sent to a consumer but not yet acknowledged. This field is only meaningful when using a subscription that tracks individual message acknowledgement.
- **activeConsumerName**: The name of the consumer that is active for single active consumer subscriptions. For example, failover or exclusive.
@@ -420,7 +420,7 @@ You can check the following statistics of a given non-partitioned topic.
- **availablePermits**: The number of messages that the consumer has space for in the client library's listen queue. `0` means the client library's queue is full and `receive()` isn't being called. A non-zero value means this consumer is ready for dispatched messages.
- - **unackedMessages**: The number of unacknowledged messages for the consumer.
+ - **unackedMessages**: The number of unacknowledged messages for the consumer, where an unacknowledged message is one that has been sent to the consumer but not yet acknowledged. This field is only meaningful when using a subscription that tracks individual message acknowledgement.
- **blockedConsumerOnUnackedMsgs**: The flag used to verify if the consumer is blocked due to reaching threshold of the unacknowledged messages.