doc: add note for handling signal events in trace events

thedull · danielleadams · commit 0805068add71 · 2022-03-14T09:32:00.000-04:00
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>
diff --git a/doc/api/tracing.md b/doc/api/tracing.md
@@ -80,6 +80,17 @@ string that supports `${rotation}` and `${pid}`:
 node --trace-event-categories v8 --trace-event-file-pattern '${pid}-${rotation}.log' server.js
 ```
 
+To guarantee that the log file is properly generated after signal events like
+`SIGINT`, `SIGTERM`, or `SIGBREAK`, make sure to have the appropriate handlers
+in your code, such as:
+
+```js
+process.on('SIGINT', function onSigint() {
+  console.info('Received SIGINT.');
+  process.exit(130);  // Or applicable exit code depending on OS and signal
+});
+```
+
 The tracing system uses the same time source
 as the one used by `process.hrtime()`.
 However the trace-event timestamps are expressed in microseconds,
