Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[fix] Fix storageSize*/ offloadedStorageSize* stats descriptions. #870

Merged
merged 3 commits into from
Apr 1, 2024
Merged

[fix] Fix storageSize*/ offloadedStorageSize* stats descriptions. #870

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
700433a
Fix storageSize*/ offloadedStorageSize* stats descriptions.
dao-jun Mar 29, 2024
d0078ea
Merge branch 'main' into fix/storageSize_stats_doc
dao-jun Apr 1, 2024
362d8eb
Address comment
dao-jun Apr 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/administration-stats.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ All stats below are **reset** to 0 upon broker restart or topic unloading, **exc
| 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 **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`. |
| storageSize* | The sum of the ledgers' storage size **in BookKeeper** and **in tiered storage** for a topic (in bytes). <br/><br/>**Note**: the `total storage size of a topic` = `storageSize`. |
dao-jun marked this conversation as resolved.
Show resolved Hide resolved
| 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`, includes `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. |
Expand Down
56 changes: 28 additions & 28 deletions versioned_docs/version-2.10.x/administration-stats.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,34 +13,34 @@ All stats below are **reset** to 0 upon broker restart or topic unloading, **exc

## Partitioned topics

|Stat|Description|
|---|---|
|msgRateIn| The sum of publish rates of all local and replication publishers in messages per second.|
|msgThroughputIn| Same as msgRateIn but in bytes per second instead of messages per second.|
|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 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.|
|address| IP address and source port for the connection of this producer.|
|connectedSince| Timestamp this producer is created or last reconnected.|
|subscriptions| The list of all local subscriptions to the topic.|
|my-subscription| The name of this subscription (client defined).|
|msgBacklog| The count of messages in backlog for this subscription.|
|type| This subscription type.|
|msgRateExpired| The rate at which messages are discarded instead of dispatched from this subscription due to TTL.|
|consumers| The list of connected consumers for this subscription.|
|consumerName| Internal identifier for this consumer, generated by the client library.|
|availablePermits| The number of messages this consumer has space for in the listen queue of client library. A value of 0 means the queue of client library is full and receive() is not being called. A nonzero value means this consumer is ready to be dispatched messages.|
|replication| This section gives the stats for cross-colo replication of this topic.|
|replicationBacklog| The outbound replication backlog in messages.|
|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 publisher connection of remote cluster to this broker. |
|inboundConnectedSince| The TCP connection being used to publish messages to the remote cluster. If no local publishers are connected, this connection is automatically closed after a minute.|
| Stat | Description |
|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| msgRateIn | The sum of publish rates of all local and replication publishers in messages per second. |
| msgThroughputIn | Same as msgRateIn but in bytes per second instead of messages per second. |
| 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 the ledgers' storage size **in BookKeeper** and **in tiered storage** for a topic (in bytes). <br/><br/>**Note**: the `total storage size of a topic` = `storageSize`. |
| 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`, includes `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. |
| address | IP address and source port for the connection of this producer. |
| connectedSince | Timestamp this producer is created or last reconnected. |
| subscriptions | The list of all local subscriptions to the topic. |
| my-subscription | The name of this subscription (client defined). |
| msgBacklog | The count of messages in backlog for this subscription. |
| type | This subscription type. |
| msgRateExpired | The rate at which messages are discarded instead of dispatched from this subscription due to TTL. |
| consumers | The list of connected consumers for this subscription. |
| consumerName | Internal identifier for this consumer, generated by the client library. |
| availablePermits | The number of messages this consumer has space for in the listen queue of client library. A value of 0 means the queue of client library is full and receive() is not being called. A nonzero value means this consumer is ready to be dispatched messages. |
| replication | This section gives the stats for cross-colo replication of this topic. |
| replicationBacklog | The outbound replication backlog in messages. |
| 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 publisher connection of remote cluster to this broker. |
| inboundConnectedSince | The TCP connection being used to publish messages to the remote cluster. If no local publishers are connected, this connection is automatically closed after a minute. |


## Topics
Expand Down
Loading
Loading