[GitHub] [pulsar] michaeljmarshall commented on a change in pull request #10868: [docs] Update docs for topic stats in admin apis.

[GitBox <gi...@apache.org>]

michaeljmarshall commented on a change in pull request #10868:
URL: https://github.com/apache/pulsar/pull/10868#discussion_r651446501



##########
File path: site2/docs/admin-api-topics.md
##########
@@ -187,14 +187,42 @@ You can check the following statistics of a given non-partitioned topic.
 
   -   **storageSize**: The sum of the ledgers' storage size for this topic. The space used to store the messages for the topic.
 
+  -   **bytesInCounter**: Total bytes published to the topic.
+
+  -   **msgInCounter**: Total messages published to the topic.
+
+  -   **bytesOutCounter**: Total bytes delivered to consumer (bytes).
+
+  -   **msgOutCounter**: Total messages delivered to consumer.
+
+  -   **msgChunkPublished**: Topic has chunked message published on it.
+
+  -   **backlogSize**: Estimated total unconsumed or backlog size (in bytes).
+
+  -   **offloadedStorageSize**: Space used to store the offloaded messages for the topic.

Review comment:
       It might be worth adding the units for this field, instead of just referencing "space".

##########
File path: site2/docs/admin-api-topics.md
##########
@@ -187,14 +187,42 @@ You can check the following statistics of a given non-partitioned topic.
 
   -   **storageSize**: The sum of the ledgers' storage size for this topic. The space used to store the messages for the topic.
 
+  -   **bytesInCounter**: Total bytes published to the topic.
+
+  -   **msgInCounter**: Total messages published to the topic.
+
+  -   **bytesOutCounter**: Total bytes delivered to consumer (bytes).

Review comment:
       Nit: this value is for _all_ consumers for the topic. (At least all consumers for as long as this topic has been on the given broker.)
   ```suggestion
     -   **bytesOutCounter**: Total bytes delivered to consumers (bytes).
   ```

##########
File path: site2/docs/admin-api-topics.md
##########
@@ -219,12 +251,46 @@ You can check the following statistics of a given non-partitioned topic.
           
           -   **lastExpireTimestamp**: The timestamp of the last message expire execution.
           
-          -   **lastConsumedFlowTimestamp**: The timestamp of the last flow command received. 
-          
+          -   **lastConsumedFlowTimestamp**: The timestamp of the last flow command received.
+
           -   **lastConsumedTimestamp**: The latest timestamp of all the consumed timestamp of the consumers.
           
           -   **lastAckedTimestamp**: The latest timestamp of all the acked timestamp of the consumers.
 
+          -   **bytesOutCounter**: Total bytes delivered to consumer.
+
+          -   **msgOutCounter**: Total messages delivered to consumer.
+
+          -   **msgRateRedeliver**: Total rate of messages redelivered on this subscription (msg/s).
+
+          -   **chunkedMessageRate**: Chunked message dispatch rate.
+
+          -   **backlogSize**: Size of backlog (in byte).

Review comment:
       ```suggestion
             -   **backlogSize**: Size of backlog for this subscription (in bytes).
   ```

##########
File path: site2/docs/admin-api-topics.md
##########
@@ -187,14 +187,42 @@ You can check the following statistics of a given non-partitioned topic.
 
   -   **storageSize**: The sum of the ledgers' storage size for this topic. The space used to store the messages for the topic.
 
+  -   **bytesInCounter**: Total bytes published to the topic.
+
+  -   **msgInCounter**: Total messages published to the topic.
+
+  -   **bytesOutCounter**: Total bytes delivered to consumer (bytes).
+
+  -   **msgOutCounter**: Total messages delivered to consumer.

Review comment:
       Nit: this value is for _all_ consumers for the topic. (At least all consumers for as long as this topic has been on the given broker.)
   ```suggestion
     -   **msgOutCounter**: Total messages delivered to consumers.
   ```

##########
File path: site2/docs/admin-api-topics.md
##########
@@ -187,14 +187,42 @@ You can check the following statistics of a given non-partitioned topic.
 
   -   **storageSize**: The sum of the ledgers' storage size for this topic. The space used to store the messages for the topic.
 
+  -   **bytesInCounter**: Total bytes published to the topic.
+
+  -   **msgInCounter**: Total messages published to the topic.
+
+  -   **bytesOutCounter**: Total bytes delivered to consumer (bytes).
+
+  -   **msgOutCounter**: Total messages delivered to consumer.
+
+  -   **msgChunkPublished**: Topic has chunked message published on it.
+
+  -   **backlogSize**: Estimated total unconsumed or backlog size (in bytes).
+
+  -   **offloadedStorageSize**: Space used to store the offloaded messages for the topic.
+  
+  -   **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.
+
+  -   **nonContiguousDeletedMessagesRanges**: The number of non-contiguous deleted messages ranges.
+
+  -   **nonContiguousDeletedMessagesRangesSerializedSize**: The serialized size of non-contiguous deleted messages ranges.  
+
   -   **publishers**: The list of all local publishers into the topic. The list ranges from zero to thousands.
 
+      -   **accessMode**: The type of access to the topic that the producer requires.
+
       -   **msgRateIn**: The total rate of messages (msg/s) published by this publisher.
 
       -   **msgThroughputIn**: The total throughput (bytes/s) of the messages published by this publisher.
 
       -   **averageMsgSize**: The average message size in bytes from this publisher within the last interval.
 
+      -   **chunkedMessageRate**: Total chunked message count received.

Review comment:
       ```suggestion
         -   **chunkedMessageRate**: Total chunked message count received for this producer on this topic.
   ```




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org