doc: document vm timeout option perf impact #12751
Conversation
Mention that the `timeout` option has a noticeable performance impact. Fixes: nodejs#10453
nodejs-github-bot
added
doc
| @@ -125,6 +125,10 @@ console.log(util.inspect(sandbox)); | |||
| // { animal: 'cat', count: 12, name: 'kitty' } | |||
| ``` | |||
|
|
|||
| *Note*: Using the `timeout` or `breakOnSigint` options will result in new | |||
| event loops and corresponding threads being started, which have a non-zero | |||
There was a problem hiding this comment.
Does using breakOnSigint option start a new event loop though? Either I am wrong or the language is somewhat confusing here.
There was a problem hiding this comment.
Yeah, breakOnSigint doesn’t start its own loop, only an extra thread. It’s definitely just an implementation detail, but if you have suggestions for better wording, I’ll take them. :)
There was a problem hiding this comment.
I'd say something like "Using the timeout option will result in creating a new event loop and utilizing the breakOnSigint option will cause a helper thread to be started", but, well, I agree that it is an implementation detail and your version is more concise, so I'm fine with it either way.
There was a problem hiding this comment.
@aqrln The timeout option will create both a thread and a new event loop. ;) (I would actually assume spinning up the thread is much more costly – basically, what I’m trying to say is that both will allocate and consume new resources.)
|
Landed in 2bf461e |
Mention that the `timeout` option has a noticeable performance impact. Fixes: nodejs#10453 PR-URL: nodejs#12751 Reviewed-By: Alexey Orlenko <eaglexrlnk@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Mention that the
timeoutoption has a noticeable performance impact.Fixes: #10453
Checklist
Affected core subsystem(s)
doc, vm