doc: os.uptime() temporary bug notice #36503
Conversation
Makes it clear that os.uptime() is unreliable in some virtualization cases.
nodejs-github-bot
added
doc
schamberg97
changed the title
Fix style
|
This seems unnecessary given the linked libuv issue was created only 2 hours ago. Is there any indication that libuv won't fix this in a reasonable amount of time? |
In my belief, libuv maintainers may need to spend some time coming to a decision on how best to resolve the issue. I am just unsure how much time it may require. But perhaps you are right, in which case this PR should probably remain open without any further action until there is better understanding of how things develop. |
doc/api/os.md
Outdated
| Please be aware that the value returned can be inaccurate in some | ||
| rare virtualization cases. The issue arises when the virtualized | ||
| guest instance shares the kernel with the host system due to a bug | ||
| in libuv. `os.uptime()` may thus provide the host's uptime instead of guest's. |
There was a problem hiding this comment.
The way this sentence is worded it implies that the bug in libuv is what is responsible for the guest instance sharing the kernel with the host system.
Rewording Co-authored-by: Benjamin Gruenbaum <[email protected]>
Co-authored-by: Rich Trott <[email protected]>
Co-authored-by: Rich Trott <[email protected]>
|
@Trott thanks for review 😊 I am unfortunately always absent-minded about linting markdown. Gotta do something about it 🤓 |
|
Regarding the PR, despite some opinions to the contrary, I still think it needs to be accepted, because libuv guys seem to be somewhat slow with reviewing the fix, perhaps due to the season 😇 But hopefully it’ll be resolved soon |
Makes it clear that os.uptime() is unreliable in some virtualization cases. PR-URL: #36503 Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]> Reviewed-By: Franziska Hinkelmann <[email protected]> Reviewed-By: James M Snell <[email protected]>
|
Landed in b9ffb82 |
Makes it clear that os.uptime() is unreliable in some virtualization cases. PR-URL: #36503 Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]> Reviewed-By: Franziska Hinkelmann <[email protected]> Reviewed-By: James M Snell <[email protected]>
Checklist
This commit makes it clear that
os.uptime()is currently unreliable in some virtualization cases, until libuv/libuv#3068 is resolved (and thus #36244). At least one member of Node.js (@benjamingr) in the aforementioned issue appears to be in favour of at least a temporary notice, until the issue is resolved by libuv.However, since similar issues may reappear in the future with the evolution of virtualization technology, I believe it is prudent to leave a permanent notice on
os.uptime()doc, so perhaps it is also worth to consider.