-
Notifications
You must be signed in to change notification settings - Fork 962
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
Reduce memory footprint of StepBucketHistogram #4955
Open
lenin-jaganathan
wants to merge
2
commits into
micrometer-metrics:1.11.x
Choose a base branch
from
lenin-jaganathan:reducy_histogram_memory_usage
base: 1.11.x
Could not load branches
Branch not found: {{ refName }}
Could not load tags
Nothing to show
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.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains 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 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
89 changes: 89 additions & 0 deletions
89
.../src/test/java/io/micrometer/core/instrument/distribution/FixedBoundaryHistogramTest.java
This file contains 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,89 @@ | ||
/* | ||
* Copyright 2024 VMware, Inc. | ||
* | ||
* Licensed 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 | ||
* | ||
* https://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 io.micrometer.core.instrument.distribution; | ||
|
||
import static org.assertj.core.api.Assertions.assertThat; | ||
|
||
import java.util.stream.Stream; | ||
|
||
import org.junit.jupiter.api.BeforeEach; | ||
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; | ||
|
||
class FixedBoundaryHistogramTest { | ||
|
||
private static final double[] BUCKET_BOUNDS = new double[] { 1, 10, 100 }; | ||
|
||
private FixedBoundaryHistogram fixedBoundaryHistogram; | ||
|
||
@BeforeEach | ||
void setup() { | ||
fixedBoundaryHistogram = new FixedBoundaryHistogram(BUCKET_BOUNDS, false); | ||
} | ||
|
||
@Test | ||
void testGetBuckets() { | ||
assertThat(fixedBoundaryHistogram.getBuckets()).containsExactly(BUCKET_BOUNDS); | ||
} | ||
|
||
@ParameterizedTest | ||
@MethodSource("valuedIndexProvider") | ||
void testLeastLessThanOrEqualTo(long value, int expectedIndex) { | ||
assertThat(fixedBoundaryHistogram.leastLessThanOrEqualTo(value)).isEqualTo(expectedIndex); | ||
} | ||
|
||
private static Stream<Arguments> valuedIndexProvider() { | ||
return Stream.of(Arguments.of(0, 0), Arguments.of(1, 0), Arguments.of(2, 1), Arguments.of(5, 1), | ||
Arguments.of(10, 1), Arguments.of(11, 2), Arguments.of(90, 2), Arguments.of(100, 2), | ||
Arguments.of(101, -1), Arguments.of(Long.MAX_VALUE, -1)); | ||
} | ||
|
||
@Test | ||
void testReset() { | ||
fixedBoundaryHistogram.record(1); | ||
fixedBoundaryHistogram.record(10); | ||
fixedBoundaryHistogram.record(100); | ||
assertThat(fixedBoundaryHistogram.getCountsAtBucket()).allMatch(countAtBucket -> countAtBucket.count() == 1); | ||
fixedBoundaryHistogram.reset(); | ||
assertThat(fixedBoundaryHistogram.getCountsAtBucket()).allMatch(countAtBucket -> countAtBucket.count() == 0); | ||
} | ||
|
||
@Test | ||
void testCountsAtBucket() { | ||
fixedBoundaryHistogram.record(1); | ||
fixedBoundaryHistogram.record(10); | ||
fixedBoundaryHistogram.record(100); | ||
assertThat(fixedBoundaryHistogram.getCountsAtBucket()).allMatch(countAtBucket -> countAtBucket.count() == 1); | ||
fixedBoundaryHistogram.reset(); | ||
assertThat(fixedBoundaryHistogram.getCountsAtBucket()).allMatch(countAtBucket -> countAtBucket.count() == 0); | ||
fixedBoundaryHistogram.record(0); | ||
assertThat(fixedBoundaryHistogram.getCountsAtBucket()).containsExactly(new CountAtBucket(1.0, 1), | ||
new CountAtBucket(10.0, 0), new CountAtBucket(100.0, 0)); | ||
} | ||
|
||
@Test | ||
void testCumulativeCounts() { | ||
fixedBoundaryHistogram = new FixedBoundaryHistogram(BUCKET_BOUNDS, true); | ||
fixedBoundaryHistogram.record(1); | ||
fixedBoundaryHistogram.record(10); | ||
fixedBoundaryHistogram.record(100); | ||
assertThat(fixedBoundaryHistogram.getCountsAtBucket()).containsExactly(new CountAtBucket(1.0, 1), | ||
new CountAtBucket(10.0, 2), new CountAtBucket(100.0, 3)); | ||
} | ||
|
||
} |
This file contains 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
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.
Can we just use
getCountsAtBucket()
instead of this? This makes a call tocountAtBucket()
for every bucket which in turn does a binary search to find the bucket. It makes sense if we need to get the counts for only a subset of buckets, but we don't do that anywhere (why would we even do that?). But at the end, all we need is a continuous list of buckets and their count which we can get by iterating on the values directly.There were a few issues solved around this area hence not changing anything at this point. But,
my claim would be the
buckets
would not change after the histogram is created so we should always rely on the buckets from the underlying implementation (in this case FixedBucketHistogram).