nodejs / llnode

An lldb plugin for Node.js and V8, which enables inspection of JavaScript states for insights into Node.js processes and their core dumps.
Other
1.15k stars 99 forks source link

Document User Journey #401

Open No9 opened 1 year ago

No9 commented 1 year ago

As per the general drive to document user journeys in node tooling this issue is to track the creation of an llnode tutorial as part of https://github.com/nodejs/diagnostics/issues/502

The next step would be to review content that is already available and map out a tutorial structure This post may be a reasonable starting point. https://developer.ibm.com/articles/explore-nodejs-core-dumps-using-the-llnode-plugin-for-lldb/

tony-go commented 1 year ago

I'll pick that one ^^ 👋

tony-go commented 1 year ago

Update: I didn't start it at the moment.

I'm trying to finish and release this one: https://github.com/nodejs/diagnostics/pull/572

Then I'll jump on it ^^

No9 commented 1 year ago

No worries - I forgot to mention these videos of @watson and @joyeecheung may bring some inspiration too https://www.youtube.com/watch?v=dyaux-pqq7o https://www.youtube.com/watch?v=hScOmLSE8Sk

Joyee/Thomas Brought you into the thread incase you had some tips/pointers/collateral for this documentation.

tony-go commented 1 year ago

For inspiration too: https://blog.cjihrig.com/postmortem_debugging (cc @cjihrig)

tony-go commented 1 year ago

Hi there 👋

For the delivery of this task, I propose:

  1. I'll submit a plan for this user journey documentation.
  2. We'll discuss the shape of the content together
  3. I'll write down the full article

WDYT?

tony-go commented 1 year ago

Hey people 👋

Sorry for the wait. We finished the structure of the post, now I'm trying to play with lldb (then with core dumps) on my machine. But I got very different results from what I saw in previous lectures (IBM or Colin's one). Maybe it's because I'm on M1; I open an issue on SOF. Anyway, I'll borrow the intel mac of my wife too if it fixes the issue.

I'll keep you informed, but the delivery will take longer than I expected.

tony-go commented 1 year ago

Update: I tried on an Intel machine, and it seems to work pretty fine 🎉

I'll continue my experiment with my wife's laptop 😅 (and will probably raise an issue on apple's side).

No9 commented 1 year ago

@tony-go was you're wife's laptop preconfigured? I was wondering how valid this PR is https://github.com/nodejs/llnode/pull/373

tony-go commented 1 year ago

@No9 on my wife's laptop xcode was installed (then with lldb within).

I install llnode with brew and it works fine ^^

I'll be able to continue my exploring phase :) (and will raise an issue to Apple for M1 issue)

tony-go commented 1 year ago

Hey team!

For various reasons, it took me more time than expected to finish that documentation.

I often approach this kind of exercise by practicing with the tool, but in my case, it's difficult: I have to borrow a machine, and sometimes I face difficulties with the tool itself (https://github.com/nodejs/llnode/issues/422), making progress difficult (regarding the time I have)

If someone wants to jump on it, please do it.

I also consider just reshaping past articles from IBM and Colin, but I already observe that v8 bt gives a different output regarding what we have in these articles. Also, I could not imagine a user going through this article and facing my issues.

Any thoughts? concerns?

RafaelGSS commented 1 year ago

No problem at all, @tony-go. Leave it open and if someone is interested in helping you. They will contact you.