1// DescribeLogDirsRequest requests directory information for topic partitions.
2// This request was added in support of KIP-113.
3DescribeLogDirsRequest => key 35, max version 4, flexible v2+
4 // Topics is an array of topics to describe the log dirs of. If this is
5 // null, the response includes all topics and all of their partitions.
6 Topics: nullable[=>]
7 // Topic is a topic to describe the log dir of.
8 Topic: string
9 // Partitions contains topic partitions to describe the log dirs of.
10 Partitions: [int32]
11
12// DescribeLogDirsResponse is returned from a DescribeLogDirsRequest.
13DescribeLogDirsResponse =>
14 ThrottleMillis(1)
15 // The error code, or 0 if there was no error.
16 ErrorCode: int16 // v3+
17 // Dirs pairs log directories with the topics and partitions that are
18 // stored in those directores.
19 Dirs: [=>]
20 // ErrorCode is the error code returned for describing log dirs.
21 //
22 // KAFKA_STORAGE_ERROR is returned if the log directory is offline.
23 ErrorCode: int16
24 // Dir is the absolute path of a log directory.
25 Dir: string
26 // Topics is an array of topics within a log directory.
27 Topics: [=>]
28 // Topic is the name of a Kafka topic.
29 Topic: string
30 // Partitions is the set of queried partitions for a topic that are
31 // within a log directory.
32 Partitions: [=>]
33 // Partition is a partition ID.
34 Partition: int32
35 // Size is the total size of the log sements of this partition, in bytes.
36 Size: int64
37 // OffsetLag is how far behind the log end offset is compared to
38 // the partition's high watermark (if this is the current log for
39 // the partition) or compared to the current replica's log end
40 // offset (if this is the future log for the patition).
41 //
42 // The math is,
43 //
44 // if IsFuture, localLogEndOffset - futurelogEndOffset.
45 //
46 // otherwise, max(localHighWatermark - logEndOffset, 0).
47 OffsetLag: int64
48 // IsFuture is true if this replica was created by an
49 // AlterReplicaLogDirsRequest and will replace the current log of the
50 // replica in the future.
51 IsFuture: bool
52 // TotalBytes is the total size in bytes of the volume the log directory is
53 // in.
54 TotalBytes: int64(-1) // v4+
55 // UsableBytes is the usable size in bytes of the volume the log directory
56 // is in.
57 UsableBytes: int64(-1) // v4+
View as plain text