-
Notifications
You must be signed in to change notification settings - Fork 112
Create tool to automate reviews of metrics files #3620
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
Merged
alecgrieser
merged 24 commits into
FoundationDB:main
from
alecgrieser:metrics-compare-tool
Sep 24, 2025
Merged
Create tool to automate reviews of metrics files #3620
alecgrieser
merged 24 commits into
FoundationDB:main
from
alecgrieser:metrics-compare-tool
Sep 24, 2025
Conversation
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
…e rather than updating comment and use more accurate sha
This reverts commit 84ba2f3.
normen662
approved these changes
Sep 24, 2025
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.
Amazing!
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.
This adds an automatic tool to review metrics files. It should run as part of PRB and post back the results of computing the diff.
You can see a version of its sample output here: https://github.com/FoundationDB/fdb-record-layer/actions/runs/17975684135?pr=3620 That particular version was modified so that it would use
4.5.10.0
as the base branch. The extra queries there account for why there were so many identified in the analysis.The basic structure of the report is:
Those two categories of queries are separated out as we expect some amount of churn whenever a query plan changes, as it requires that there is some larger kind of planner change. When only the metrics change (particularly when there is a regression), that can be indicative of some kind of problem, as the planner may have done more work without seeing a better outcome.
One thing that I have not been able to test is the ability to post back comments to the PR because
pull_request
events don't have write access (even for comments). The current version usespull_request_target
to do that, which should be able to post comments back to the PR (including in-line comments), though I have not been able to test that. I did also look at using GitHub annotations, which would be more forgiving, but those have the downside of being limited to something like 10 in a single step as well as not supporting markdown formatting. So comments seem preferable if we can get them to work.