Skip to content

proposal: elevate diagnostic report to tier1 #369

New issue

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

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

Already on GitHub? # to your account

Closed
gireeshpunathil opened this issue Mar 25, 2020 · 7 comments
Closed

proposal: elevate diagnostic report to tier1 #369

gireeshpunathil opened this issue Mar 25, 2020 · 7 comments

Comments

@gireeshpunathil
Copy link
Member

refs: https://github.com/nodejs/node/blob/master/doc/guides/diagnostic-tooling-support-tiers.md

diagnostic report meets all the criteria required for being tier1, namely:

  • The maintainers of the tool must remain responsive when there are problems; tool is part of the core, so maintainers are node core collaborators itself.
  • The tool must be actively used by the ecosystem; evidence of usage in the field - through core and help repo issues, as well as in person feedback in collab summit 2019 montreal
  • The tool must be heavily depended on; subjective, but report is being established as a unique FFDC capability that helped many issues so far.
  • The tool must have a guide or other documentation in the Node.js GitHub organization or website; - API guide exists part of the org, and several external documentations.
  • The tool must be working on all supported platforms; achieved
  • The tool must only be using APIs exposed by Nodejs as opposed to its dependencies; and
  • The tool must be open source. achieved

I propose to elevate report to tier1 status.

@gireeshpunathil gireeshpunathil changed the title proposal: elevate diagnostic report ti tier1 proposal: elevate diagnostic report to tier1 Mar 25, 2020
@hekike
Copy link
Contributor

hekike commented Mar 25, 2020

On the WG meeting, we decided to ping the working group members then wait 7 days before we open a PR with tier bump.

@mmarchini
Copy link
Contributor

cc @nodejs/diagnostics

@richardlau
Copy link
Member

I propose to elevate report to tier1 status.

The current https://github.com/nodejs/node/blob/master/doc/guides/diagnostic-tooling-support-tiers.md#diagnostic-tooling-support-tiers doesn't mention diagnostic report at all, so this would be adding diagnostic report as tier 1 rather than elevating it.

node-report, the precursor to diagnostics report is on the list but doesn't meet the tier 1 criteria.

@gireeshpunathil
Copy link
Member Author

The current https://github.com/nodejs/node/blob/master/doc/guides/diagnostic-tooling-support-tiers.md#diagnostic-tooling-support-tiers doesn't mention diagnostic report at all, so this would be adding diagnostic report as tier 1 rather than elevating it.

I don't understand - can you elaborate? diagnostic report is the in-core version of node-report, right? reference: nodejs/node#22712

the guide does not mention diagnostic report, because:

@richardlau
Copy link
Member

They've diverged and node-report still exists (and will probably still exist until Node.js 10 goes End-of-Life). Any tooling or guides written for diagnostic report would not automatically apply to node-report (and vice versa).

@gireeshpunathil
Copy link
Member Author

ok - so you are talking about the grace period when both (node-report and diagnostic-report) will co-exist due to logistical / policy related reasons.

I am talking about diagnostic-report as a replacement of node-report (reasons and background in the first comment of nodejs/node#22712) which is a result of endorsement from this working group. I am seeking a similar endorsement in this WG to replace node-report from the (unclassified) tooling tiers with diagnostic-report as classified.

jasnell pushed a commit to nodejs/node that referenced this issue Apr 23, 2020
diagnostic report qualifies for all the criteria for
being in tier1. Classify it as such.

PR-URL: #32732
Refs: nodejs/diagnostics#369
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Matheus Marchini <mat@mmarchini.me>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
@gireeshpunathil
Copy link
Member Author

this is achieved, closing. thanks all!

BethGriggs pushed a commit to nodejs/node that referenced this issue Apr 27, 2020
diagnostic report qualifies for all the criteria for
being in tier1. Classify it as such.

PR-URL: #32732
Refs: nodejs/diagnostics#369
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Matheus Marchini <mat@mmarchini.me>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
BridgeAR pushed a commit to nodejs/node that referenced this issue Apr 28, 2020
diagnostic report qualifies for all the criteria for
being in tier1. Classify it as such.

PR-URL: #32732
Refs: nodejs/diagnostics#369
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Matheus Marchini <mat@mmarchini.me>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit to nodejs/node that referenced this issue Apr 30, 2020
diagnostic report qualifies for all the criteria for
being in tier1. Classify it as such.

PR-URL: #32732
Refs: nodejs/diagnostics#369
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Matheus Marchini <mat@mmarchini.me>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit to nodejs/node that referenced this issue May 13, 2020
diagnostic report qualifies for all the criteria for
being in tier1. Classify it as such.

PR-URL: #32732
Refs: nodejs/diagnostics#369
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Matheus Marchini <mat@mmarchini.me>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants