X Tutup
The Wayback Machine - https://web.archive.org/web/20220501115744/https://github.com/nodejs/node/pull/42346
Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking 鈥淪ign up for GitHub鈥, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(doc): add trace_gc to diagnostic tooling support document #42346

Merged
merged 2 commits into from Mar 23, 2022

Conversation

Copy link
Contributor

@tony-go tony-go commented Mar 15, 2022

Hey node family 馃憢

Context

A tiny PR that follows the initiative started by @gireeshpunathil here, in the diagnostic WG repo. The goal of this initiative is to re-assess diagnostic tooling and examine how could we improve the current status.

Added

While I read the current diagnostic-tooling-support document, I didn't see the same old trace_gc tool, so I added it to the list 馃帀

Let me know what do you think.

... for further

If it seems ok for the community, we could have a discussion about the documentation: how we could make adoption easier for newcomers, and the regular testing in Node.js CI.

馃搫 Regarding the documentation, I found these two links:

@nodejs-github-bot
Copy link

@nodejs-github-bot nodejs-github-bot commented Mar 15, 2022

Review requested:

@nodejs-github-bot nodejs-github-bot added the doc label Mar 15, 2022
@tony-go tony-go force-pushed the add_trace_gc_to_diag_tools branch from debfe39 to 645657d Compare Mar 15, 2022
Copy link
Member

@mcollina mcollina left a comment

lgtm

@gireeshpunathil
Copy link

@gireeshpunathil gireeshpunathil commented Mar 16, 2022

I don't know our convention around diagnostic flags to be qualified as tooling (though there is no harm in it)

pro: it provides a unique diagnostic information, leading to solve a unique problem
con: i) the capability is an integral part of v8 code base, probably since its inception (to be called as a tool)
ii) there may be many other such flags on similar lines, and if we add this, technically of those qualify iii) not sure if --trace-gc needs to be tracked for tiered maturity levels and supported, as I never heard any stability issue with that.

having said that, I am indecisive on this at this point, and will listen to someone's opinion.

@tony-go
Copy link
Author

@tony-go tony-go commented Mar 16, 2022

Thanks a lot for the detailed feedback @gireeshpunathil. I fully understand now, why it wasn't on the list.

That's being said, I thought about something else: Even if it's integral part of v8 code base, what about the integration with node? Maybe could we test that is integrated properly? or maybe it's not worth it, let me know WDYT.

@gireeshpunathil
Copy link

@gireeshpunathil gireeshpunathil commented Mar 17, 2022

That's being said, I thought about something else: Even if it's integral part of v8 code base, what about the integration with node? Maybe could we test that is integrated properly? or maybe it's not worth it, let me know WDYT.

definitely worth discussing in diagnostics wg, adding labels.

@gireeshpunathil gireeshpunathil added the diag-agenda label Mar 17, 2022
@tony-go
Copy link
Author

@tony-go tony-go commented Mar 17, 2022

definitely worth discussing in diagnostics wg, adding labels.

Neat 馃檶 !

@gireeshpunathil
Copy link

@gireeshpunathil gireeshpunathil commented Mar 22, 2022

discussed in the WG today. We have consensus on adding this to the list. (A governing principle being: tools that are greatly useful and heavily used in the field)

@Mesteery Mesteery added the author ready label Mar 23, 2022
@Mesteery
Copy link

@Mesteery Mesteery commented Mar 23, 2022

s/tratce/trace in commit message.

@tony-go
Copy link
Author

@tony-go tony-go commented Mar 23, 2022

s/tratce/trace in commit message.

Didn't get you on this 馃槄.

@aduh95 aduh95 merged commit aea4e1f into nodejs:master Mar 23, 2022
18 checks passed
@aduh95
Copy link

@aduh95 aduh95 commented Mar 23, 2022

Landed in aea4e1f

juanarbol pushed a commit that referenced this issue Apr 4, 2022
PR-URL: #42346
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
juanarbol pushed a commit to juanarbol/node that referenced this issue Apr 5, 2022
PR-URL: nodejs#42346
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
@juanarbol juanarbol mentioned this pull request Apr 5, 2022
@juanarbol juanarbol mentioned this pull request Apr 5, 2022
juanarbol pushed a commit that referenced this issue Apr 6, 2022
PR-URL: #42346
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
xtx1130 pushed a commit to xtx1130/node that referenced this issue Apr 25, 2022
PR-URL: nodejs#42346
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author ready diag-agenda doc
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants
X Tutup