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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 2 commits into from
Mar 23, 2022
Merged

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

merged 2 commits into from
Mar 23, 2022

Conversation

tony-go
Copy link
Member

@tony-go tony-go commented Mar 15, 2022 •
edited
Loading

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
Collaborator

Review requested:

  • @nodejs/tsc

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Mar 15, 2022
mcollina
mcollina approved these changes Mar 15, 2022
View reviewed changes
Copy link
Member

@mcollina mcollina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@gireeshpunathil
Copy link
Member

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
Member Author

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
Member

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 Issues and PRs to discuss during the meetings of the diagnostics working group. label Mar 17, 2022
@tony-go
Copy link
Member Author

tony-go commented Mar 17, 2022

definitely worth discussing in diagnostics wg, adding labels.

Neat 🙌 !

@mhdawson mhdawson mentioned this pull request Mar 21, 2022
Closed
@gireeshpunathil
Copy link
Member

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 PRs that have at least one approval, no pending requests for changes, and a CI started. label Mar 23, 2022
@Mesteery
Copy link
Contributor

s/tratce/trace in commit message.

@tony-go
Copy link
Member Author

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
@aduh95
Copy link
Contributor

aduh95 commented Mar 23, 2022

Landed in aea4e1f

@tony-go tony-go mentioned this pull request Mar 25, 2022
Merged
juanarbol pushed a commit that referenced this pull request Apr 4, 2022
@tony-go @juanarbol
doc: add trace_gc to diagnostic tooling support document
5f1da45 
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 pull request Apr 5, 2022
@tony-go @juanarbol
doc: add trace_gc to diagnostic tooling support document
41b353d 
PR-URL: nodejs#42346
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
This was referenced Apr 5, 2022
Closed
Merged
@tony-go tony-go mentioned this pull request Apr 6, 2022
Closed
juanarbol pushed a commit that referenced this pull request Apr 6, 2022
@tony-go @juanarbol
doc: add trace_gc to diagnostic tooling support document
48bd9fa 
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 pull request Apr 25, 2022
@tony-go @xtx1130
doc: add trace_gc to diagnostic tooling support document
c099f5f 
PR-URL: nodejs#42346
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
@tony-go tony-go mentioned this pull request May 5, 2022
Closed
juanarbol pushed a commit that referenced this pull request May 31, 2022
@tony-go @juanarbol
doc: add trace_gc to diagnostic tooling support document
9b71043 
PR-URL: #42346
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
@juanarbol juanarbol mentioned this pull request May 31, 2022
Closed
danielleadams pushed a commit that referenced this pull request Jun 27, 2022
@tony-go @danielleadams
doc: add trace_gc to diagnostic tooling support document
4d7f88a 
PR-URL: #42346
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
targos pushed a commit that referenced this pull request Jul 11, 2022
@tony-go @targos
doc: add trace_gc to diagnostic tooling support document
1988645 
PR-URL: #42346
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
@kvakil kvakil mentioned this pull request Jul 13, 2022
Closed
targos pushed a commit that referenced this pull request Jul 31, 2022
@tony-go @targos
doc: add trace_gc to diagnostic tooling support document
3cf8025 
PR-URL: #42346
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
@targos targos mentioned this pull request Aug 3, 2022
Merged
guangwong pushed a commit to noslate-project/node that referenced this pull request Oct 10, 2022
@tony-go @guangwong
doc: add trace_gc to diagnostic tooling support document
feb6a3e 
PR-URL: nodejs/node#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
Reviewers

@mcollina mcollina mcollina approved these changes

@gireeshpunathil gireeshpunathil gireeshpunathil approved these changes

Assignees
No one assigned
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. diag-agenda Issues and PRs to discuss during the meetings of the diagnostics working group. doc Issues and PRs related to the documentations.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@tony-go @nodejs-github-bot @gireeshpunathil @Mesteery @aduh95 @mcollina