THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
...
| Code Block | ||
|---|---|---|
| ||
{
"apiKey": 58,
"type": "request",
"name": "BrokerHeartbeatRequest",
"validVersions": "0",
"flexibleVersions": "0+",
"fields": [
{ "name": "BrokerId", "type": "int32", "versions": "0+",
"about": "The broker ID." },
{ "name": "BrokerEpoch", "type": "int64", "versions": "0+", "default": "-1",
"about": "The broker epoch." },
{ "name": "CurrentMetadataOffset", "type": "int64", "versions": "0+",
"about": "One more than the highest metadata offset which the broker has reached." },
{ "name": "ShouldFence", "type": "bool", "versions": "0+",
"about": "True if the broker wants to be fenced, false otherwise." }
{ "name": "ShouldShutDown", "type": "bool", "versions": "0+",
"about": "True if the broker wants to initiate controlled shutdown." }
]
}
{
"apiKey": 58,
"type": "response",
"name": "BrokerHeartbeatResponse",
"validVersions": "0",
"flexibleVersions": "0+",
"fields": [
{ "name": "ThrottleTimeMs", "type": "int32", "versions": "0+",
"about": "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": "0+",
"about": "The error code, or 0 if there was no error." },
{ "name": "IsCaughtUp", "type": "bool", "versions": "0+",
"about": "True if the broker has approximately caught up with the latest metadata." },
{ "name": "IsFenced", "type": "bool", "versions": "0+",
"about": "True if the broker is fenced." },
{ "name": "ShouldShutDownControlledShutdownOk", "type": "bool", "versions": "0+",
"about": "True if the broker should shut down can execute a controlled shutdown now." }
]
} |
The controller will wait to unfence a broker until it has sent at least one heartbeat where that broker's currentState is active. So a typical transition will look like this:
- broker sends a BrokerHeartbeatRequest with currentState = fenced, targetState = active. controller response with nextState = active
- broker sends a BrokerHeartbeatRequest with currentState = active, targetState = active. controller response with nextState = active
- controller unfences the broker
The second step informs the controller that the broker has received its response to the first step. In order to speed this process along, the broker will send the second heartbeat immediately after receiving the first, rather than waiting for the heartbeat timeout.
sends a heartbeat where ShouldFence is false and CurrentMetadataOffset is caught up.
If the heartbeat request has ShouldShutDown set, the controller will try to move all the leaders off of the broker.
The controller will set ControlledShutdownOk if the broker is cleared to execute a controlled shutdown. In other words, if it has no leadershipsAs always with enums, the UNKNOWN state is used only to translate values that our software is too old to understand.
The controller will return NOT_CONTROLLER if it is not active. Brokers will always return NOT_CONTROLLER for these RPCs.Heartbeat requests that give a NextMetadataOffset which is lower than the previous one recorded for that broker will be ignored.
Record Formats
RegisterBrokerRecord
...