diagnostics_channel: mark as stable#45290

Qard · 2022-11-02T20:19:18Z

I'm proposing that we mark diagnostics_channel as stable. It has been used extensively in the Datadog tracer for awhile now and we're quite satisfied that it serves the intended purpose. Marking as stable will help significantly with pushing for ecosystem adoption in the future.

cc @nodejs/diagnostics

Flarna

Maybe add the version in the doc metadata when it was moved to stable.

Qard · 2022-11-02T21:19:14Z

@Flarna Do we have an example of that in our existing docs? I did a search when I made this and found nothing, which was a bit surprising to me actually. 🤔

Flarna · 2022-11-03T07:03:43Z

I found it e.g. in HTTP2.

Use REPLACEME for the version itself as far as I know, see https://github.com/nodejs/node/blob/1af63a90ca3a59ca05b3a12ad7dbea04008db7d9/doc/contributing/pull-requests.md#step-3-code

Qard · 2022-11-03T07:53:44Z

If you're referring to the "added" field, that's for when the feature was added, not for when it was stabilized. I searched the docs and all I could find was "added" and "deprecated" fields in the YAML front-matter. As far as I can tell there is no stabilization version field. 🤔

Flarna · 2022-11-03T07:57:10Z

The HTTP 2 entry has the following which seems to be similar then this here:

- version: v10.10.0 pr-url: https://github.com/nodejs/node/pull/22466 description: HTTP/2 is now Stable. Previously, it had been Experimental.

RafaelGSS

LGTM.

Qard · 2022-11-03T23:03:02Z

Updated with changes list to document the version at which the stabilization occurs.

github-actions · 2022-11-04T19:42:10Z

Failed to start CI

- Validating Jenkins credentials ✖ Jenkins credentials invalid

https://github.com/nodejs/node/actions/runs/3396629140

nodejs-github-bot · 2022-11-04T20:53:12Z

CI: https://ci.nodejs.org/job/node-test-pull-request/47683/

nodejs-github-bot · 2022-11-04T23:21:28Z

CI: https://ci.nodejs.org/job/node-test-pull-request/47694/

nodejs-github-bot · 2022-11-05T03:36:16Z

CI: https://ci.nodejs.org/job/node-test-pull-request/47703/

Flarna · 2022-11-05T11:57:54Z

@Qard for doc only changes GitHub ci would be enough.

nodejs-github-bot · 2022-11-05T12:03:54Z

Landed in 2db03a6

PR-URL: nodejs#45290 Reviewed-By: Gerhard Stöbich <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Santiago Gimeno <[email protected]> Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Yagiz Nizipli <[email protected]> Reviewed-By: Chengzhong Wu <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]>

Flarna · 2022-11-10T07:27:20Z

I just noticed that this moved not only the diag channel API to stable but also the built in channels. I'm not sure if this was intended. Created #45400 to discuss this further.

Qard · 2022-11-10T07:48:16Z

No, channels themselves are not stable and are not intended to be considered stable in the future. They are an informational source that is meant to be treated as optional. You can subscribe to a named channel but may or may not ever receive events from that channel.

Flarna · 2022-11-10T09:03:39Z

I added the dont-land-on-v19 label until #45400 is resolved.

PR-URL: #45290 Reviewed-By: Gerhard Stöbich <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Santiago Gimeno <[email protected]> Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Yagiz Nizipli <[email protected]> Reviewed-By: Chengzhong Wu <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]>

Qard added diag-agenda Issues and PRs to discuss during the meetings of the diagnostics working group. diagnostics_channel Issues and PRs related to diagnostics channel labels Nov 2, 2022

nodejs-github-bot added the doc Issues and PRs related to the documentations. label Nov 2, 2022

Flarna approved these changes Nov 2, 2022
View reviewed changes

lpinca approved these changes Nov 2, 2022
View reviewed changes

jasnell approved these changes Nov 2, 2022
View reviewed changes

santigimeno approved these changes Nov 2, 2022
View reviewed changes

RafaelGSS approved these changes Nov 3, 2022
View reviewed changes

anonrig approved these changes Nov 3, 2022
View reviewed changes

tony-go approved these changes Nov 3, 2022
View reviewed changes

diagnostics_channel: mark as stable
9d8e285

Qard force-pushed the stabilize-diagnostics-channel branch from 23496a7 to 9d8e285Compare November 3, 2022 23:02

Flarna approved these changes Nov 3, 2022
View reviewed changes

legendecas approved these changes Nov 4, 2022
View reviewed changes

gireeshpunathil approved these changes Nov 4, 2022
View reviewed changes

Qard added request-ci Add this label to start a Jenkins CI on a PR. and removed diag-agenda Issues and PRs to discuss during the meetings of the diagnostics working group. labels Nov 4, 2022

github-actionsbot added request-ci-failed An error occurred while starting CI via request-ci label, and manual interventon is needed. and removed request-ci Add this label to start a Jenkins CI on a PR. labels Nov 4, 2022

Qard added request-ci Add this label to start a Jenkins CI on a PR. and removed request-ci-failed An error occurred while starting CI via request-ci label, and manual interventon is needed. labels Nov 4, 2022

github-actionsbot removed the request-ci Add this label to start a Jenkins CI on a PR. label Nov 4, 2022

anonrig added the request-ci Add this label to start a Jenkins CI on a PR. label Nov 4, 2022

github-actionsbot removed the request-ci Add this label to start a Jenkins CI on a PR. label Nov 4, 2022

Qard added the request-ci Add this label to start a Jenkins CI on a PR. label Nov 5, 2022

github-actionsbot removed the request-ci Add this label to start a Jenkins CI on a PR. label Nov 5, 2022

Flarna added the commit-queue Add this label to land a pull request using GitHub Actions. label Nov 5, 2022

nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Nov 5, 2022

nodejs-github-bot merged commit 2db03a6 into nodejs:mainNov 5, 2022

Qard deleted the stabilize-diagnostics-channel branch November 5, 2022 18:53

This was referenced Nov 6, 2022
CI Reliability 2022-11-06 nodejs/reliability#420
Open
CI Reliability 2022-11-07 nodejs/reliability#421
Open
CI Reliability 2022-11-08 nodejs/reliability#422
Open

Flarna mentioned this pull request Nov 10, 2022
Stability of built in diagnostics channels #45400
Closed

Flarna added the dont-land-on-v19.x label Nov 10, 2022

Flarna removed the dont-land-on-v19.x label Nov 15, 2022

ruyadorno mentioned this pull request Nov 24, 2022
v19.2.0 proposal #45615
Merged

danielleadams mentioned this pull request Dec 30, 2022
v18.13.0 release proposal #46025
Merged

Uh oh!

diagnostics_channel: mark as stable#45290

diagnostics_channel: mark as stable #45290

Uh oh!

Conversation

Qard commented Nov 2, 2022• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Flarna left a comment

Choose a reason for hiding this comment

Uh oh!

Qard commented Nov 2, 2022• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Flarna commented Nov 3, 2022

Uh oh!

Qard commented Nov 3, 2022

Uh oh!

Flarna commented Nov 3, 2022

Uh oh!

RafaelGSS left a comment

Choose a reason for hiding this comment

Uh oh!

Qard commented Nov 3, 2022

Uh oh!

github-actionsbot commented Nov 4, 2022

Uh oh!

nodejs-github-bot commented Nov 4, 2022

Uh oh!

nodejs-github-bot commented Nov 4, 2022

Uh oh!

nodejs-github-bot commented Nov 5, 2022

Uh oh!

Flarna commented Nov 5, 2022

Uh oh!

nodejs-github-bot commented Nov 5, 2022

Uh oh!

Flarna commented Nov 10, 2022

Uh oh!

Qard commented Nov 10, 2022

Uh oh!

Flarna commented Nov 10, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

11 participants

Qard commented Nov 2, 2022•
edited
Loading

Qard commented Nov 2, 2022•
edited
Loading