ci: Track benchmarks with Bencher #1725
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
WalkthroughWalkthroughThe recent updates to GitHub workflows for a Rust project aim to streamline benchmarking processes. These changes involve job renaming, removal of specific jobs, and the addition of workflows dedicated to main branch and pull request benchmarks. The overall goal is to enhance clarity and efficiency in managing and analyzing benchmark results. Changes
Recent Review DetailsConfiguration used: CodeRabbit UI Files selected for processing (5)
Files skipped from review as they are similar to previous changes (5)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1725 +/- ##
==========================================
- Coverage 87.18% 87.17% -0.01%
==========================================
Files 149 149
Lines 15451 15451
==========================================
- Hits 13471 13470 -1
- Misses 1980 1981 +1 ☔ View full report in Codecov by Sentry. |
tusharmath
approved these changes
Apr 15, 2024
ssddOnTop
pushed a commit
that referenced
this pull request
May 2, 2024
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.
Summary:
@tusharmath these changes move Tailcall over to using Bencher for tracking both the
mainbranch micro-benchmarks and running micro-benchmarks on pull requests that have the labelci: benchmark. The results for PR runs will be posted as a comment on the pull request.The macro-benchmarks are not yet moved over until there is a
wrkadapter added to Bencher: bencherdev/bencher#347In order for things to work in the
tailcallhq/tailcallrepo, you will need to have theBENCHER_API_TOKENadded as a Repository secret. I believe this is already in place from #1441, but I just wanted to make sure 😃I have gone ahead and created a Threshold for the
mainbranch, thebenchmarking-runnertestbed, and theLatencymeasure (used by Criterion): https://bencher.dev/perf/tailcall/thresholds/1ff7a58c-8add-4a72-a759-bdeccbf6ffa1This will be used to detect performance regressions on the
mainbranch, and it will be cloned and used for all pull requests.Feel free to reconfigure this Threshold to suite you all's needs.
This is an overview of the benchmarking GitHub Actions files:
benchmark_main.yml: Runs the micro-benchmarks on pushes to themainbranchbenchmark_pr_run.yml: Runs the micro-benchmarks on PRs with the tagci: benchmarkand caches the resultsbenchmark_pr_track.yml: Posts the micro-benchmark cached results to the PR as a commentbenchmark.yml: Runs the macro-benchmarks on pushes tomainand PRs with theci: benchmarktagbenchmark_comment.yml: Posts the macro-benchmark results to the commit as a commentThe documentation for the strategy used to track micro-benchmarks for PRs in GitHub Actions can be found there: https://bencher.dev/docs/how-to/github-actions/#benchmark-fork-pr-and-upload-from-default-branch
Issue Reference(s):
Relates to: #436
Implements: #1300
Fixes: #1441
Build & Testing:
Testing this out requires changing the default branch for the repo, as required by
workflow_run, and usingubuntu-latestas theruns-ontestbed.I did this in my fork using the
bencher_mainbranch: https://github.com/epompeii/tailcall/tree/bencher_mainI also created a separate branch to test out creating a PR: https://github.com/epompeii/tailcall/tree/bencher_retry
This is the example pull request: epompeii#1
Which now includes a pull request comment made by Bencher with the micro-benchmark results: epompeii#1 (comment)
Again, my apologies for the hubris to not test things out the first time around. 🤦🏽♂️
cargo testsuccessfully../lint.sh --mode=fixto fix all linting issues raised by./lint.sh --mode=check.Checklist:
<type>(<optional scope>): <title>Summary by CodeRabbit