Add start/stop and options to README #68
Conversation
joshuay03
force-pushed
the
update-readme
branch
2 times, most recently
from
9eff8ef to
b2166b0
Compare
| @@ -68,6 +86,14 @@ ruby -r vernier -e 'Vernier.trace_retained(out: "irb_profile.json") { require "i | |||
|
|
|||
| Retained-memory flamegraphs must be interpreted a little differently than a typical profiling flamegraph. In a retained-memory flamegraph, the x-axis represents a proportion of memory in bytes, _not time or samples_ The topmost boxes on the y-axis represent the retained objects, with their stacktrace below; their width represents the percentage of overall retained memory each object occupies. | |||
|
|
|||
| ### Options | |||
There was a problem hiding this comment.
Wasn't sure if we wanted to add hooks here. The only one I could find seems to be more of an private hook for supporting Rails, and this implies it's a private API.
There was a problem hiding this comment.
I imagine having more hooks and user supplied hooks, but I'm not quite sure the best API for it yet
There was a problem hiding this comment.
Best to hold off on adding it to the README then?
|
|
||
| Option | Description | ||
| :- | :- | ||
| `mode` | The sampling mode to use. One of `:wall`, `:retained` or `:custom`. Default is `:wall`. |
There was a problem hiding this comment.
I'm not really sure how the custom collector is meant to be used, I'm guessing the native implementation is meant to be extended? Let me know if it shouldn't be included here just yet / if there's more information that can be added.
There was a problem hiding this comment.
I'm guessing nobody has used it, and I'd probably implement it differently today, the intention was to be like stackprof's :custom mode where you call StackProf.sample at times you want to measure.
There was a problem hiding this comment.
Ah right. Similar to the hooks, I'll remove the :custom option from this list for now and it can be added in once implementation has been finalised.
|
@joshuay03 Thanks again for the improvements, I sent you a commit bit if you'd like to do more. It was great to see you at RubyKaigi! |
It was great to meet you too. And thank you very much, I appreciate it. I'd love to help out more! |
I'm uncertain about a few changes, see comments.