Table of Contents |
---|
Status
Current state: DraftAccepted
Discussion thread: here
JIRA: KAFKA-3853
Released: <Kafka Version>0.10.2.0
Please keep the discussion on the mailing list rather than commenting on the wiki (wiki discussions get unwieldy fast).
This KIP was prepared thanks to valuable feedback by Jason Gustafson.
Motivation
KAFKA-3853 asks for an improvement to the new-consumer
describe
option of the consumer group command for new (Java API based) consumers. This command, when passed a consumer group that has no consumer (i.e., when the group state is Empty
), currently reports an error indicating that there is no active member:
Code Block | ||
---|---|---|
| ||
$ bin/kafka-consumer-groups.sh --new-consumer --bootstrap-server localhost:9092 --describe --group group1 Note: This will only show information about consumers that use the Java consumer API (non-ZooKeeper-based consumers). Error: Consumer group 'group1' has no active members. |
The requested improvement is returning offsets within the group (and leaving the consumer column empty) instead of returning the error message above. The error message can still be printed to to stderr
as a warning.
When the group is Stable
(i.e. when there are active consumers in the group), {{DescribeGroups Response}} the above command returns the associated topic partition assignment for each member of the group, and that assignment can be used to extract the corresponding committed offset(s). However, if the group state is Empty
(i.e. when there are no active consumers in the group) there is no associated topic partition info in {{DescribeGroups Response}}DescribeGroups
response. Therefore, a change in the protocol seems to be the only way to extract associated topic partitions of a group and the corresponding committed offsets. DescribeGroups
response in its current protocol would not help.
The OffsetFetch
protocol can be used to extract offsets associated with given topic partitions in a consumer group. The problem is, when consumer group is in Empty
state or even when it is Stable
but not all its topics are being consumed, currently there is no way to extract all its topic partitions that it has consumed from (i.e. has offset for). We can modify the behavior of OffsetFetch
protocol so it returns all topic partitions associated with the group if it is passed a null
value (as the list of topic partitions).
Public Interfaces
This is the current schema for DescribeGroups OffsetFetch
(version 01, that applies to fetching from Kafka, and not ZooKeeper).
Code Block | ||
---|---|---|
| ||
DescribeGroupsOffsetFetch Request (Version: 01) => [group_idsid [topics] group_idsid => STRING DescribeGroups Response (Version: 0) topics => topic [groupspartitions] groups topic => STRING error_code group_id state protocol_type protocol [members]partitions => partition error_code partition => INT16INT32 OffsetFetch Response group_id(Version: 1) => STRING[responses] stateresponses => STRING protocol_type => STRINGtopic [partition_responses] protocoltopic => STRING memberspartition_responses => member_id client_id client_host member_metadata member_assignmentpartition offset metadata error_code member_idpartition => STRINGINT32 client_idoffset => STRINGINT64 client_hostmetadata => NULLABLE_STRING membererror_metadatacode => BYTES member_assignment => BYTES |
As shown above, and as explained in the previous section, corresponding topic partitions can be extracted only through the individual (and active) members
of the group. The list members
is empty if the group is in Empty
state, so with this protocol there is no way to extract offsets of an Empty
group (problem 1).
Also, offset information for a Stable
group is not stored in the above Response
schema. Offsets associated with a Stable
consumer group are currently extracted using the committed
method of KafkaConsumer
and by creating a new and dummy member in the group for the sole purpose of making committed
calls on every topic partition of each of the other consumers in the group to extract the corresponding offsets. A cleaner approach would be extracting these offsets without having to create this dummy member (problem 2).
Proposed below is version 1 of the DescribeGroups
schema that solves both problems above by including the group offset information directly into the Response
schema (lines 17-21 below). Note that topic partitions reported under the offsets
field are going to be a superset of topic partitions reported under members:member_assignment
.
Code Block | ||
---|---|---|
| ||
DescribeGroups Request (Version: 1) => [group_ids]
group_ids => STRING
DescribeGroups Response (Version: 1) => [groups]
groups => error_code group_id state protocol_type protocol [members] [offsets]
error_code => INT16
group_id => STRING
state => STRING
protocol_type => STRING
protocol => STRING
members => member_id client_id client_host member_metadata member_assignment
member_id => STRING
client_id => STRING
client_host => STRING
member_metadata => BYTES
member_assignment => BYTES
offsets => topic partition offset metadata
topic => STRING
partition => INT32
offset => INT64
metadata => STRING |
Proposed Changes
The proposal is to include a list offsets
of tuples in the response to DescribeGroups request. Each of these tuples contains the following fields:
- topic: topic from which a previous member of the group consumed.
- partition: partition of the above topic for which offset information associated with the group exists
- offset: associated committed offset of the above topic partition within the group
- metadata: metadata associated with the above offset
Compatibility, Deprecation, and Migration Plan
There should be no impact to existing users of this protocol. The Request
schema remains unchanged, and the Response
schema is only expanded. There is no change in the existing Response
structure, and, therefore, users who use version 0 of the schema should not be affected. The code behind kafka-consumer-groups.sh
will also be updated (as requested in the JIRA) to return additional information (rows of topic partitions with no assigned consumer). In case it is necessary to provide the old output as well, a new parameter can be defined for the tool to report the new information; while the old way of running the tool still prints out the old output.
Rejected Alternatives
...
INT16 |
The first suggestion is to use a similar Request
/ Response
protocol and bump up the version to 2. There will be two main changes to version 1 of the protocol in version 2:
- The first change to the protocol is that if no topics (
null
input for list of topics) are provided, the offset information of all topics (or topic partitions) associated with the group is returned. So the protocol will be slightly modified to define the inputtopics
array as a nullable array. - With version 0 and 1 of the protocol, a list of topic partitions is passed as part of
OffsetFetch
request, and, in return, the same topic partitions are returned. Along with each topic partition in the response there is anerror_code
field for reporting any error that could occur in extracting offset for that topic partition (e.g. if the user is not authorized to access that topic partition, if the topic partition does not exist, ...). It is possible to pass an empty array of topic partitions inOffsetFetch
request but in that scenario an error is never reported (irrespective of group or coordinator status) and an empty list is always returned in the response. In other words, there is no existing scenario, given the current protocol, in which an empty list is returned due to some error.
But with the proposed change above (passing a null array inOffsetFetch
request) it is now possible to have an empty list of topic partitions in the response because of an error situation (e.g. if there is a coordinator related error, or if user if not authorized to access the group). Therefore, it would not be possible to detect, for example, when the coordinator has moved to another broker or when it is still in the process of loading the offsets. This means it would be impossible to tell if there was an error or if there were just no offsets stored for the group. To handle these scenarios theOffsetFetch
response should be able to report an error at the top level (not associated with individual topic partitions). In fact, reporting coordinator or group related errors at the top level of the response rather than along with each topic partition is a more reasonable solution. Topic partition specific errors can still be returned in the internalerror_code
field associated with the individual topic partition.
Code Block |
---|
OffsetFetch Request (Version: 2) => group_id [topics]
group_id => STRING
topics => topic [partitions]
topic => STRING
partitions => partition
partition => INT32
OffsetFetch Response (Version: 2) => [responses] error_code
responses => topic [partition_responses]
topic => STRING
partition_responses => partition offset metadata error_code
partition => INT32
offset => INT64
metadata => NULLABLE_STRING
error_code => INT16
error_code => INT16 |
Code Block | ||
---|---|---|
| ||
public static final Schema OFFSET_FETCH_REQUEST_V2 = new Schema(new Field("group_id",
STRING,
"The consumer group id."),
new Field("topics",
ArrayOf.nullable(OFFSET_FETCH_REQUEST_TOPIC_V0),
"Topics to fetch offsets."));
public static final Schema OFFSET_FETCH_RESPONSE_V2 = new Schema(new Field("responses",
new ArrayOf(OFFSET_FETCH_RESPONSE_TOPIC_V0)),
new Field("error_code",
INT16)); |
The second suggestion has to do with how the above API is accessed and called. Currently, the way the offset information for each topic partition in a Stable
group is returned is through creating a "dummy" consumer in the group and use its committed
interface to extract those offset information:
Code Block | ||
---|---|---|
| ||
val consumer = getConsumer()
...
... consumer.committed(new TopicPartition(topicPartition.topic, topicPartition.partition)) ...
...
}) |
This committed
call makes use of the OffsetFetch
API to extract the offset of the given partition. The suggestion here is to add a method to AdminClient
that extracts offset information of a consumer group by making a call to OffsetFetch
API, and passing a null
input as list of topic partitions. That will return all offsets of topic partitions associated with the consumer's group:
Code Block | ||
---|---|---|
| ||
def listGroupOffsets(groupId: String): Map[TopicPartition, PartitionData] = {
val coordinator = findCoordinator(groupId)
val responseBody = send(coordinator, ApiKeys.OFFSET_FETCH, OffsetFetchRequest.allPartitionsOffsetFetchRequest(groupId))
val response = responseBody.asInstanceOf[OffsetFetchResponse]
response.responseData().asScala.toMap
} |
One benefit of using this method instead of using the KafkaConsumer
's committed
method is that we no longer need to create the dummy consumer to retrieve offsets. The other benefit here is that with one API call all offsets within the group are returned. Whereas, in the existing describe group implementation, for each topic partition in the group one API call is made.
Proposed Changes
The proposal is to
- Create version 2 of the
OffsetFetch
API in which,- in the request a
null
value can also be passed as the list of topic partitions, and in response, offsets of all topic partitions associated with the group are returned. - an
error_code
is returned at the top level to report coordinator or group related errors (scenarios in which an empty list is returned in the response), and to distinguish between when there is an error and when there are no stored offsets for the group.
- in the request a
- Add a
listGroupOffsets
interface toAdminClient
that makes use of the updatedOffsetFetch
API above and returns offsets of all topic partitions associated with the consumer's group.
Compatibility, Deprecation, and Migration Plan
With respect to the first proposed change above there should be no concern when it comes to compatibility because the older APIs (versions 0 and 1) did not accept a null
value for the input array. In the case where current users somehow rely on the exception raised when a null
value is passed to the current OffsetFetch
API as the list of topic partitions, they can stick to the current implementation of the API by using version 1 of the API. The behavioral change suggested in this KIP would apply to version 2 of the API only. The addition of the error_code
field in the response is also limited to version 2 of the API and the existing clients would have to either stick to version 1 of the API, or modify their implementation to look for errors in two places (the top level error_code
and the error_code
associated with each topic partition).
With respect to the added interface to AdminClient
there would be no issue as that interface does not exist in current implementation.
Rejected Alternatives
- Changing the
DescribeGroups
protocol so it also returns the offset information for all topic partitions from which the group has consumed from since its creation. More detailed can be found here. - Exposing the added
OffsetFetch
behavior through a new interface inKafkaConsumer
, which would still imply that the dummy consumer has to be created in the group in order to retrieve offsets. More details can be found here. - Passing an empty list, instead of
null
, to the API to get all offsets. Thenull
value was chosen to remain consistent with how some other APIs handle a similar situation (e.g.TopicMetadata
API returns metadata of all topics if it is provided with anull
value as list of topics). More details can be found here. - On the solution for reporting errors when there is no topic partition in the response, the following options were also considered, but set aside in favor of the cleaner solution provided above:
inserting a "dummy" partition into the response so that we have somewhere to return an error code.
including no error code, but using a null array in the response to indicate that there was some error. If there was no error, and the group simply had no partitions, then we return an empty array. I guess in this case, if the client receives a null array in the response, it should assume the worst
and rediscover the coordinator and try again (because there is no way to indicate what the error is).