Skip to content

KAFKA-19527: improve the docs of LogDirDescription for remote storage #20211

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

Merged
merged 1 commit into from
Jul 30, 2025
Merged

KAFKA-19527: improve the docs of LogDirDescription for remote storage #20211

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions clients/src/main/java/org/apache/kafka/clients/admin/LogDirDescription.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ public Map<TopicPartition, ReplicaInfo> replicaInfos() {
/**
* The total size of the volume this log directory is on or empty if the broker did not return a value.
* For volumes larger than Long.MAX_VALUE, Long.MAX_VALUE is returned.
* This value does not include the size of data stored in remote storage.
*/
public OptionalLong totalBytes() {
return totalBytes;
Expand All @@ -75,6 +76,7 @@ public OptionalLong totalBytes() {
/**
* The usable size on the volume this log directory is on or empty if the broker did not return a value.
* For usable sizes larger than Long.MAX_VALUE, Long.MAX_VALUE is returned.
* This value does not include the size of data stored in remote storage.
*/
public OptionalLong usableBytes() {
return usableBytes;
Expand Down
1 change: 1 addition & 0 deletions clients/src/main/java/org/apache/kafka/clients/admin/ReplicaInfo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ public ReplicaInfo(long size, long offsetLag, boolean isFuture) {

/**
* The total size of the log segments in this replica in bytes.
* This value does not include the size of data stored in remote storage.
*/
public long size() {
return size;
Expand Down
6 changes: 3 additions & 3 deletions clients/src/main/resources/common/message/DescribeLogDirsResponse.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,11 @@
"about": "True if this log is created by AlterReplicaLogDirsRequest and will replace the current log of the replica in the future." }]}
]},
{ "name": "TotalBytes", "type": "int64", "versions": "4+", "ignorable": true, "default": "-1",
"about": "The total size in bytes of the volume the log directory is in."
"about": "The total size in bytes of the volume the log directory is in. This value does not include the size of data stored in remote storage."
},
{ "name": "UsableBytes", "type": "int64", "versions": "4+", "ignorable": true, "default": "-1",
"about": "The usable size in bytes of the volume the log directory is in."
"about": "The usable size in bytes of the volume the log directory is in. This value does not include the size of data stored in remote storage."
}
]}
]
}
}