...
This KIP proposes to optionally include fenced brokers in the response to DescribeClusterRequest. A new boolean field, IncludeFencedBrokers , will be added to DescribeClusterRequest. By default, fenced brokers will not be included in the list of broker nodes returned. Also a new boolean field, isFenced Fenced, will be added to each broker's information in DescribeClusterResponse.
...
| Code Block | ||
|---|---|---|
| ||
{
"apiKey": 60,
"type": "response",
"name": "DescribeClusterResponse",
//
// Version 1 adds the EndpointType field, and makes MISMATCHED_ENDPOINT_TYPE and
// UNSUPPORTED_ENDPOINT_TYPE valid top-level response error codes.
// Version 2 adds IsFencedFenced field to Brokers for KIP-1073 support.
//
"validVersions": "0-2",
"flexibleVersions": "0+",
"fields": [
{ "name": "ThrottleTimeMs", "type": "int32", "versions": "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." },
{ "name": "ErrorCode", "type": "int16", "versions": "0+",
"about": "The top-level error code, or 0 if there was no error" },
{ "name": "ErrorMessage", "type": "string", "versions": "0+", "nullableVersions": "0+", "default": "null",
"about": "The top-level error message, or null if there was no error." },
{ "name": "EndpointType", "type": "int8", "versions": "1+", "default": "1",
"about": "The endpoint type that was described. 1=brokers, 2=controllers." },
{ "name": "ClusterId", "type": "string", "versions": "0+",
"about": "The cluster ID that responding broker belongs to." },
{ "name": "ControllerId", "type": "int32", "versions": "0+", "default": "-1", "entityType": "brokerId",
"about": "The ID of the controller broker." },
{ "name": "Brokers", "type": "[]DescribeClusterBroker", "versions": "0+",
"about": "Each broker in the response.", "fields": [
{ "name": "BrokerId", "type": "int32", "versions": "0+", "mapKey": true, "entityType": "brokerId",
"about": "The broker ID." },
{ "name": "Host", "type": "string", "versions": "0+",
"about": "The broker hostname." },
{ "name": "Port", "type": "int32", "versions": "0+",
"about": "The broker port." },
{ "name": "Rack", "type": "string", "versions": "0+", "nullableVersions": "0+", "default": "null",
"about": "The rack of the broker, or null if it has not been assigned to a rack." },
//NEW FIELD
{ "name": "IsFencedFenced", "type": "bool", "versions": "2+",
"about": "Whether the broker is fenced." }
]},
{ "name": "ClusterAuthorizedOperations", "type": "int32", "versions": "0+", "default": "-2147483648",
"about": "32-bit bitfield to represent authorized operations for this cluster." }
]
} |
AdminClient API changes
DescribeClusterOptions will include a A new field, includeFencedBrokers, and by default the option is disabled. When the option includeFencedBrokers, will be added to DescribeClusterOptions. By default, this option is set to false. When includeFencedBrokers is set to true, any fenced brokers will be included in DescribeClusterResult class returned by AdminClientin the DescribeClusterResponse along with the unfenced brokers. The corresponding resource description or result classes returned by AdminClient will be extended to provide an optional set of authorized operationsin the DescribeClusterResult returned by Admin clients.
DescribeClusterOptions
| Code Block | ||
|---|---|---|
| ||
public class DescribeClusterOptions extends AbstractOptions<DescribeClusterOptions> {
private boolean includeAuthorizedOperations;
private boolean includeFencedBrokers; //NEW OPTION
/**
* Set the timeout in milliseconds for this operation or {@code null} if the default api timeout for the
* AdminClient should be used.
*
*/
// This method is retained to keep binary compatibility with 0.11
public DescribeClusterOptions timeoutMs(Integer timeoutMs) {
this.timeoutMs = timeoutMs;
return this;
}
public DescribeClusterOptions includeAuthorizedOperations(boolean includeAuthorizedOperations) {
this.includeAuthorizedOperations = includeAuthorizedOperations;
return this;
}
public DescribeClusterOptions includeFencedBrokers(boolean includeFencedBrokers) {
this.includeFencedBrokers = includeFencedBrokers;
return this;
}
/**
* Specify if authorized operations should be included in the response. Note that some
* older brokers cannot not supply this information even if it is requested.
*/
public boolean includeAuthorizedOperations() {
return includeAuthorizedOperations;
}
/**
* Specify if fenced brokers should be included in the response. Note that some
* older brokers cannot not supply this information even if it is requested.
*/
public boolean includeFencedBrokers() {
return includeFencedBrokers;
}
}
|
...
Compatibility, Deprecation, and Migration Plan
- Existing Admin clients using older versions will not request fenced brokers in
DescribeClusterrequests and the default is to return unfenced brokers only. This keeps older clients compatible with newer brokers. - Newer Admin clients connecting to older brokers will use the older protocol version and hence will not request fenced brokers.
Rejected Alternatives
Returning inactive observer nodes in DescribeMetadataQuorumResponse was considered. However, observers information is only stored in the quorum leader's memory state, therefore this information is lost when there is a leader change.