-
Notifications
You must be signed in to change notification settings - Fork 15k
KAFKA-17747: [2/N] Add compute topic and group hash #19523
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 23 commits
36cb999
f4c9749
ced64d7
7e00a14
77b99da
aff55ce
7f7649a
8fc5b33
d2427f9
b5eebbf
b6ccef3
a1be1f6
9b4294f
478dd98
9fc8e8e
167cd4a
6e219a9
08cdd37
527b387
cde92d8
b238375
a1b658a
ed7b450
44c1337
f1ea74b
bb1edb3
3382702
c031a29
ec7024c
cf35b7a
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -1414,10 +1414,12 @@ project(':group-coordinator') { | |
| implementation project(':coordinator-common') | ||
| implementation libs.jacksonDatabind | ||
| implementation libs.jacksonJDK8Datatypes | ||
| implementation libs.lz4 | ||
| implementation libs.metrics | ||
| implementation libs.hdrHistogram | ||
| implementation libs.re2j | ||
| implementation libs.slf4jApi | ||
| implementation libs.hash4j | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I suppose that we need to update the license file too.
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes, I added it to LICENSE-binary and
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is fine. Thanks. |
||
|
|
||
| testImplementation project(':clients').sourceSets.test.output | ||
| testImplementation project(':server-common').sourceSets.test.output | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -25,13 +25,18 @@ | |
| import org.apache.kafka.common.protocol.ApiMessage; | ||
| import org.apache.kafka.coordinator.group.generated.ConsumerGroupCurrentMemberAssignmentValue; | ||
| import org.apache.kafka.coordinator.group.generated.ShareGroupCurrentMemberAssignmentValue; | ||
| import org.apache.kafka.image.ClusterImage; | ||
| import org.apache.kafka.image.TopicImage; | ||
| import org.apache.kafka.image.TopicsImage; | ||
| import org.apache.kafka.metadata.BrokerRegistration; | ||
| import org.apache.kafka.server.common.ApiMessageAndVersion; | ||
|
|
||
| import com.dynatrace.hash4j.hashing.HashStream64; | ||
| import com.dynatrace.hash4j.hashing.Hashing; | ||
| import com.google.re2j.Pattern; | ||
| import com.google.re2j.PatternSyntaxException; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.ArrayList; | ||
| import java.util.Collection; | ||
| import java.util.Collections; | ||
|
|
@@ -324,4 +329,84 @@ static void throwIfRegularExpressionIsInvalid( | |
| regex, ex.getDescription())); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * The magic byte used to identify the version of topic hash function. | ||
| */ | ||
| static final byte TOPIC_HASH_MAGIC_BYTE = 0x00; | ||
|
|
||
| /** | ||
| * Computes the hash of the topics in a group. | ||
| * <p> | ||
| * The computed hash value is stored as part of the metadata hash in the *GroupMetadataValue. | ||
| * <p> | ||
| * The hashing process involves the following steps: | ||
| * 1. Sort the topic hashes by topic name. | ||
| * 2. Write each topic hash in order. | ||
| * | ||
| * @param topicHashes The map of topic hashes. Key is topic name and value is the topic hash. | ||
| * @return The hash of the group. | ||
| */ | ||
| static long computeGroupHash(Map<String, Long> topicHashes) { | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit: public?
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. IIUC, this function will only be used in
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ok. It works for me. |
||
| // Sort entries by topic name | ||
| List<Map.Entry<String, Long>> sortedEntries = new ArrayList<>(topicHashes.entrySet()); | ||
| sortedEntries.sort(Map.Entry.comparingByKey()); | ||
|
|
||
| HashStream64 hasher = Hashing.xxh3_64().hashStream(); | ||
| for (Map.Entry<String, Long> entry : sortedEntries) { | ||
| hasher.putLong(entry.getValue()); | ||
| } | ||
|
|
||
| return hasher.getAsLong(); | ||
| } | ||
|
|
||
| /** | ||
| * Computes the hash of the topic id, name, number of partitions, and partition racks by XXHash64. | ||
| * <p> | ||
| * The computed hash value for the topic is utilized in conjunction with the {@link #computeGroupHash(Map)} | ||
| * method and is stored as part of the metadata hash in the *GroupMetadataValue. | ||
| * It is important to note that if the hash algorithm is changed, the magic byte must be updated to reflect the | ||
| * new hash version. | ||
| * <p> | ||
| * The hashing process involves the following steps: | ||
| * 1. Write a magic byte to denote the version of the hash function. | ||
| * 2. Write the hash code of the topic ID. | ||
| * 3. Write the topic name. | ||
| * 4. Write the number of partitions associated with the topic. | ||
| * 5. For each partition, write the partition ID and a sorted list of rack identifiers. | ||
| * - Rack identifiers are formatted as "<length1><value1><length2><value2>" to prevent issues with simple separators. | ||
| * | ||
| * @param topicImage The topic image. | ||
| * @param clusterImage The cluster image. | ||
| * @return The hash of the topic. | ||
| */ | ||
| static long computeTopicHash(TopicImage topicImage, ClusterImage clusterImage) throws IOException { | ||
|
||
| HashStream64 hasher = Hashing.xxh3_64().hashStream(); | ||
| hasher = hasher.putByte(TOPIC_HASH_MAGIC_BYTE) // magic byte | ||
|
||
| .putLong(topicImage.id().hashCode()) // topic ID | ||
|
||
| .putString(topicImage.name()) // topic name | ||
| .putInt(topicImage.partitions().size()); // number of partitions | ||
|
|
||
| for (int i = 0; i < topicImage.partitions().size(); i++) { | ||
| hasher = hasher.putInt(i); // partition id | ||
| // The rack string combination cannot use simple separator like ",", because there is no limitation for rack character. | ||
| // If using simple separator like "," it may hit edge case like ",," and ",,," / ",,," and ",,". | ||
| // Add length before the rack string to avoid the edge case. | ||
|
||
| List<String> racks = new ArrayList<>(); | ||
|
||
| for (int replicaId : topicImage.partitions().get(i).replicas) { | ||
| BrokerRegistration broker = clusterImage.broker(replicaId); | ||
| if (broker != null) { | ||
| Optional<String> rackOptional = broker.rack(); | ||
| rackOptional.ifPresent(racks::add); | ||
|
||
| } | ||
| } | ||
|
|
||
| Collections.sort(racks); | ||
| for (String rack : racks) { | ||
| // Format: "<length><value>" | ||
| hasher = hasher.putInt(rack.length()).putString(rack); | ||
| } | ||
| } | ||
| return hasher.getAsLong(); | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit: Should we put an empty line before the return?
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Updated it. |
||
| } | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,207 @@ | ||
| /* | ||
| * 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; | ||
|
|
||
| import org.apache.kafka.common.Uuid; | ||
| import org.apache.kafka.image.MetadataImage; | ||
|
|
||
| import com.dynatrace.hash4j.hashing.Hashing; | ||
|
|
||
| import org.junit.jupiter.api.Test; | ||
| import org.junit.jupiter.params.ParameterizedTest; | ||
| import org.junit.jupiter.params.provider.Arguments; | ||
| import org.junit.jupiter.params.provider.MethodSource; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.LinkedHashMap; | ||
| import java.util.Map; | ||
| import java.util.stream.Stream; | ||
|
|
||
| import static org.junit.jupiter.api.Assertions.assertEquals; | ||
| import static org.junit.jupiter.api.Assertions.assertNotEquals; | ||
|
|
||
| public class UtilsTest { | ||
| private static final Uuid FOO_TOPIC_ID = Uuid.randomUuid(); | ||
| private static final String FOO_TOPIC_NAME = "foo"; | ||
| private static final String BAR_TOPIC_NAME = "bar"; | ||
| private static final int FOO_NUM_PARTITIONS = 2; | ||
| private static final MetadataImage FOO_METADATA_IMAGE = new MetadataImageBuilder() | ||
| .addTopic(FOO_TOPIC_ID, FOO_TOPIC_NAME, FOO_NUM_PARTITIONS) | ||
| .addRacks() | ||
| .build(); | ||
|
|
||
| @Test | ||
| void testComputeTopicHash() throws IOException { | ||
| long result = Utils.computeTopicHash(FOO_METADATA_IMAGE.topics().getTopic(FOO_TOPIC_ID), FOO_METADATA_IMAGE.cluster()); | ||
|
||
|
|
||
| long expected = Hashing.xxh3_64().hashStream() | ||
| .putByte((byte) 0) // magic byte | ||
| .putLong(FOO_TOPIC_ID.hashCode()) // topic ID | ||
| .putString(FOO_TOPIC_NAME) // topic name | ||
| .putInt(FOO_NUM_PARTITIONS) // number of partitions | ||
| .putInt(0) // partition 0 | ||
| .putInt(5) // length of rack0 | ||
| .putString("rack0") // The first rack in partition 0 | ||
| .putInt(5) // length of rack1 | ||
| .putString("rack1") // The second rack in partition 0 | ||
| .putInt(1) // partition 1 | ||
| .putInt(5) // length of rack0 | ||
| .putString("rack1") // The first rack in partition 1 | ||
| .putInt(5) // length of rack1 | ||
| .putString("rack2") // The second rack in partition 1 | ||
| .getAsLong(); | ||
| assertEquals(expected, result); | ||
| } | ||
|
|
||
| @Test | ||
| void testComputeTopicHashWithDifferentMagicByte() throws IOException { | ||
| long result = Utils.computeTopicHash(FOO_METADATA_IMAGE.topics().getTopic(FOO_TOPIC_ID), FOO_METADATA_IMAGE.cluster()); | ||
|
|
||
| long expected = Hashing.xxh3_64().hashStream() | ||
| .putByte((byte) 1) // magic byte | ||
| .putLong(FOO_TOPIC_ID.hashCode()) // topic ID | ||
| .putString(FOO_TOPIC_NAME) // topic name | ||
| .putInt(FOO_NUM_PARTITIONS) // number of partitions | ||
| .putInt(0) // partition 0 | ||
| .putInt(5) // length of rack0 | ||
| .putString("rack0") // The first rack in partition 0 | ||
| .putInt(5) // length of rack1 | ||
| .putString("rack1") // The second rack in partition 0 | ||
| .putInt(1) // partition 1 | ||
| .putInt(5) // length of rack0 | ||
| .putString("rack1") // The first rack in partition 1 | ||
| .putInt(5) // length of rack1 | ||
| .putString("rack2") // The second rack in partition 1 | ||
| .getAsLong(); | ||
| assertNotEquals(expected, result); | ||
| } | ||
|
|
||
| @Test | ||
| void testComputeTopicHashWithDifferentPartitionOrder() throws IOException { | ||
| long result = Utils.computeTopicHash(FOO_METADATA_IMAGE.topics().getTopic(FOO_TOPIC_ID), FOO_METADATA_IMAGE.cluster()); | ||
|
|
||
| long expected = Hashing.xxh3_64().hashStream() | ||
| .putByte((byte) 1) // magic byte | ||
| .putLong(FOO_TOPIC_ID.hashCode()) // topic ID | ||
| .putString(FOO_TOPIC_NAME) // topic name | ||
| .putInt(FOO_NUM_PARTITIONS) // number of partitions | ||
| .putInt(1) // partition 1 | ||
| .putInt(5) // length of rack0 | ||
| .putString("rack1") // The first rack in partition 1 | ||
| .putInt(5) // length of rack1 | ||
| .putString("rack2") // The second rack in partition 1 | ||
| .putInt(0) // partition 0 | ||
| .putInt(5) // length of rack0 | ||
| .putString("rack0") // The first rack in partition 0 | ||
| .putInt(5) // length of rack1 | ||
| .putString("rack1") // The second rack in partition 0 | ||
| .getAsLong(); | ||
| assertNotEquals(expected, result); | ||
| } | ||
|
|
||
| @Test | ||
| void testComputeTopicHashWithDifferentRackOrder() throws IOException { | ||
| long result = Utils.computeTopicHash(FOO_METADATA_IMAGE.topics().getTopic(FOO_TOPIC_ID), FOO_METADATA_IMAGE.cluster()); | ||
|
|
||
| long expected = Hashing.xxh3_64().hashStream() | ||
| .putByte((byte) 0) // magic byte | ||
| .putLong(FOO_TOPIC_ID.hashCode()) // topic ID | ||
| .putString(FOO_TOPIC_NAME) // topic name | ||
| .putInt(FOO_NUM_PARTITIONS) // number of partitions | ||
| .putInt(0) // partition 0 | ||
| .putInt(5) // length of rack0 | ||
| .putString("rack1") // The second rack in partition 0 | ||
| .putInt(5) // length of rack1 | ||
| .putString("rack0") // The first rack in partition 0 | ||
| .putInt(1) // partition 1 | ||
| .putInt(5) // length of rack0 | ||
| .putString("rack1") // The first rack in partition 1 | ||
| .putInt(5) // length of rack1 | ||
| .putString("rack2") // The second rack in partition 1 | ||
| .getAsLong(); | ||
| assertNotEquals(expected, result); | ||
| } | ||
|
|
||
| @ParameterizedTest | ||
| @MethodSource("differentFieldGenerator") | ||
| void testComputeTopicHashWithDifferentField(MetadataImage differentImage, Uuid topicId) throws IOException { | ||
| long result = Utils.computeTopicHash(FOO_METADATA_IMAGE.topics().getTopic(FOO_TOPIC_ID), FOO_METADATA_IMAGE.cluster()); | ||
|
|
||
| assertNotEquals( | ||
| Utils.computeTopicHash( | ||
| differentImage.topics().getTopic(topicId), | ||
| differentImage.cluster() | ||
| ), | ||
| result | ||
| ); | ||
| } | ||
|
|
||
| private static Stream<Arguments> differentFieldGenerator() { | ||
| Uuid differentTopicId = Uuid.randomUuid(); | ||
| return Stream.of( | ||
| Arguments.of(new MetadataImageBuilder() // different topic id | ||
| .addTopic(differentTopicId, FOO_TOPIC_NAME, FOO_NUM_PARTITIONS) | ||
| .addRacks() | ||
| .build(), | ||
| differentTopicId | ||
| ), | ||
|
||
| Arguments.of(new MetadataImageBuilder() // different topic name | ||
| .addTopic(FOO_TOPIC_ID, "bar", FOO_NUM_PARTITIONS) | ||
| .addRacks() | ||
| .build(), | ||
| FOO_TOPIC_ID | ||
| ), | ||
| Arguments.of(new MetadataImageBuilder() // different partitions | ||
| .addTopic(FOO_TOPIC_ID, FOO_TOPIC_NAME, 1) | ||
| .addRacks() | ||
| .build(), | ||
| FOO_TOPIC_ID | ||
| ), | ||
| Arguments.of(new MetadataImageBuilder() // different racks | ||
| .addTopic(FOO_TOPIC_ID, FOO_TOPIC_NAME, FOO_NUM_PARTITIONS) | ||
| .build(), | ||
| FOO_TOPIC_ID | ||
| ) | ||
| ); | ||
| } | ||
|
|
||
| @Test | ||
| void testComputeGroupHashWithDifferentOrder() { | ||
| Map<String, Long> ascendTopicHashes = new LinkedHashMap<>(); | ||
| ascendTopicHashes.put(BAR_TOPIC_NAME, 123L); | ||
| ascendTopicHashes.put(FOO_TOPIC_NAME, 456L); | ||
|
|
||
| Map<String, Long> descendTopicHashes = new LinkedHashMap<>(); | ||
| descendTopicHashes.put(FOO_TOPIC_NAME, 456L); | ||
| descendTopicHashes.put(BAR_TOPIC_NAME, 123L); | ||
| assertEquals(Utils.computeGroupHash(ascendTopicHashes), Utils.computeGroupHash(descendTopicHashes)); | ||
| } | ||
|
|
||
| @Test | ||
| void testComputeGroupHashWithSameKeyButDifferentValue() { | ||
| Map<String, Long> map1 = Map.of( | ||
| BAR_TOPIC_NAME, 123L, | ||
| FOO_TOPIC_NAME, 456L | ||
| ); | ||
|
|
||
| Map<String, Long> map2 = Map.of( | ||
| BAR_TOPIC_NAME, 456L, | ||
| FOO_TOPIC_NAME, 123L | ||
| ); | ||
| assertNotEquals(Utils.computeGroupHash(map1), Utils.computeGroupHash(map2)); | ||
| } | ||
| } | ||
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.
Do we need this change?
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.
Removed it. Thanks.