Add ability to profile commands via CLI #116
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
fatkodima
commented
Jun 16, 2024
| ``` | ||
| $ ruby-memory-profiler [options] <script.rb> [--] [script-options] |
There was a problem hiding this comment.
CLI allows to profile single files or whole command. Since single files can be profiled as commands via simply ... ruby script.rb ..., I removed that ability from the readme to make it less confusing and for people to use the unified style.
Comment on lines
-17
to
-24
| REPORTER_KEYS = [ | ||
| :top, :trace, :ignore_files, :allow_files | ||
| ].freeze | ||
|
|
||
| RESULTS_KEYS = [ | ||
| :to_file, :color_output, :retained_strings, :allocated_strings, | ||
| :detailed_report, :scale_bytes, :normalize_paths | ||
| ].freeze |
There was a problem hiding this comment.
This separation is really not needed and only complicates the code.
|
CI is red not because of this PR changes - needs to be fixed separately. |
Merged
|
I like this change a lot, merging |
|
The base64 gem needs to be added to the gemspec. It will not be a default gem anymore in Ruby 3.4, for RuboCops head CI this causes a failure like this: rubocop/rubocop#13002 |
This was referenced Jun 17, 2024
Merged
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.
Closes #113.
Closes #114.
Currently, the CLI allows to profile only ruby files. But when you want to profile a whole ruby command for its entire lifetime, it's a bit complicated to find the proper entry point and exit point to insert
MemoryProfiler.startetc.This PR extends the CLI to allow to do this easily, e.g:
Or for profiling a Rails application boot sequence:
Or a user's rake task: