-
Notifications
You must be signed in to change notification settings - Fork 14.3k
KAFKA-17503: Fix incorrect calculation of poll-idle-ratio-avg for con… #17139
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
Open
srdo
wants to merge
4
commits into
apache:trunk
Choose a base branch
from
srdo:idle-ratio-fix
base: trunk
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+221
−48
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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
87 changes: 87 additions & 0 deletions
87
clients/src/main/java/org/apache/kafka/clients/consumer/internals/metrics/TimeRatio2.java
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,87 @@ | ||
/* | ||
* 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.consumer.internals.metrics; | ||
|
||
import org.apache.kafka.common.metrics.Sensor; | ||
|
||
/** | ||
* Maintains a ratio of the duration of a periodic event | ||
* over a rolling fixed-size window, emitting the measured ratio to the specified sensor for each window. | ||
* For example, this can be used to compute the ratio of | ||
* time that a thread is busy or idle. | ||
*/ | ||
public class TimeRatio2 { | ||
|
||
private final long windowSizeMs; | ||
private final Sensor sensor; | ||
private long lastWindowEndMs; | ||
private long msSpentInEventInCurrentWindow; | ||
private long msSpentOutsideEventInCurrentWindow; | ||
private long lastEventStartMs; | ||
private long lastEventEndMs; | ||
|
||
public TimeRatio2(long windowSizeMs, Sensor sensor) { | ||
if (windowSizeMs < 0.0) { | ||
throw new IllegalArgumentException("Invalid window size: value " + windowSizeMs + " is less than 0."); | ||
} | ||
this.windowSizeMs = windowSizeMs; | ||
this.sensor = sensor; | ||
} | ||
|
||
private void updateWindow(long nowMs, long msSpentInEvent, long msSpentOutsideEvent) { | ||
long msSinceLastSamplingIntervalEnd = nowMs - this.lastWindowEndMs; | ||
if (msSinceLastSamplingIntervalEnd < this.windowSizeMs) { | ||
// We can't fill a window yet, so just add the last event's millis to the counters | ||
this.msSpentInEventInCurrentWindow += msSpentInEvent; | ||
this.msSpentOutsideEventInCurrentWindow += msSpentOutsideEvent; | ||
} else { | ||
// We can fill at least one window. | ||
// Add millis from the last event to fill this window and flush the ratio to the sensor, | ||
// then start a new window with any remaining millis we couldn't fit in the flushed window. | ||
// As each event period starts with "inside event" time and ends with "outside event" time, | ||
// we prefer to insert "inside event" time into the window first. | ||
long missingMsToCompleteWindow = this.windowSizeMs - (this.msSpentInEventInCurrentWindow + this.msSpentOutsideEventInCurrentWindow); | ||
long inEventMsFittingInWindow = Math.min(missingMsToCompleteWindow, msSpentInEvent); | ||
long outsideEventMsFittingInWindow = missingMsToCompleteWindow - inEventMsFittingInWindow; | ||
|
||
double eventRatio = (this.msSpentInEventInCurrentWindow + inEventMsFittingInWindow) * 1.0 / this.windowSizeMs; | ||
long currentWindowEndMs = this.lastWindowEndMs + this.windowSizeMs; | ||
this.sensor.record(eventRatio, currentWindowEndMs); | ||
|
||
this.msSpentInEventInCurrentWindow = 0; | ||
this.msSpentOutsideEventInCurrentWindow = 0; | ||
this.lastWindowEndMs = currentWindowEndMs; | ||
updateWindow(nowMs, msSpentInEvent - inEventMsFittingInWindow, msSpentOutsideEvent - outsideEventMsFittingInWindow); | ||
} | ||
} | ||
|
||
public void recordEventStart(long nowMs) { | ||
if (this.lastWindowEndMs == 0) { | ||
this.lastWindowEndMs = nowMs; | ||
} else { | ||
long msSpentInEvent = this.lastEventEndMs - this.lastEventStartMs; | ||
long msSpentOutsideEvent = nowMs - this.lastEventEndMs; | ||
updateWindow(nowMs, msSpentInEvent, msSpentOutsideEvent); | ||
} | ||
this.lastEventStartMs = nowMs; | ||
} | ||
|
||
public void recordEventEnd(long nowMs) { | ||
this.lastEventEndMs = nowMs; | ||
} | ||
|
||
} |
Oops, something went wrong.
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.
I'm a bit unsure whether it would be better to select a smaller time window here. The defaults for the metrics system is a window of 30 seconds, which is a bit large for this purpose, and it also only keeps 2 samples. It might make sense to aim for e.g. a sample every few seconds, or 1/5th the window size the metric system uses, or something like that.