KAFKA-13888: Addition of Information in DescribeQuorumResponse about Voter Lag #12206
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,24 @@ | ||
| /* | ||
| * 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.clients.admin; | ||
|
|
||
| /** | ||
| * Options for {@link Admin#describeMetadataQuorum(DescribeMetadataQuorumOptions)} | ||
| */ | ||
| public class DescribeMetadataQuorumOptions extends AbstractOptions<DescribeMetadataQuorumOptions> { | ||
|
|
||
| } |
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,38 @@ | ||
| /* | ||
| * 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.clients.admin; | ||
|
|
||
| import org.apache.kafka.common.KafkaFuture; | ||
|
|
||
| /** | ||
| * The result of {@link Admin#describeMetadataQuorum(DescribeMetadataQuorumOptions)} | ||
| */ | ||
| public class DescribeMetadataQuorumResult { | ||
|
|
||
| private final KafkaFuture<QuorumInfo> quorumInfo; | ||
|
|
||
| DescribeMetadataQuorumResult(KafkaFuture<QuorumInfo> quorumInfo) { | ||
| this.quorumInfo = quorumInfo; | ||
| } | ||
|
|
||
| /** | ||
| * Returns a future containing the QuorumInfo | ||
| */ | ||
| public KafkaFuture<QuorumInfo> quorumInfo() { | ||
| return quorumInfo; | ||
| } | ||
| } |
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,149 @@ | ||
| /* | ||
| * 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.clients.admin; | ||
|
|
||
| import java.util.List; | ||
| import java.util.Objects; | ||
| import java.util.OptionalLong; | ||
|
|
||
| /** | ||
| * This is used to describe per-partition state in the DescribeQuorumResponse. | ||
|
Member
There was a problem hiding this comment. The reference to DescribeQuorumResponse is a bit weird here for our users. Could we to better describe what QuorumInfo represents?
Contributor
There was a problem hiding this comment. Yeah, I agree with this. Maybe we can just say that this class contains useful debugging state for KRaft replication.
Member
There was a problem hiding this comment. This comment may have been missed. |
||
| */ | ||
| public class QuorumInfo { | ||
| private final Integer leaderId; | ||
| private final List<ReplicaState> voters; | ||
| private final List<ReplicaState> observers; | ||
|
|
||
| QuorumInfo(Integer leaderId, List<ReplicaState> voters, List<ReplicaState> observers) { | ||
| this.leaderId = leaderId; | ||
| this.voters = voters; | ||
| this.observers = observers; | ||
| } | ||
|
|
||
| public Integer leaderId() { | ||
| return leaderId; | ||
| } | ||
|
|
||
| public List<ReplicaState> voters() { | ||
| return voters; | ||
| } | ||
|
|
||
| public List<ReplicaState> observers() { | ||
| return observers; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean equals(Object o) { | ||
| if (this == o) return true; | ||
| if (o == null || getClass() != o.getClass()) return false; | ||
| QuorumInfo that = (QuorumInfo) o; | ||
| return leaderId.equals(that.leaderId) | ||
| && voters.equals(that.voters) | ||
| && observers.equals(that.observers); | ||
| } | ||
|
|
||
| @Override | ||
| public int hashCode() { | ||
| return Objects.hash(leaderId, voters, observers); | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| return "QuorumInfo(" + | ||
| "leaderId=" + leaderId + | ||
| ", voters=" + voters.toString() + | ||
| ", observers=" + observers.toString() + | ||
|
Member
There was a problem hiding this comment. nit: I suppose that we could remove the |
||
| ')'; | ||
| } | ||
|
|
||
| public static class ReplicaState { | ||
| private final int replicaId; | ||
| private final long logEndOffset; | ||
| private final OptionalLong lastFetchTimeMs; | ||
| private final OptionalLong lastCaughtUpTimeMs; | ||
|
|
||
| ReplicaState() { | ||
| this(0, 0, OptionalLong.empty(), OptionalLong.empty()); | ||
| } | ||
|
|
||
| ReplicaState(int replicaId, long logEndOffset, | ||
| OptionalLong lastFetchTimeMs, OptionalLong lastCaughtUpTimeMs) { | ||
|
Member
There was a problem hiding this comment. nit: The code format seems a bit off here. I think that we would format like this: |
||
| this.replicaId = replicaId; | ||
| this.logEndOffset = logEndOffset; | ||
| this.lastFetchTimeMs = lastFetchTimeMs; | ||
| this.lastCaughtUpTimeMs = lastCaughtUpTimeMs; | ||
| } | ||
|
|
||
| /** | ||
| * Return the ID for this replica. | ||
| * @return The ID for this replica | ||
| */ | ||
| public int replicaId() { | ||
|
dajac marked this conversation as resolved.
Outdated
|
||
| return replicaId; | ||
| } | ||
|
|
||
| /** | ||
| * Return the logEndOffset known by the leader for this replica. | ||
| * @return The logEndOffset for this replica | ||
| */ | ||
| public long logEndOffset() { | ||
| return logEndOffset; | ||
| } | ||
|
|
||
| /** | ||
| * Return the lastFetchTime in milliseconds for this replica. | ||
| * @return The value of the lastFetchTime if known, empty otherwise | ||
| */ | ||
| public OptionalLong lastFetchTimeMs() { | ||
| return lastFetchTimeMs; | ||
| } | ||
|
|
||
| /** | ||
| * Return the lastCaughtUpTime in milliseconds for this replica. | ||
| * @return The value of the lastCaughtUpTime if known, empty otherwise | ||
| */ | ||
| public OptionalLong lastCaughtUpTimeMs() { | ||
| return lastCaughtUpTimeMs; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean equals(Object o) { | ||
| if (this == o) return true; | ||
| if (o == null || getClass() != o.getClass()) return false; | ||
| ReplicaState that = (ReplicaState) o; | ||
| return replicaId == that.replicaId | ||
| && logEndOffset == that.logEndOffset | ||
| && lastFetchTimeMs.equals(that.lastFetchTimeMs) | ||
| && lastCaughtUpTimeMs.equals(that.lastCaughtUpTimeMs); | ||
| } | ||
|
|
||
| @Override | ||
| public int hashCode() { | ||
| return Objects.hash(replicaId, logEndOffset, lastFetchTimeMs, lastCaughtUpTimeMs); | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| return "ReplicaState(" + | ||
| "replicaId=" + replicaId + | ||
| ", logEndOffset=" + logEndOffset + | ||
| ", lastFetchTimeMs=" + lastFetchTimeMs + | ||
| ", lastCaughtUpTimeMs=" + lastCaughtUpTimeMs + | ||
| ')'; | ||
| } | ||
| } | ||
| } | ||
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
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.
It is very common for API details to change during implementation. Once we're satisfied and ready to merge, we should update the KIP. Typically we would also send a message to the vote thread in case there are any concerns.
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.
I will update the KIP and the thread once this PR is approved to reflect the changes here.