doc: add note for handling signal events in trace events

Refs: #14802 PR-URL: #41438 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Adrian Estrada <[email protected]> Reviewed-By: Mary Marchini <[email protected]> Reviewed-By: Gerhard Stöbich <[email protected]> Reviewed-By: Santiago Gimeno <[email protected]>
nodejs · Jan 24, 2022 · 09763a2 · 09763a2
1 parent 3b45c05
commit 09763a2
Showing 1 changed file with 11 additions and 0 deletions.
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,