Feature/improvement brainstorming

ivoanjo / gvl-tracing

Get a timeline view of Global VM Lock usage in your Ruby app

MIT License

114 stars 7 forks source link

Feature/improvement brainstorming #13

Open ivoanjo opened 1 year ago

ivoanjo commented 1 year ago

I've spent some time thinking about potential improvements to gvl-tracing, and decided to record it here. If anyone's interested in tackling them, feel free to ask for details!

(Medium) Create a wrapper command to run some other Ruby command with gvl-tracing:
```
$ bundle exec gvl-tracing ruby some-example.rb
```
(Medium) Add support for producing data in a format readable by the Firefox Profiler or Speedscope. Both provide interesting alternatives to perfetto and seem to be easier to integrate/share data with.

Apparently Firefox Profiler is supposed to be able to read the perfetto format, but I can't get it to open the gvl-tracing output. Maybe there's some subtle detail that it doesn't like?

Update: Early prototype in https://github.com/ivoanjo/gvl-tracing/pull/16 :)
(Easy) Add tests! Because I built this gem as an experiment over a few nights and weekends, it was small enough that I could get away without a test suite. I would mega appreciate if someone helped change that :)

benoittgt commented 1 year ago

For the test do you have something in mind? I thought about something simple base on examples folder + partial match of the output. More like integration testing.

Love this menu.

ivoanjo commented 1 year ago

Yes, I was thinking along those lines of having small code blocks to try to exercise the gem with something that produces only a few events, and then parse the output and see if it looks reasonable.

benoittgt commented 1 year ago

Also another idea, will be to script the examples generation + json compacting.

ivoanjo commented 1 year ago

Also another idea, will be to script the examples generation + json compacting.

+1 Yeah, that would be cool as indeed right now whenever we change something the examples can become outdated.

ivoanjo commented 1 year ago

Updated list of tasks now that #12 and #14 fix some of them :)

ivoanjo commented 9 months ago

Added reference to https://github.com/ruby/ruby/pull/8885 since we can use it to solve the thread reuse issue :)

jpcamara commented 8 months ago

Hi there 🙋🏻‍♂️! I'll be submitting some PRs to:

Add some specs
Attempt Firefox profiler support (it's a little tricky but I do have it loading in the profiler)
Fix Ruby 3.3 support - because the parent thread can fire the events now, getting the current thread id causes the timeline to show the Main thread as starting multiple times and the other threads never show as starting

Should have at least the specs up in the next day or so.

ivoanjo commented 8 months ago

THAT IS AMAZING AND I CAN'T WAIT!

I'll add the caveat that I moved houses the past weekend and I may take a bit to review stuff, but I definitely want to :)

jpcamara commented 8 months ago

THAT IS AMAZING AND I CAN'T WAIT!

I'll add the caveat that I moved houses the past weekend and I may take a bit to review stuff, but I definitely want to :)

Haha understandable! I'm sure it'll take me a bit to get everything through anyways. Good luck with the post-move tasks 🫡

jpcamara commented 8 months ago

First PR for specs, including a bug fix for the block form of start: https://github.com/ivoanjo/gvl-tracing/pull/15 🎉. It only covers Ruby 3.2 atm, Ruby 3.3 will be upcoming.

jpcamara commented 8 months ago

I haven't lost sight of the 3.3 updates btw! I'm finishing up some work on MN thread support for Mac in Ruby (https://github.com/ruby/ruby/pull/9178) then I'll open a 3.3 PR here

ivoanjo commented 8 months ago

Sounds great :bow:!

ivoanjo commented 4 months ago

Updated list of ideas after 1.5.0 release! :)