...
FetchResponse already contains CurrentLeader introduced in KIP-595, which will be used to propagate LeaderId & LeaderEpoch. Additionally CurrentLeaderBroker is introduced to propagate hostLeaderHost, port LeaderPort & rack LeaderRach for the leader. CurrentLeaderBroker is a tagged field, which is a minor optimisation of saving bytes on the network, as it won’t be set always. This doesn’t require a version bump.
...
Code Block |
---|
{ "apiKey": 1, "type": "response", "name": "FetchResponse", "validVersions": "0-15", "flexibleVersions": "12+", "fields": [ { "name": "ThrottleTimeMs", "type": "int32", "versions": "1+", "ignorable": true, "about": "The duration in milliseconds for which the request was throttled due to a quota violation, or zero if the request did not violate any quota." }, { "name": "ErrorCode", "type": "int16", "versions": "7+", "ignorable": true, "about": "The top level response error code." }, { "name": "SessionId", "type": "int32", "versions": "7+", "default": "0", "ignorable": false, "about": "The fetch session ID, or 0 if this is not part of a fetch session." }, { "name": "Responses", "type": "[]FetchableTopicResponse", "versions": "0+", "about": "The response topics.", "fields": [ { "name": "Topic", "type": "string", "versions": "0-12", "ignorable": true, "entityType": "topicName", "about": "The topic name." }, { "name": "TopicId", "type": "uuid", "versions": "13+", "ignorable": true, "about": "The unique topic ID"}, { "name": "Partitions", "type": "[]PartitionData", "versions": "0+", "about": "The topic partitions.", "fields": [ { "name": "PartitionIndex", "type": "int32", "versions": "0+", "about": "The partition index." }, { "name": "ErrorCode", "type": "int16", "versions": "0+", "about": "The error code, or 0 if there was no fetch error." }, { "name": "HighWatermark", "type": "int64", "versions": "0+", "about": "The current high water mark." }, { "name": "LastStableOffset", "type": "int64", "versions": "4+", "default": "-1", "ignorable": true, "about": "The last stable offset (or LSO) of the partition. This is the last offset such that the state of all transactional records prior to this offset have been decided (ABORTED or COMMITTED)" }, { "name": "LogStartOffset", "type": "int64", "versions": "5+", "default": "-1", "ignorable": true, "about": "The current log start offset." }, { "name": "DivergingEpoch", "type": "EpochEndOffset", "versions": "12+", "taggedVersions": "12+", "tag": 0, "about": "In case divergence is detected based on the `LastFetchedEpoch` and `FetchOffset` in the request, this field indicates the largest epoch and its end offset such that subsequent records are known to diverge", "fields": [ { "name": "Epoch", "type": "int32", "versions": "12+", "default": "-1" }, { "name": "EndOffset", "type": "int64", "versions": "12+", "default": "-1" } ]}, { "name": "CurrentLeader", "type": "LeaderIdAndEpoch", "versions": "12+", "taggedVersions": "12+", "tag": 1, "fields": [ { "name": "LeaderId", "type": "int32", "versions": "12+", "default": "-1", "entityType": "brokerId", "about": "The ID of the current leader or -1 if the leader is unknown."}, { "name": "LeaderEpoch", "type": "int32", "versions": "12+", "default": "-1", "about": "The latest known leader epoch"} ]}, // ---------- Start new field ---------- { "name": "CurrentLeaderBroker", "type": "BrokerInfo", "versions": "15+", "taggedVersions": "15+", "tag": 2, "about": "CurrentLeader's broker information.", "fields": [ { "name": "LeaderHost", "type": "string", "versions": "15+", "about": "The leader hostname." }, { "name": "LeaderPort", "type": "int32", "versions": "15+", "about": "The leader port." }, { "name": "LeaderRack", "type": "string", "versions": "15+", "ignorable": true, "default": "null", "about": "The rack of the leader, or null if it has not been assigned to a rack." } ]}, // ---------- End new field ---------- { "name": "SnapshotId", "type": "SnapshotId", "versions": "12+", "taggedVersions": "12+", "tag": 2, "about": "In the case of fetching an offset less than the LogStartOffset, this is the end offset and epoch that should be used in the FetchSnapshot request.", "fields": [ { "name": "EndOffset", "type": "int64", "versions": "0+", "default": "-1" }, { "name": "Epoch", "type": "int32", "versions": "0+", "default": "-1" } ]}, { "name": "AbortedTransactions", "type": "[]AbortedTransaction", "versions": "4+", "nullableVersions": "4+", "ignorable": true, "about": "The aborted transactions.", "fields": [ { "name": "ProducerId", "type": "int64", "versions": "4+", "entityType": "producerId", "about": "The producer id associated with the aborted transaction." }, { "name": "FirstOffset", "type": "int64", "versions": "4+", "about": "The first offset in the aborted transaction." } ]}, { "name": "PreferredReadReplica", "type": "int32", "versions": "11+", "default": "-1", "ignorable": false, "entityType": "brokerId", "about": "The preferred read replica for the consumer to use on its next fetch request"}, { "name": "Records", "type": "records", "versions": "0+", "nullableVersions": "0+", "about": "The record data."} ]} ]} ] } |
ProduceResponse Message
For ProduceResponse, similarly will add CurrentLeader & CurrentLeaderBroker to convey new leader info. Similarly these fields are tagged and don’t require a version bump.
Code Block |
---|
{
"apiKey": 0,
"type": "response",
"name": "ProduceResponse",
"validVersions": "0-9",
"flexibleVersions": "9+",
"fields": [
{ "name": "Responses", "type": "[]TopicProduceResponse", "versions": "0+",
"about": "Each produce response", "fields": [
{ "name": "Name", "type": "string", "versions": "0+", "entityType": "topicName", "mapKey": true,
"about": "The topic name" },
{ "name": "PartitionResponses", "type": "[]PartitionProduceResponse", "versions": "0+",
"about": "Each partition that we produced to within the topic.", "fields": [
{ "name": "Index", "type": "int32", "versions": "0+",
"about": "The partition index." },
{ "name": "ErrorCode", "type": "int16", "versions": "0+",
"about": "The error code, or 0 if there was no error." },
{ "name": "BaseOffset", "type": "int64", "versions": "0+",
"about": "The base offset." },
{ "name": "LogAppendTimeMs", "type": "int64", "versions": "2+", "default": "-1", "ignorable": true,
"about": "The timestamp returned by broker after appending the messages. If CreateTime is used for the topic, the timestamp will be -1. If LogAppendTime is used for the topic, the timestamp will be the broker local time when the messages are appended." },
{ "name": "LogStartOffset", "type": "int64", "versions": "5+", "default": "-1", "ignorable": true,
"about": "The log start offset." },
{ "name": "RecordErrors", "type": "[]BatchIndexAndErrorMessage", "versions": "8+", "ignorable": true,
"about": "The batch indices of records that caused the batch to be dropped", "fields": [
{ "name": "BatchIndex", "type": "int32", "versions": "8+",
"about": "The batch index of the record that cause the batch to be dropped" },
{ "name": "BatchIndexErrorMessage", "type": "string", "default": "null", "versions": "8+", "nullableVersions": "8+",
"about": "The error message of the record that caused the batch to be dropped"}
]},
{ "name": "ErrorMessage", "type": "string", "default": "null", "versions": "8+", "nullableVersions": "8+", "ignorable": true,
"about": "The global error message summarizing the common root cause of the records that caused the batch to be dropped"},
// ---------- Start new field ----------
{ "name": "CurrentLeader", "type": "LeaderIdAndEpoch",
"versions": "9+", "taggedVersions": "9+", "tag": 0, "fields": [
{ "name": "LeaderId", "type": "int32", "versions": "9+", "default": "-1", "entityType": "brokerId",
"about": "The ID of the current leader or -1 if the leader is unknown."},
{ "name": "LeaderEpoch", "type": "int32", "versions": "9+", "default": "-1",
"about": "The latest known leader epoch"}
]},
{ "name": "CurrentLeaderBroker", "type": "BrokerInfo", "versions": "9+", "taggedVersions": "9+", "tag": 1,
"about": "CurrentLeader's broker information.",
"fields": [
{ "name": "LeaderHost", "type": "string", "versions": "9+",
"about": "The leader hostname." },
{ "name": "LeaderPort", "type": "int32", "versions": "9+",
"about": "The leader port." },
{ "name": "LeaderRack", "type": "string", "versions": "9+", "ignorable": true, "default": "null",
"about": "The rack of the leader, or null if it has not been assigned to a rack." }
]}
// ---------- End new field ----------
]}
]},
{ "name": "ThrottleTimeMs", "type": "int32", "versions": "1+", "ignorable": true, "default": "0",
"about": "The duration in milliseconds for which the request was throttled due to a quota violation, or zero if the request did not violate any quota." }
]
} |
Compatibility, Deprecation, and Migration Plan
...