Status
Current state: Vote pending Accepted
Discussion thread: here
Vote thread: here
...
Change of the ELR does not require a leader epoch bump. In most cases, the ELR updates along with the ISR changes. The only case of the ELR changes alone is when an ELR broker registers after an unclean shutdown. In this case, no need to bump the leader epoch.
When updating the config min.insync.replicas, if the new min ISR <= current ISR, the ELR will be removed.
A new metric of Electable leaders will be added. It reflects the count of (ISR + ELR).
The AlterPartitionReassignments. The leader updates the ISR implicitly with AlterPartition requests. The controller will make sure than upon completion, the ELR only contains replicas in the final replica set. Additionally, in order to improve the durability of the reassignment
- The current behavior, when completing the reassignment, all the adding replicas should be in ISR. This behavior can result in 1 replica in ISR. Also, ELR may not help here because the removing ISR replicas can not stay in ELR when completed. So we propose to enforce that the reassignment can only be completed if the ISR size is larger or equal to min ISR.
- This min ISR requirement is also enforced when the reassignment is canceled.
Have a new admin API DescribeTopicRequest DescribeTopicsRequest for showing the topic details. We don't want to embed the ELR info in the Metadata API. The ELR is not some necessary details to be exposed to user clients.
- More public facing details will be discussed in the DescribeTopicRequest DescribeTopicsRequest section.
We also record the last-known ELR members.
It basically means when an ELR member has an unclean shutdown, it will be removed from ELR and added to the LastKnownELR. The LastKnownELR will be cleaned when ISR reaches the min ISR.
LastKnownELR is stored in the metadata log.
LastKnownELR will be also useful in the Unclean Recovery section.
- The last known leader will be tracked.
- This can be used if the Unclean recovery is not enabled. More details will be discussed in the Deliver Plan.
- The controller will record the last ISR member(the leader) when it is fenced.
- It will be cleaned when a new leader is elected.
...
During the shutdown, write the current broker epoch in the CleanShutdownFile.
During the start, the broker will try to read the broker epoch from the CleanShutdownFile. Then put this broker epoch in the broker registration request.
The controller will verify the broker epoch in the request with its registration record. If it is the same, it is a clean shutdown.
- if the broker shuts down before it receives the broker epoch, it will write -1.
Note, the CleanShutdownFile is removed after the log manager is initialized. It will be created and written when the log manager is shutting down.
Unclean recovery
As the new proposal allows the ISR to be empty, the leader election strategy has to be reviewed.
...
The kafka-leader-election.sh tool will be upgraded to allow manual leader election.
It can directly select a leader.
It can trigger an unclean recovery for the replica with the longest log in either Aggressive or Balance mode.
- Configs to update
- unclean.recovery.strategy. Described in the above section. Balanced is the default value.
- unclean.recovery.manager.enabled. True for using the unclean recovery manager to perform an unclean recovery. False otherwise. False is the default value.
- unclean.recovery.timeout.ms. The time limits of waiting for the replicas' response during the Unclean Recovery. 5 min is the default value.
. Please refer to the Config Changes section - For compatibility, the original unclean.leader.election.enable options True/False will be mapped to unclean.recovery.strategy options.
- unclean.
For compatibility, the original unclean.leader.election.enable options True/False will be mapped to unclean.recovery.strategy options.- unclean.leader.election.enable.false -> unclean.recovery.strategy.Balanced
- unclean.leader.election.enable.true -> unclean.recovery.strategy.Aggressive
...
{
"apiKey":62,
"type": "request",
"listeners": ["controller"],
"name": "BrokerRegistrationRequest",
"validVersions": "0-2",
"flexibleVersions": "0+",
"fields": [
...
// New fields begin.
{ "name": "PreviousBrokerEpoch", "type": "int64", "versions": "2+", "default": "-1",
"about": "The epoch before a clean shutdown." }
// New fields end.
]
}
|
...
DescribeTopicPartitionsRequest (Coming with ELR)
Should be issued by admin clients. The broker will serve this request. As a part of the change, the admin client will start to use DescribeTopicRequest
to query the topic, instead of using the metadata requests.
On the other hand, The following changes may affect the client side.
- The TopicPartitionInfo will also updated to include the ELR info.
- kafka-topics.sh does not have changes to its API but will have new fields in the output for the ELR, LastKnownELR, and LastKnownLeader.
ACL: Describe Topic
Limit: 20 topics max per request. If more than 20 topics are included, only the first 20 will be returned with info. Others will be returned with InvalidRequestError.
More admin client related details please refer to the Admin API/Client changes
ACL: Describe Topic
The caller can list the topics interested or keep the field empty if requests all of the topics.
Pagination.
This is a new behavior introduced. The caller can specify the maximum number of partitions to be included in the response.
If there are more partitions than the limit, these partitions and their topics will not be sent back. In this case, the Cursor field will be populated. The caller can include this cursor in the next request.
Note,
- There is also a server-side config to control the maximum number of partitions to return. max.request.partition.size.limit
- There is no consistency guarantee between requests.
- It is an admin client facing API, so there is no topic id supported.
{
"apiKey": 74,
{
"apiKey":69,
"type": "request",
"listeners": ["broker"],
"name": "DescribeTopicRequestDescribeTopicPartitionsRequest",
"validVersions": "0",
"flexibleVersions": "0+",
"fields": [
{ "name": "Topics", "type": "[]stringTopicRequest", "versions": "0+",
"about": "The topics to fetch details for.",
"versionsfields": "0+", "entityType[
{ "name": "topicName"}
]
}
|
DescribeTopicResponse
{
"apiKey":69,
Name", "type": "requeststring",
"nameversions": "DescribeTopicResponse0+",
"validVersions
"about": "0The topic name",
"flexibleVersionsversions": "0+",
"fieldsentityType": [
{ ""topicName"}
]
},
{ "name": "TopicsResponsePartitionLimit", "type": "[]MetadataResponseTopicint32", "versions": "0+", "default": ",
2000",
"about": "Each topicThe maximum number of partitions included in the response." }, "fields": [
{ "name": "ErrorCodeCursor", "type": "int16Cursor", "versions": "0+",
"aboutnullableVersions": "The topic error, or 0 if there was no error." },
{ "name0+", "default": "Namenull",
"typeabout": "stringThe first topic and partition index to fetch details for.", "versionsfields": [
{ "0+name",: "mapKeyTopicName": true, "entityTypetype": "topicNamestring", "nullableVersionsversions": "0+",
"about": "The name for the first topic name." },
to process", "versions": "0+", "entityType": "topicName"},
{ "name": "TopicIdPartitionIndex", "type": "uuidint32", "versions": "0+", "ignorable": true, "about": "The partition index to start with"}
]}
]
}
|
DescribeTopicsResponse
{
"apiKey": 74,
topic id." },
{ "name": "IsInternal", "type": "boolresponse",
"versionsname": "0+DescribeTopicPartitionsResponse",
"defaultvalidVersions": "false0",
"ignorableflexibleVersions": true,
"about": "True if the topic is internal." },
"0+",
"fields": [
{ "name": "PartitionsThrottleTimeMs", "type": "[]MetadataResponsePartitionint32", "versions": "0+",
"aboutignorable": "Each partitiontrue,
"about": "The duration in the topic.", "fields": [
{ "name": "ErrorCode", "type": "int16", "versions": "0+",
"about": "The partition error, or 0 if there was no error." },
milliseconds for which the request was throttled due to a quota violation, or zero if the request did not violate any quota." },
{ "name": "PartitionIndexTopics", "type": "int32[]DescribeTopicPartitionsResponseTopic", "versions": "0+",
"
"about": "The partition indexEach topic in the response." },
, "fields": [
{ "name": "LeaderIdErrorCode", "type": "int32int16", "versions": "0+", "entityType": "brokerId",
"about": "The ID of the leader broker topic error, or 0 if there was no error." },
{ "name": "LeaderEpochName", "type": "int32string", "versions": "0+", "defaultmapKey": "-1"true, "ignorableentityType": true,
"about"topicName", "nullableVersions": "The leader epoch of this partition0+",
"about": "The topic name." },
{ "name": "ReplicaNodesTopicId", "type": "[]int32uuid", "versions": "0+", "entityTypeignorable": "brokerId",
true, "about": "The set of all nodes that host this partitiontopic id." },
{ "name": "IsrNodesIsInternal", "type": "[]int32bool", "versions": "0+", "entityTypedefault": "brokerIdfalse",
"aboutignorable": "The set of nodes that are in sync with the leader for this partitiontrue,
"about": "True if the topic is internal." },
{ "name": "EligibleLeaderReplicasPartitions", "type": "[]int32DescribeTopicPartitionsResponsePartition", "default": "null", "entityType": "brokerId",
"versions": "0+", "nullableVersions": "0+",
"about": "TheEach newpartition eligiblein leaderthe replicas otherwisetopic." },
"fields": [
{ "name": "LastKnownELRErrorCode", "type": "[]int32int16", "defaultversions": "null0+",
"entityTypeabout": "brokerId",
The partition error, or 0 if there was no error." },
"versions { "name": "PartitionIndex", "type": "0+int32", "nullableVersionsversions": "0+",
"about": "The lastpartition known ELRindex." },
{ "name": "LastKnownLeaderLeaderId", "type": "int32", "defaultversions": "null0+", "entityType": "brokerId",
"about": "The ID of the leader "versionsbroker." },
{ "name": "0+LeaderEpoch", "nullableVersionstype": "0+int32",
"versions": "0+", "default": "-1", "ignorable": true,
"about": "The leader epoch lastof knownthis leaderpartition." },
{ "name": "OfflineReplicasReplicaNodes", "type": "[]int32", "versions": "0+", "ignorable": true, "entityType": "brokerId",
"about": "The set of offlineall nodes replicasthat ofhost this partition." },
{ "name": "TopicAuthorizedOperationsIsrNodes", "type": "[]int32", "versions": "0+", "defaultentityType": "-2147483648brokerId",
"about": "32-bitThe bitfieldset toof representnodes authorized operationsthat are in sync with the leader for this topicpartition." }]},
]
}
|
CleanShutdownFile (Coming with ELR)
ElectLeadersRequest (Coming with Unclean Recovery)
ACL: CLUSTER_ACTION
Limit: 20 topics per request. If more than 20 topics are included, only the first 20 will be served. Others will be returned with DesiredLeaders.
{
"apiKey": 43,
name": "EligibleLeaderReplicas", "type": "request[]int32",
"listenersdefault": ["zkBrokernull", "brokerentityType",: "controllerbrokerId"],
,
"nameversions": "ElectLeadersRequest0+",
"validVersionsnullableVersions": "0-3+",
"flexibleVersionsabout": "2+",
"fields": [
...
The new eligible leader replicas otherwise." },
{ "name": "TopicPartitionsLastKnownELR", "type": "[]TopicPartitions",int32", "default": "null", "entityType": "brokerId",
"versions": "0+", "nullableVersions": "0+",
"about": "The topiclast partitions to elect leadersknown ELR." },
"fields": [
...
// New fields begin.
{ "name": "DesiredLeadersOfflineReplicas", "type": "[]int32", "versions": "30+",
"about"ignorable": true, "entityType": "brokerId"The,
desired leaders. The entry should matches with the entry in Partitions by the index." },
},
// New fields end.
] },
{ "name": "TimeoutMs "about": "The set of offline replicas of this partition." }]},
{ "name": "TopicAuthorizedOperations", "type": "int32", "versions": "0+", "default": "60000-2147483648",
"about": "The32-bit timebitfield into msrepresent toauthorized waitoperations for the election to completethis topic." }
]
}
|
GetReplicaLogInfo Request (Coming with Unclean Recovery)
ACL: CLUSTER_ACTION
Limit: 2000 partitions per request. If more than 2000 partitions are included, only the first 2000 will be served.
{
"apiKey":70,
]
},
{ "name": "NextTopicPartition", "type": "requestCursor",
"listenersversions": ["broker0+"],
"namenullableVersions": "GetReplicaLogInfoRequest0+",
"validVersionsdefault": "0null",
"flexibleVersionsabout": "0+The next topic and partition index to fetch details for.",
"fields": [
{ "name": "BrokerIdTopicName", "type": "int32string", "versions": "0+", "entityType": "brokerId",
"about": "The IDname offor the broker." },
{ "namefirst topic to process", "versions": "TopicPartitions0+", "typeentityType": "[]TopicPartitionstopicName"},
{ "name": "PartitionIndex", "versionstype": "0+int32", "nullableVersionsversions": "0+",
"about": "The topicpartition partitionsindex to query the log info.",
"fields": [
start with"}
]}
]
}
|
CleanShutdownFile (Coming with ELR)
It will be a JSON file.
{
"version": 0
"BrokerEpoch":"xxx"
}
|
ElectLeadersRequest (Coming with Unclean Recovery)
ACL: CLUSTER_ACTION
Limit: 1000 partitions per request. If more than 1000 partitions are included, only the first 1000 will be served. Others will be returned with REQUEST_LIMIT_REACHED.
{
"apiKey": 43,
"type": "request",
"listeners": ["zkBroker", "broker", "controller"],
{ "name": "TopicId", "type": "uuid", "versions": "0+", "ignorable": true, "about": "The unique topic ID"},
{ "name": "PartitionsElectLeadersRequest",
"typevalidVersions": "[]int320-3",
"versionsflexibleVersions": "02+",
"fields": [
...
{ "aboutname": "The partitions of this topic whose leader should be elected." },
]}
] }
|
GetReplicaLogInfo Response
{
"apiKey":70,
TopicPartitions", "type": "response[]TopicPartitions",
"nameversions": "GetReplicaLogInfoResponse0+",
"validVersionsnullableVersions": "0+",
"flexibleVersionsabout": "0+The topic partitions to elect leaders.",
"fields": [
{ "name": "BrokerEpoch", "type": "int64", "versions": "0+", "about": "The epoch for the broker." }
...
// New fields begin. The same level with the Partitions
{ "name": "TopicPartitionLogInfoListDesiredLeaders", "type": "[]TopicPartitionLogInfoint32", "versions": "03+",
"nullableVersions": "3+",
"about": "The desired leaders. The entry listshould match ofwith the log infoentry in Partitions by the index." },
"fields": [ },
// New fields end.
] },
{ "name": "TopicIdTimeoutMs", "type": "uuidint32", "versions": "0+", "ignorabledefault": true, ""60000",
"about": "The uniquetime topic ID."},
{ "in ms to wait for the election to complete." }
]
}
|
GetReplicaLogInfo Request (Coming with Unclean Recovery)
ACL: CLUSTER_ACTION
Limit: 2000 partitions per request. If more than 1000 partitions are included, only the first 1000 will be served. Others will be returned with REQUEST_LIMIT_REACHED.
{
"apiKey":70,
name": "PartitionLogInfo", "type": "[]PartitionLogInforequest",
"versionslisteners": ["0+broker"],
"aboutname": "GetReplicaLogInfoRequest"The,
log info of a partition."validVersions": "0",
"flexibleVersions": "0+",
"fields": [
{ "name": "PartitionBrokerId", "type": "int32", "versions": "0+", "entityType": "brokerId",
"about": "The idID forof the partitionbroker." },
{ "name": "LastWrittenLeaderEpochTopicPartitions", "type": "int32[]TopicPartitions", "versions": "0+", "nullableVersions": "0+",
"about": "The lasttopic writtenpartitions leaderto epoch inquery the log info." },
{ "namefields": "CurrentLeaderEpoch[
{ "name": "TopicId", "type": "int32uuid", "versions": "0+", "ignorable": true, "about": "The currentunique leader epoch for the partition from the broker point of view." topic ID"},
{ "name": "LogEndOffsetPartitions", "type": "int64[]int32", "versions": "0+",
"about": "The logpartitions endof offsetthis fortopic thewhose partition." }
]leader should be elected." },
]}
] }
|
kafka-leader-election.sh (Coming with Unclean Recovery)
GetReplicaLogInfo Response
{
"apiKey":70,
"type": "response",
"name": "GetReplicaLogInfoResponse",
"validVersions": "0",
"flexibleVersions": "0+",
"fields": [
{ "name": "BrokerEpoch", "type": "int64", "versions": "0+", "about": "The epoch for the broker." }
{ "name": "TopicPartitionLogInfoList", "type": "[]TopicPartitionLogInfo", "versions": "0+",
"about": "The list of the log info.",
"fields": [
...
// Updated field starts.
--election-type <[PREFERRED, UNCLEAN, LONGEST_LOG_AGGRESSIVE, LONGEST_LOG_BALANCED, DESIGNATION]:
{ Type of election to attempt. Possible
election type> "name": "TopicId", "type": "uuid", "versions": "0+", "ignorable": true, "about": "The unique topic ID."},
{ values are "name": "PartitionLogInfo", "type": "[]PartitionLogInfo", "versions": "0+", "about": "The log info of a partition.",
"fields": [
{ "name": "Partition", "type": "int32", "versions": "0+", "about": "The id for the partition." },
{ "name": "preferred" for preferred leader election
"LastWrittenLeaderEpoch", "type": "int32", "versions": "0+", "about": "The last written leader epoch in the log." },
{ "name": "CurrentLeaderEpoch", "type": "int32", "versions": "0+", "about": "The current leader epoch for the partition from the broker point of view." },
{ or"name": "uncleanLogEndOffset", for a random unclean leader election,
"type": "int64", "versions": "0+", "about": "The log end offset for the partition." },
{ "name": "ErrorCode", "type": "int16", "versions": "0+", "about": "The result error, or zero if there was no error."},
{ "name": "ErrorMessage", "type": "string", or "longest_log_agressive"/"longest_log_balanced" to choose the replica
"versions": "0+", "nullableVersions": "0+", "about": "The result message, or null if there was no error."} ]},
]}
] }
|
kafka-leader-election.sh (Coming with Unclean Recovery)
...
// Updated field starts.
--election-type <[PREFERRED, UNCLEAN, LONGEST_LOG_AGGRESSIVE, LONGEST_LOG_BALANCED, DESIGNATION]:
with the longest log
Type of election to attempt. Possible
or "designation"election fortype> electing the given replica("desiredLeader") to be the leader.
values are
If preferred election is selection, the
"preferred" for preferred leader election
election is only performed if the
or "unclean" for a random unclean leader election,
current leader is not the preferred
or "longest_log_agressive"/"longest_log_balanced" to choose the replica
leader for the topic partition. If
with the longest log
longest_log_agressive/longest_log_balanced/designation
or "designation" for electing the given replica("desiredLeader") to be the leader.
election is selected, the
If preferred election is selection, the
election is only performed if there
election is only performed if the
are no leader for the topic
current leader is not the preferred
partition. REQUIRED. leader for the topic partition.
--path-to-json-file <String: Path toIf
The JSON file with the list of
JSON file> longest_log_agressive/longest_log_balanced/designation
partition for which leader elections
election is selected, the
should be performed. This is an
election is only performed if there
example format. The desiredLeader field
are no leader for the topic
is only required in DESIGNATION election.
partition. REQUIRED.
--path-to-json-file <String: Path to {"partitions":
The JSON file with the list of
JSON file> [{"topic": "foo", "partition": 1, "desiredLeader": 0},
partition for which leader elections
{"topic": "foobar", "partition": 2, "desiredLeader": 1}]
should be performed. This is an
example format. The desiredLeader field
}
is only required in DESIGNATION election.
Not allowed if --all-topic-partitions
{"partitions":
or --topic flags are specified.
// Updated field ends [{"topic": "foo", "partition": 1, "desiredLeader": 0},
{"topic": "foobar", "partition": 2, "desiredLeader": 1}]
}
Not allowed if --all-topic-partitions
or --topic flags are specified.
// Updated field ends.
|
|
Config changes
The new configs are introduced for ELR
- eligible.leader.replicas.enabled. It controls whether the controller will record the ELR-related metadata and whether ISR can be empty. False is the default value. It will turn true in the future.
- max.request.partition.size.limit. The maximum number of partitions to return in a API response.
The new configs are introduced for Unclean Recovery.
- unclean.recovery.strategy. Described in the above section. Balanced is the default value.
- unclean.recovery.manager.enabled. True for using the unclean recovery manager to perform an unclean recovery. False means the random election will be used in the unclean leader election. False is the default value.
- unclean.recovery.timeout.ms. The time limits of waiting for the replicas' response during the Unclean Recovery. 5 min is the default value.
New Errors
REQUEST_LIMIT_REACHED
As we introduce the request limit for the new APIs, the items sent in the request but over the limit will be returned with REQUEST_LIMIT_REACHED. It is a retriable error.
Admin API/Client changes
The admin client will start to use the DescribeTopicsRequest to describe the topic.
- The client will split a large request into proper pieces and send them one after another if the requested topics count reaches the limit.
- The client will retry querying the topics if they received the response with Cursor field.
- The output of the topic describe will be updated with the ELR related fields.
- TopicPartitionInfo will be updated to include the ELR related fields.
Metrics
The following metrics will be added for ELR
...
min.insync.replicas will no longer be effective to be larger than the replication factor. For existing configs, the min.insync.replicas will be min(min.insync.replicas, replication factor).
Cluster admin should update the min.insync.replicas to 1if they want to have the replication going when there is only the leader in the ISR.
- Note that, this new requirement is not guarded by any feature flags/Metadata version.
ELR
It will be guarded by a new metadata version and the eligible.leader.replicas.enabled. So it is not enabled during the rolling upgrade.
After the controller picked up the new MV and eligible.leader.replicas.enabled is true, when it loads the partition states, it will populate the ELR as empty if the PartitionChangeRecord uses an old version. In the next partition update, the controller will record the current ELR.
Note, the leader can only enable empty ISR after the new metadata version.
DowngradeMV downgrade: Once the MV version is downgraded, all the ELR related fields will be removed on the next partition change. The controller will also ignore the ELR fields.
Software downgrade: After the MV version is downgraded, a metadata delta will be generated to capture the current status. Then the user can start the software downgrade.
Clean shutdown
It will be guarded by a new metadata version. Before that, the controller will treat all the registrations with unclean shutdowns.
...