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 “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

diagnostics_channel: mark as stable #45290

Merged
merged 1 commit into from Nov 5, 2022

Conversation

Qard
Copy link
Member

@Qard Qard commented Nov 2, 2022

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

@Qard 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 nodejs-github-bot added the doc Issues and PRs related to the documentations. label Nov 2, 2022
Copy link
Member

@Flarna Flarna left a comment

Choose a reason for hiding this comment

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

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

@Qard
Copy link
Member Author

Qard commented Nov 2, 2022

@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
Copy link
Member

Flarna commented Nov 3, 2022

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

Qard commented Nov 3, 2022

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
Copy link
Member

Flarna commented Nov 3, 2022

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.

Copy link
Member

@RafaelGSS RafaelGSS left a comment

Choose a reason for hiding this comment

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

LGTM.

@Qard Qard force-pushed the stabilize-diagnostics-channel branch from 23496a7 to 9d8e285 Compare November 3, 2022 23:02
@Qard
Copy link
Member Author

Qard commented Nov 3, 2022

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

@Qard 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-actions github-actions bot 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
@github-actions
Copy link
Contributor

github-actions bot commented Nov 4, 2022

Failed to start CI
- Validating Jenkins credentials
✖  Jenkins credentials invalid
https://github.com/nodejs/node/actions/runs/3396629140

@Qard 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-actions github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Nov 4, 2022
@nodejs-github-bot
Copy link
Collaborator

@anonrig anonrig added the request-ci Add this label to start a Jenkins CI on a PR. label Nov 4, 2022
@github-actions github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Nov 4, 2022
@nodejs-github-bot
Copy link
Collaborator

@Qard Qard added the request-ci Add this label to start a Jenkins CI on a PR. label Nov 5, 2022
@github-actions github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Nov 5, 2022
@nodejs-github-bot
Copy link
Collaborator

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

Flarna commented Nov 5, 2022

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

@nodejs-github-bot 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 nodejs-github-bot merged commit 2db03a6 into nodejs:main Nov 5, 2022
@nodejs-github-bot
Copy link
Collaborator

Landed in 2db03a6

@Qard Qard deleted the stabilize-diagnostics-channel branch November 5, 2022 18:53
lucshi pushed a commit to lucshi/node that referenced this pull request Nov 9, 2022
PR-URL: nodejs#45290
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
@Flarna
Copy link
Member

Flarna commented Nov 10, 2022

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

Qard commented Nov 10, 2022

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
Copy link
Member

Flarna commented Nov 10, 2022

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

ruyadorno pushed a commit that referenced this pull request Nov 21, 2022
PR-URL: #45290
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
@ruyadorno ruyadorno mentioned this pull request Nov 24, 2022
danielleadams pushed a commit that referenced this pull request Dec 30, 2022
PR-URL: #45290
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
danielleadams pushed a commit that referenced this pull request Dec 30, 2022
PR-URL: #45290
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
danielleadams pushed a commit that referenced this pull request Jan 3, 2023
PR-URL: #45290
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
danielleadams pushed a commit that referenced this pull request Jan 4, 2023
PR-URL: #45290
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Chengzhong Wu <legendecas@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
diagnostics_channel Issues and PRs related to diagnostics channel doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet