kevin-wu24 commented on code in PR #22669: URL: https://github.com/apache/kafka/pull/22669#discussion_r3546345713
########## raft/src/testFixtures/java/org/apache/kafka/raft/RaftClientBenchmarkContext.java: ########## @@ -0,0 +1,272 @@ +/* + * 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.raft; + +import org.apache.kafka.common.Uuid; +import org.apache.kafka.common.protocol.ApiKeys; +import org.apache.kafka.raft.RaftClientTestContext.RaftProtocol; +import org.apache.kafka.server.common.KRaftVersion; + +import java.util.Arrays; +import java.util.Comparator; +import java.util.List; +import java.util.Optional; +import java.util.concurrent.ThreadLocalRandom; +import java.util.stream.Collectors; +import java.util.stream.IntStream; + +public final class RaftClientBenchmarkContext { + // Standardized JMH iteration counts, shared by all raft benchmarks so every benchmark of a given + // mode is configured identically. + + // SingleShotTime measures a single operation per iteration, so it needs many iterations to build + // a stable distribution. + public static final int SINGLE_SHOT_WARMUP_ITERATIONS = 50; + public static final int SINGLE_SHOT_MEASUREMENT_ITERATIONS = 30; + public static final int SINGLE_SHOT_FORKS = 5; + + // AverageTime averages many operations within each timed iteration, so it needs fewer. + public static final int AVERAGE_TIME_WARMUP_ITERATIONS = 5; + public static final int AVERAGE_TIME_MEASUREMENT_ITERATIONS = 10; + public static final int AVERAGE_TIME_FORKS = 3; + + // Default to the newest version of each (the highest-ordinal enum constant). Enum natural order + // is ordinal order, so this picks the last-declared constant; relies on the constants being + // declared oldest-to-newest, which avoids updating these when a new version is added. + public static final KRaftVersion DEFAULT_KRAFT_VERSION = + Arrays.stream(KRaftVersion.values()).max(Comparator.naturalOrder()).orElseThrow(); + public static final RaftProtocol DEFAULT_RAFT_PROTOCOL = + Arrays.stream(RaftProtocol.values()).max(Comparator.naturalOrder()).orElseThrow(); + + private final RaftClientTestContext context; + private final MockLog log; + private final MockNetworkChannel channel; + + private final List<ReplicaKey> startingVoters; + private final List<ReplicaKey> startingObservers; + + // Each tracks one cumulative mock counter as a drainable delta against a baseline. The baseline is + // snapshotted at construction and re-baselined by zeroCountersOnSetup() at the end of benchmark setup. + private final DrainableCounter logFlushes; + private final DrainableCounter logReads; + private final DrainableCounter logTruncations; + private final DrainableCounter rpcRequestsSent; + private final DrainableCounter quorumStateWrites; + private final DrainableCounter quorumStateReads; + + private RaftClientBenchmarkContext( + RaftClientTestContext context, + List<ReplicaKey> startingVoters, + List<ReplicaKey> startingObservers + ) { + this.context = context; + this.log = context.log; + this.channel = context.channel; + this.startingVoters = List.copyOf(startingVoters); + this.startingObservers = List.copyOf(startingObservers); + this.logFlushes = new DrainableCounter(log::flushCount); + this.logReads = new DrainableCounter(log::readCount); + this.logTruncations = new DrainableCounter(log::truncationCount); + this.rpcRequestsSent = new DrainableCounter(channel::requestsSent); + this.quorumStateWrites = new DrainableCounter(context::quorumStateWriteCount); + this.quorumStateReads = new DrainableCounter(context::quorumStateReadCount); + } + + /** + * Builds a local, unattached node in a {@code voterCount}-node cluster (the local node is not yet + * the leader). Use {@link RaftClientTestContext#unattachedToLeader()} on {@link #testContext()} as + * the measured operation to drive a full Unattached → Leader election. A single-voter cluster + * is rejected because such a node elects itself at initialization, before any measured poll. + */ + public static RaftClientBenchmarkContext unattached(int voterCount) throws Exception { + return unattached(voterCount, DEFAULT_KRAFT_VERSION, DEFAULT_RAFT_PROTOCOL); + } + + public static RaftClientBenchmarkContext unattached( + int voterCount, + KRaftVersion kraftVersion, + RaftProtocol raftProtocol + ) throws Exception { + if (voterCount < 2) { + throw new IllegalArgumentException("voterCount must be at least 2; a single voter self-elects at init"); + } + List<ReplicaKey> voterKeys = replicaKeys(randomReplicaId(), voterCount); + return new RaftClientBenchmarkContext( + buildContext(voterKeys, kraftVersion, raftProtocol), voterKeys, List.of()); + } + + public static RaftClientBenchmarkContext leader(int voterCount) throws Exception { + return leader(voterCount, 0, DEFAULT_KRAFT_VERSION, DEFAULT_RAFT_PROTOCOL); + } + + public static RaftClientBenchmarkContext leader(int voterCount, int observerCount) throws Exception { + return leader(voterCount, observerCount, DEFAULT_KRAFT_VERSION, DEFAULT_RAFT_PROTOCOL); + } + + /** + * Builds a leader in a cluster of {@code voterCount} voters and {@code observerCount} observers. + */ + public static RaftClientBenchmarkContext leader( + int voterCount, + int observerCount, + KRaftVersion kraftVersion, + RaftProtocol raftProtocol + ) throws Exception { + if (voterCount < 1) { + throw new IllegalArgumentException("voterCount must be at least 1 (the local leader is a voter)"); + } + int localId = randomReplicaId(); + List<ReplicaKey> voterKeys = replicaKeys(localId, voterCount); + List<ReplicaKey> observerKeys = replicaKeys(localId + voterCount, observerCount); + RaftClientTestContext context = buildContext(voterKeys, kraftVersion, raftProtocol); + context.unattachedToLeader(); + + return new RaftClientBenchmarkContext(context, voterKeys, observerKeys); + } + + /** + * {@code count} replica keys with consecutive ids starting at {@code startId}, each with a random + * directory id. + */ + private static List<ReplicaKey> replicaKeys(int startId, int count) { + return IntStream.range(0, count) + .mapToObj(i -> ReplicaKey.of(startId + i, Uuid.randomUuid())) + .collect(Collectors.toList()); + } + + private static int randomReplicaId() { + return ThreadLocalRandom.current().nextInt(1025); + } + + /** + * Initializes a local, unattached node in a cluster of {@code voterKeys} (first entry is the local + * node). + */ + private static RaftClientTestContext buildContext( + List<ReplicaKey> voterKeys, + KRaftVersion kraftVersion, + RaftProtocol raftProtocol + ) throws Exception { + ReplicaKey local = voterKeys.get(0); + VoterSet voters = VoterSetTestUtil.voterSet(voterKeys.stream()); + + return new RaftClientTestContext.Builder(local.id(), local.directoryId().get()) + .withStartingVoters(voters, kraftVersion) + .withRaftProtocol(raftProtocol) + .withPollIntervalMs(0) + .withUnknownLeader(0) + .build(); + } + + public RaftClientTestContext testContext() { + return context; + } + + /** The local node's log end offset. Kept here because the {@code log} field is package-private. */ + public long logEndOffset() { + return log.endOffset().offset(); + } + + /** + * The starting voters other than the local node, in voter-set order. May be empty (single-voter + * cluster). + */ + public List<ReplicaKey> remoteVoters() { + return startingVoters.subList(1, startingVoters.size()); + } Review Comment: Hmmm, this is another method which is true for the benchmarks we have written, but may not be true for all benchmarks we could write in the future. One thing to think about is: how do we represent our local node if we want it to be an observer? It doesn't look like we can do that currently. This method assumes the local node is a voter. ########## raft/src/testFixtures/java/org/apache/kafka/raft/RaftClientBenchmarkContext.java: ########## @@ -0,0 +1,272 @@ +/* + * 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.raft; + +import org.apache.kafka.common.Uuid; +import org.apache.kafka.common.protocol.ApiKeys; +import org.apache.kafka.raft.RaftClientTestContext.RaftProtocol; +import org.apache.kafka.server.common.KRaftVersion; + +import java.util.Arrays; +import java.util.Comparator; +import java.util.List; +import java.util.Optional; +import java.util.concurrent.ThreadLocalRandom; +import java.util.stream.Collectors; +import java.util.stream.IntStream; + +public final class RaftClientBenchmarkContext { + // Standardized JMH iteration counts, shared by all raft benchmarks so every benchmark of a given + // mode is configured identically. + + // SingleShotTime measures a single operation per iteration, so it needs many iterations to build + // a stable distribution. + public static final int SINGLE_SHOT_WARMUP_ITERATIONS = 50; + public static final int SINGLE_SHOT_MEASUREMENT_ITERATIONS = 30; + public static final int SINGLE_SHOT_FORKS = 5; + + // AverageTime averages many operations within each timed iteration, so it needs fewer. + public static final int AVERAGE_TIME_WARMUP_ITERATIONS = 5; + public static final int AVERAGE_TIME_MEASUREMENT_ITERATIONS = 10; + public static final int AVERAGE_TIME_FORKS = 3; + + // Default to the newest version of each (the highest-ordinal enum constant). Enum natural order + // is ordinal order, so this picks the last-declared constant; relies on the constants being + // declared oldest-to-newest, which avoids updating these when a new version is added. + public static final KRaftVersion DEFAULT_KRAFT_VERSION = + Arrays.stream(KRaftVersion.values()).max(Comparator.naturalOrder()).orElseThrow(); + public static final RaftProtocol DEFAULT_RAFT_PROTOCOL = + Arrays.stream(RaftProtocol.values()).max(Comparator.naturalOrder()).orElseThrow(); + + private final RaftClientTestContext context; + private final MockLog log; + private final MockNetworkChannel channel; + + private final List<ReplicaKey> startingVoters; + private final List<ReplicaKey> startingObservers; + + // Each tracks one cumulative mock counter as a drainable delta against a baseline. The baseline is + // snapshotted at construction and re-baselined by zeroCountersOnSetup() at the end of benchmark setup. + private final DrainableCounter logFlushes; + private final DrainableCounter logReads; + private final DrainableCounter logTruncations; + private final DrainableCounter rpcRequestsSent; + private final DrainableCounter quorumStateWrites; + private final DrainableCounter quorumStateReads; + + private RaftClientBenchmarkContext( + RaftClientTestContext context, + List<ReplicaKey> startingVoters, + List<ReplicaKey> startingObservers + ) { + this.context = context; + this.log = context.log; + this.channel = context.channel; + this.startingVoters = List.copyOf(startingVoters); + this.startingObservers = List.copyOf(startingObservers); + this.logFlushes = new DrainableCounter(log::flushCount); + this.logReads = new DrainableCounter(log::readCount); + this.logTruncations = new DrainableCounter(log::truncationCount); + this.rpcRequestsSent = new DrainableCounter(channel::requestsSent); + this.quorumStateWrites = new DrainableCounter(context::quorumStateWriteCount); + this.quorumStateReads = new DrainableCounter(context::quorumStateReadCount); + } + + /** + * Builds a local, unattached node in a {@code voterCount}-node cluster (the local node is not yet + * the leader). Use {@link RaftClientTestContext#unattachedToLeader()} on {@link #testContext()} as + * the measured operation to drive a full Unattached → Leader election. A single-voter cluster + * is rejected because such a node elects itself at initialization, before any measured poll. + */ + public static RaftClientBenchmarkContext unattached(int voterCount) throws Exception { + return unattached(voterCount, DEFAULT_KRAFT_VERSION, DEFAULT_RAFT_PROTOCOL); + } + + public static RaftClientBenchmarkContext unattached( Review Comment: This is actually an unattached voter node in KRaft. Unattached nodes could also be observers, but all of our factory methods for this class always instantiate the local node as a voter. This will not be true as we write more benchmarks (e.g. observer handling a fetch response). Voters in KRaft can be in all of the states: Candidate, Prospective, Leader, Resigned, Follower, and Unattached. However, observers can only be Unattached or Follower. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
