Skip to content

doc: add note for handling signal events in trace events - #41438

Merged
nodejs-github-bot merged 2 commits into
nodejs:masterfrom
thedull:trace-event-doc-note
Jan 21, 2022
Merged

doc: add note for handling signal events in trace events#41438
nodejs-github-bot merged 2 commits into
nodejs:masterfrom
thedull:trace-event-doc-note

Conversation

@thedull

@thedullthedull commented Jan 7, 2022

Copy link
Copy Markdown
Contributor

Keeping in mind issues like #18476 and #14802, I went ahead and added a note to the docs for users to handle signal events properly, so that trace events are correctly logged into files.

I'm happy to make any changes to this PR as needed since it's my first time contributing to the Node.js project.

@nodejs-github-botnodejs-github-bot added the doc Issues and PRs related to the documentations. label Jan 7, 2022
@benjamingr

benjamingr commented Jan 8, 2022

Copy link
Copy Markdown
Member

@nodejs/diagnostics

RafaelGSS
RafaelGSS approved these changes Jan 18, 2022
View reviewed changes

@RafaelGSSRafaelGSS left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM.

@benjamingr

benjamingr commented Jan 18, 2022

Copy link
Copy Markdown
Member

Can someone from diagnostics explain why the signal handler is needed in this case :)?

Flarna
Flarna reviewed Jan 18, 2022
View reviewed changes
Comment threaddoc/api/tracing.md Outdated
@Flarna

Flarna commented Jan 18, 2022

Copy link
Copy Markdown
Member

Reading the linked issues and #22734 tells that flushing the trace events in a signal handler is not trivial and would require quite some work (if possible at all). There is #22883 since a while which asks for a fix.

By installing a signal handler from JS the default action of this signal (end process) is not executed anymore. By calling process.exit() from the JS handler a shutdown triggered via signal is moved to a graceful shutdown which is not limited to only calling signal safe functions and flush works.

@thedull
thedull marked this pull request as draft January 18, 2022 18:18
@thedull
thedullforce-pushed the trace-event-doc-note branch from e358dfb to 2483455CompareJanuary 18, 2022 18:29
@thedull
thedullforce-pushed the trace-event-doc-note branch from 2483455 to 99f3758CompareJanuary 18, 2022 18:36
@thedull
thedull marked this pull request as ready for review January 18, 2022 18:39
@Ayase-252Ayase-252 added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Jan 21, 2022
@aduh95aduh95 added commit-queue Add this label to land a pull request using GitHub Actions. commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. labels Jan 21, 2022
@nodejs-github-botnodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Jan 21, 2022
@nodejs-github-bot
nodejs-github-bot merged commit 806c7c1 into nodejs:masterJan 21, 2022
@nodejs-github-bot

nodejs-github-bot commented Jan 21, 2022

Copy link
Copy Markdown
Collaborator

Landed in 806c7c1

BethGriggs pushed a commit that referenced this pull request Jan 25, 2022
@thedull@BethGriggs
doc: add note for handling signal events in trace events
09763a2
Refs: #14802
PR-URL: #41438
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Adrian Estrada <edsadr@gmail.com>
Reviewed-By: Mary Marchini <oss@mmarchini.me>
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
@ruyadornoruyadorno mentioned this pull request Feb 8, 2022
Merged
danielleadams pushed a commit that referenced this pull request Feb 28, 2022
@thedull@danielleadams
doc: add note for handling signal events in trace events
fa61e6f
Refs: #14802
PR-URL: #41438
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Adrian Estrada <edsadr@gmail.com>
Reviewed-By: Mary Marchini <oss@mmarchini.me>
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
danielleadams pushed a commit that referenced this pull request Mar 2, 2022
@thedull@danielleadams
doc: add note for handling signal events in trace events
44164c0
Refs: #14802
PR-URL: #41438
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Adrian Estrada <edsadr@gmail.com>
Reviewed-By: Mary Marchini <oss@mmarchini.me>
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
@danielleadamsdanielleadams mentioned this pull request Mar 3, 2022
Merged
danielleadams pushed a commit that referenced this pull request Mar 3, 2022
@thedull@danielleadams
doc: add note for handling signal events in trace events
26fc1e8
Refs: #14802
PR-URL: #41438
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Adrian Estrada <edsadr@gmail.com>
Reviewed-By: Mary Marchini <oss@mmarchini.me>
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
danielleadams pushed a commit that referenced this pull request Mar 14, 2022
@thedull@danielleadams
doc: add note for handling signal events in trace events
0805068
Refs: #14802
PR-URL: #41438
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Adrian Estrada <edsadr@gmail.com>
Reviewed-By: Mary Marchini <oss@mmarchini.me>
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jasnelljasnelljasnell approved these changes
@santigimenosantigimenosantigimeno approved these changes
@FlarnaFlarnaFlarna approved these changes
@RafaelGSSRafaelGSSRafaelGSS approved these changes
+2 more reviewers
@edsadredsadredsadr approved these changes
@mmarchinimmarchinimmarchini approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

author readyPRs that have at least one approval, no pending requests for changes, and a CI started.commit-queue-squashAdd this label to instruct the Commit Queue to squash all the PR commits into the first one.docIssues and PRs related to the documentations.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

11 participants

@thedull@benjamingr@Flarna@nodejs-github-bot@jasnell@santigimeno@edsadr@mmarchini@RafaelGSS@Ayase-252@aduh95