KAFKA-20790: Promote streams assignor API to public module #22788
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You under the Apache License, Version 2.0 | ||
| * (the "License"); you may not use this file except in compliance with | ||
| * the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package org.apache.kafka.coordinator.group.api.assignor.streams; | ||
|
|
||
| import org.apache.kafka.common.annotation.InterfaceAudience; | ||
| import org.apache.kafka.common.annotation.InterfaceStability; | ||
|
|
||
| import java.util.Collection; | ||
| import java.util.Map; | ||
|
|
||
| /** | ||
| * The group metadata specifications required to compute the target assignment. | ||
| */ | ||
| @InterfaceAudience.Public | ||
| @InterfaceStability.Evolving | ||
| public interface GroupSpec { | ||
|
|
||
| /** | ||
| * @return The member Ids of all members in the group. | ||
| */ | ||
| Collection<String> memberIds(); | ||
|
|
||
| /** | ||
| * Gets the static metadata for a given member. | ||
| * | ||
| * @param memberId The member Id. | ||
| * @return The static member metadata. | ||
| */ | ||
| MemberAssignmentMetadata memberMetadata(String memberId); | ||
|
|
||
| /** | ||
| * Gets the current assignment state for a given member. | ||
| * | ||
| * @param memberId The member Id. | ||
| * @return The current member assignment state. | ||
| */ | ||
| MemberAssignmentState memberAssignmentState(String memberId); | ||
|
|
||
| /** | ||
| * @return Any configurations passed to the assignor. | ||
| */ | ||
| Map<String, String> configs(); | ||
|
|
||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You under the Apache License, Version 2.0 | ||
| * (the "License"); you may not use this file except in compliance with | ||
| * the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package org.apache.kafka.coordinator.group.api.assignor.streams; | ||
|
|
||
| import org.apache.kafka.common.annotation.InterfaceAudience; | ||
| import org.apache.kafka.common.annotation.InterfaceStability; | ||
|
|
||
| import java.util.Map; | ||
| import java.util.Set; | ||
|
|
||
| /** | ||
| * The task assignment for a streams group member. | ||
| * | ||
| * <p>Only active and standby tasks are assigned by the {@link TaskAssignor}. Warm-up tasks are | ||
| * not assigned by the assignor; they are decided during reconciliation. | ||
| */ | ||
| @InterfaceAudience.Public | ||
| @InterfaceStability.Evolving | ||
| public interface MemberAssignment { | ||
|
|
||
| /** | ||
| * @return The active tasks assigned to this member keyed by subtopology Id. | ||
| */ | ||
| Map<String, Set<Integer>> activeTasks(); | ||
|
|
||
| /** | ||
| * @return The standby tasks assigned to this member keyed by subtopology Id. | ||
| */ | ||
| Map<String, Set<Integer>> standbyTasks(); | ||
|
|
||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You under the Apache License, Version 2.0 | ||
| * (the "License"); you may not use this file except in compliance with | ||
| * the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package org.apache.kafka.coordinator.group.api.assignor.streams; | ||
|
|
||
| import org.apache.kafka.common.annotation.InterfaceAudience; | ||
| import org.apache.kafka.common.annotation.InterfaceStability; | ||
|
|
||
| import java.util.Map; | ||
| import java.util.Optional; | ||
|
|
||
| /** | ||
| * Interface representing the static metadata for a streams group member. | ||
| * | ||
| * <p>The metadata contains the per-member information that does not change during the assignment | ||
| * computation. The member's current task assignment state is exposed separately through | ||
| * {@link MemberAssignmentState}. | ||
| */ | ||
| @InterfaceAudience.Public | ||
| @InterfaceStability.Evolving | ||
| public interface MemberAssignmentMetadata { | ||
|
|
||
| /** | ||
| * @return The instance ID if provided. | ||
| */ | ||
| Optional<String> instanceId(); | ||
|
|
||
| /** | ||
| * @return The rack ID if provided. | ||
| */ | ||
| Optional<String> rackId(); | ||
|
|
||
| /** | ||
| * @return The process ID. | ||
| */ | ||
| String processId(); | ||
|
|
||
| /** | ||
| * @return The client tags for a rack-aware assignment. | ||
| */ | ||
| Map<String, String> clientTags(); | ||
|
|
||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You under the Apache License, Version 2.0 | ||
| * (the "License"); you may not use this file except in compliance with | ||
| * the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package org.apache.kafka.coordinator.group.api.assignor.streams; | ||
|
|
||
| import org.apache.kafka.common.annotation.InterfaceAudience; | ||
| import org.apache.kafka.common.annotation.InterfaceStability; | ||
|
|
||
| import java.util.Map; | ||
| import java.util.Set; | ||
|
|
||
| /** | ||
| * Interface representing the current assignment state for a streams group member. | ||
| * | ||
| * <p>This is the assignment the member currently owns and is used by the {@link TaskAssignor} | ||
| * to compute a new, sticky target assignment. Note that the assignor does not assign warm-up | ||
| * tasks itself (they are decided during reconciliation), but the currently-assigned warm-up | ||
| * tasks are exposed here so that the assignor can take them into account. | ||
| * | ||
| * <p>The task-set accessors ({@link #activeTasks()}, {@link #standbyTasks()}, | ||
| * {@link #warmupTasks()}) are keyed by subtopology ID, mirroring the grouped {@code TaskIds} | ||
| * wire format ({@code subtopologyId, [partitions]}). In contrast, {@link #taskOffsets()} and | ||
| * {@link #taskEndOffsets()} are keyed by {@link TaskId}, mirroring the flat {@code TaskOffset} | ||
| * wire format ({@code subtopologyId, partition, offset}). The two shapes differ because the | ||
| * underlying wire representations differ. | ||
| */ | ||
| @InterfaceAudience.Public | ||
| @InterfaceStability.Evolving | ||
| public interface MemberAssignmentState { | ||
|
|
||
| /** | ||
| * @return The current active tasks keyed by subtopology Id. | ||
| */ | ||
| Map<String, Set<Integer>> activeTasks(); | ||
|
|
||
| /** | ||
| * @return The current standby tasks keyed by subtopology Id. | ||
| */ | ||
| Map<String, Set<Integer>> standbyTasks(); | ||
|
|
||
| /** | ||
| * @return The current warm-up tasks keyed by subtopology Id. | ||
| */ | ||
| Map<String, Set<Integer>> warmupTasks(); | ||
|
|
||
| /** | ||
| * @return The last received cumulative task offsets of assigned tasks or dormant tasks. | ||
| */ | ||
| Map<TaskId, Long> taskOffsets(); | ||
|
Member
There was a problem hiding this comment. One argument during KIP discussion was, to return data based on wire format. That's why we don't have And I just realize that the wire-format between both task-ids (which is an array of But I am now wondering what the best representation for
Contributor
Author
There was a problem hiding this comment. I think maybe keep it the Map<TaskId, Long> is more reasonable, I have update the interface of Taskid |
||
|
|
||
| /** | ||
| * @return The last received cumulative task end offsets of assigned tasks or dormant tasks. | ||
| */ | ||
| Map<TaskId, Long> taskEndOffsets(); | ||
|
|
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You under the Apache License, Version 2.0 | ||
| * (the "License"); you may not use this file except in compliance with | ||
| * the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package org.apache.kafka.coordinator.group.api.assignor.streams; | ||
|
|
||
| import org.apache.kafka.common.annotation.InterfaceAudience; | ||
| import org.apache.kafka.common.annotation.InterfaceStability; | ||
|
|
||
| /** | ||
| * The identifier for a task. | ||
| */ | ||
| @InterfaceAudience.Public | ||
| @InterfaceStability.Evolving | ||
| public interface TaskId extends Comparable<TaskId> { | ||
|
|
||
| /** | ||
| * @return The unique identifier of the subtopology. | ||
| */ | ||
| String subtopologyId(); | ||
|
|
||
| /** | ||
| * @return The partition of the input topics this task is processing. | ||
| */ | ||
| int partition(); | ||
|
|
||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The KIP defines this as a class, not a record. -- Given that this is an output/return type, not an input to the assignor, it might actually be ok to keep as record, and we could also update the KIP?
\cc @lianetm for input
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, I will update my kip and make it into a record.