Refactor structure of stats module #736
Merged
Conversation
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
Removes valid stats arg from KNNStatsRequest. Valid stats is a global constant so there is not a good reason to make it configurable. It is still written in and out of the stream. This is to prevent breakage in any kind of backwards compatibility. Signed-off-by: John Mazanec <jmazane@amazon.com>
Removes KNNStatsConfig class and moves logic directly into the KNNStats class. KNNStatsConfig just hosted a single map of the stats, so it felt unneccessary to have the whole class. Signed-off-by: John Mazanec <jmazane@amazon.com>
navneet1v
reviewed
Jan 20, 2023
| public class StatsIT extends AbstractRollingUpgradeTestCase { | ||
| private KNNStats knnStats = new KNNStats(KNN_STATS); | ||
| private KNNStats knnStats = new KNNStats(); |
There was a problem hiding this comment.
if you want to init this KNNStats the better way to do is using a function having with annotation @before on top of it.
| @@ -75,4 +76,73 @@ private Map<String, KNNStat<?>> getClusterOrNodeStats(Boolean getClusterStats) { | |||
| } | |||
| return statsMap; | |||
| } | |||
|
|
|||
| private Map<String, KNNStat<?>> buildStatsMap() { | |||
| return ImmutableMap.<String, KNNStat<?>>builder() | |||
There was a problem hiding this comment.
let's break this function into smaller chunks of private functions which tells what stats we are adding. So that it becomes easier to debug and read.
| @@ -23,8 +24,7 @@ public class KNNStatsRequest extends BaseNodesRequest<KNNStatsRequest> { | |||
| * Key indicating all stats should be retrieved | |||
| */ | |||
| public static final String ALL_STATS_KEY = "_all"; | |||
|
|
|||
| private Set<String> validStats; | |||
| private Set<String> validStats = StatNames.getNames(); | |||
There was a problem hiding this comment.
init this variable via constructor rather than here, this will help us mock things later on if required.
|
There is NPE happening in one of the Tests. please fix that too. |
Codecov Report
@@ Coverage Diff @@
## main #736 +/- ##
============================================
- Coverage 84.85% 84.85% -0.01%
- Complexity 1074 1075 +1
============================================
Files 152 151 -1
Lines 4364 4370 +6
Branches 390 390
============================================
+ Hits 3703 3708 +5
+ Misses 483 482 -1
- Partials 178 180 +2
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
Signed-off-by: John Mazanec <jmazane@amazon.com>
cf122bb to
c7844ed
Compare
navneet1v
approved these changes
Jan 23, 2023
martin-gaievski
approved these changes
Jan 23, 2023
|
The backport to To backport manually, run these commands in your terminal: # Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-2.x 2.x
# Navigate to the new working tree
cd .worktrees/backport-2.x
# Create a new branch
git switch --create backport/backport-736-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 185b54daee1f9009c7a67dfa24adb153cfdcd160
# Push it to GitHub
git push --set-upstream origin backport/backport-736-to-2.x
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-2.xThen, create a pull request where the |
jmazanec15
added a commit
to jmazanec15/k-NN-1
that referenced
this pull request
Jan 23, 2023
Removes valid stats arg from KNNStatsRequest. Valid stats is a global constant so there is not a good reason to make it configurable. It is still written in and out of the stream. This is to prevent breakage in any kind of backwards compatibility. Removes KNNStatsConfig class and moves logic directly into the KNNStats class. KNNStatsConfig just hosted a single map of the stats, so it felt unneccessary to have the whole class. Signed-off-by: John Mazanec <jmazane@amazon.com> (cherry picked from commit 185b54d)
1 task
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Removes KNNStatsConfig structure. This structure only had a single static variable. Moved the logic directly into the KNNStats class into a private non-static method. This will allow us to pass dependencies into stats during construction as opposed to have to initialize them statically.
Modifies KNNStatsRequest to not take validStats as an argument. Valid stats are the same every time so I dont see reason for making this configurable. Kept the stream logic to prevent break in bwc.
Issues Resolved
[List any issues this PR will resolve]
Check List
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.