[Issue 5708][docs] correct some wrong info about persistent topics (a…

…pache#5789) * [docs] Fix persistent topics * Update site2/docs/admin-api-persistent-topics.md Co-Authored-By: Anonymitaet <[email protected]> * Update site2/docs/admin-api-persistent-topics.md Co-Authored-By: Anonymitaet <[email protected]> * Update site2/docs/admin-api-persistent-topics.md Co-Authored-By: Anonymitaet <[email protected]> * Update site2/docs/admin-api-persistent-topics.md Co-Authored-By: Anonymitaet <[email protected]> * Update site2/docs/admin-api-persistent-topics.md Co-Authored-By: Anonymitaet <[email protected]> * Update site2/docs/admin-api-persistent-topics.md Co-Authored-By: Anonymitaet <[email protected]>
AlphaWang · Dec 12, 2019 · c4a7091 · c4a7091
1 parent 8bcd0de
commit c4a7091
Showing 1 changed file with 67 additions and 29 deletions.
diff --git a/site2/docs/admin-api-persistent-topics.md b/site2/docs/admin-api-persistent-topics.md
@@ -191,47 +191,77 @@ It shows current 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. See
+  -   **storageSize**: The sum of the ledgers' storage size for this topic. Space used to store the messages for the topic
 
   -   **publishers**: The list of all local publishers into the topic. There can be zero or thousands
 
-  -   **averageMsgSize**: Average message size in bytes from this publisher within the last interval
+      -   **msgRateIn**: Total rate of messages published by this publisher in messages per second 
 
-  -   **producerId**: Internal identifier for this producer on this topic
+      -   **msgThroughputIn**: Total throughput of the messages published by this publisher in bytes per second
 
-  -   **producerName**: Internal identifier for this producer, generated by the client library
+      -   **averageMsgSize**: Average message size in bytes from this publisher within the last interval
 
-  -   **address**: IP address and source port for the connection of this producer
+      -   **producerId**: Internal identifier for this producer on this topic
 
-  -   **connectedSince**: Timestamp this producer was created or last reconnected
+      -   **producerName**: Internal identifier for this producer, generated by the client library
+
+      -   **address**: IP address and source port for the connection of this producer
+
+      -   **connectedSince**: Timestamp this producer was created or last reconnected
 
   -   **subscriptions**: The list of all local subscriptions to the topic
 
-  -   **my-subscription**: The name of this subscription (client defined)
+      -   **my-subscription**: The name of this subscription (client defined)
+
+          -   **msgRateOut**: Total rate of messages delivered on this subscription (msg/s)
+
+          -   **msgThroughputOut**: Total throughput delivered on this subscription (bytes/s)
+
+          -   **msgBacklog**: Number of messages in the subscription backlog
 
-  -   **msgBacklog**: The count of messages in backlog for this subscription
+          -   **type**: This subscription type
 
-  -   **type**: This subscription type
+          -   **msgRateExpired**: The rate at which messages were discarded instead of dispatched from this subscription due to TTL
 
-  -   **msgRateExpired**: The rate at which messages were discarded instead of dispatched from this subscription due to TTL
+          -   **consumers**: The list of connected consumers for this subscription
 
-  -   **consumers**: The list of connected consumers for this subscription
+                -   **msgRateOut**: Total rate of messages delivered to the consumer (msg/s)
 
-  -   **consumerName**: Internal identifier for this consumer, generated by the client library
+                -   **msgThroughputOut**: Total throughput delivered to the consumer (bytes/s)
 
-  -   **availablePermits**: The number of messages this consumer has space for in the client library's listen queue. A value of 0 means the client library's queue is full and receive() isn't being called. A nonzero value means this consumer is ready to be dispatched messages.
+                -   **consumerName**: Internal identifier for this consumer, generated by the client library
+
+                -   **availablePermits**: The number of messages this consumer has space for in the client library's listen queue. A value of 0 means the client library's queue is full and receive() isn't being called. A nonzero value means this consumer is ready to be dispatched messages.
+
+                -   **unackedMessages**: Number of unacknowledged messages for the consumer
+
+                -   **blockedConsumerOnUnackedMsgs**: Flag to verify if the consumer is blocked due to reaching threshold of unacked messages
 
   -   **replication**: This section gives the stats for cross-colo replication of this topic
 
-  -   **replicationBacklog**: The outbound replication backlog in messages
+      -   **msgRateIn**: Total rate of messages received from the remote cluster (msg/s)
+
+      -   **msgThroughputIn**: Total throughput received from the remote cluster (bytes/s)
+
+      -   **msgRateOut**: Total rate of messages delivered to the replication-subscriber (msg/s)
 
-  -   **connected**: Whether the outbound replicator is connected
+      -   **msgThroughputOut**: Total through delivered to the replication-subscriber (bytes/s)
 
-  -   **replicationDelayInSeconds**: How long the oldest message has been waiting to be sent through the connection, if connected is true
+      -   **msgRateExpired**: Total rate of messages expired (msg/s)
 
-  -   **inboundConnection**: The IP and port of the broker in the remote cluster's publisher connection to this broker
+      -   **replicationBacklog**: Number of messages pending to be replicated to remote cluster
 
-  -   **inboundConnectedSince**: The TCP connection being used to publish messages to the remote cluster. If there are no local publishers connected, this connection is automatically closed after a minute.
+      -   **connected**: Whether the outbound replicator is connected
+
+      -   **replicationDelayInSeconds**: How long the oldest message has been waiting to be sent through the connection, if connected is true
+
+      -   **inboundConnection**: The IP and port of the broker in the remote cluster's publisher connection to this broker
+
+      -   **inboundConnectedSince**: The TCP connection being used to publish messages to the remote cluster. If there are no local publishers connected, this connection is automatically closed after a minute.
+
+      -   **outboundConnection**: Address of outbound replication connection
+
+      -   **outboundConnectedSince**: Timestamp of establishing outbound connection
 
 ```json
 {
@@ -314,27 +344,35 @@ It shows detailed statistics of a topic.
 
   -   **ledgers**: The ordered list of all ledgers for this topic holding its messages
 
+      -   **ledgerId**: Id of this ledger
+
+      -   **entries**: Total number of entries belong to this ledger
+
+      -   **size**: Size of messages written to this ledger (in bytes)
+
+      -   **offloaded**: Whether this ledger is offloaded
+
   -   **cursors**: The list of all cursors on this topic. There will be one for every subscription you saw in the topic stats.
 
-  -   **markDeletePosition**: The ack position: the last message the subscriber acknowledged receiving
+      -   **markDeletePosition**: All of messages before the markDeletePosition are acknowledged by the subscriber.
 
-  -   **readPosition**: The latest position of subscriber for reading message
+      -   **readPosition**: The latest position of subscriber for reading message
 
-  -   **waitingReadOp**: This is true when the subscription has read the latest message published to the topic and is waiting on new messages to be published.
+      -   **waitingReadOp**: This is true when the subscription has read the latest message published to the topic and is waiting on new messages to be published.
 
-  -   **pendingReadOps**: The counter for how many outstanding read requests to the BookKeepers we have in progress
+      -   **pendingReadOps**: The counter for how many outstanding read requests to the BookKeepers we have in progress
 
-  -   **messagesConsumedCounter**: Number of messages this cursor has acked since this broker loaded this topic
+      -   **messagesConsumedCounter**: Number of messages this cursor has acked since this broker loaded this topic
 
-  -   **cursorLedger**: The ledger being used to persistently store the current markDeletePosition
+      -   **cursorLedger**: The ledger being used to persistently store the current markDeletePosition
 
-  -   **cursorLedgerLastEntry**: The last entryid used to persistently store the current markDeletePosition
+      -   **cursorLedgerLastEntry**: The last entryid used to persistently store the current markDeletePosition
 
-  -   **individuallyDeletedMessages**: If Acks are being done out of order, shows the ranges of messages Acked between the markDeletePosition and the read-position
+      -   **individuallyDeletedMessages**: If Acks are being done out of order, shows the ranges of messages Acked between the markDeletePosition and the read-position
 
-  -   **lastLedgerSwitchTimestamp**: The last time the cursor ledger was rolled over
+      -   **lastLedgerSwitchTimestamp**: The last time the cursor ledger was rolled over
 
-  -   **state**: The state of the cursor ledger: Open means we have a cursor ledger for saving updates of the markDeletePosition.
+      -   **state**: The state of the cursor ledger: Open means we have a cursor ledger for saving updates of the markDeletePosition.
 
 ```json
 {
@@ -619,4 +657,4 @@ pulsar-admin topics last-message-id topic-name
 ```Java
 String topic = "persistent://my-tenant/my-namespace/my-topic";
 admin.persistentTopics().getLastMessage(topic);
-```
+```