feat(core): add Node.js memory perf logging #10590
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
slorber
added
pr: new feature
✅ [V2]
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Size Change: +349 B (0%) Total Size: 11.2 MB ℹ️ View Unchanged
|
⚡️ Lighthouse report for the deploy preview of this PR
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
This enhance the
DOCUSAURUS_PERF_LOGGER=trueenv variable described in #4765 (comment)Although we consider it an internal API, users can still use this env variable to troubleshoot performance and memory usage of their Docusaurus site.
Note: it's better to run this with the
--expose-gcNode.js option, so that heap memory consumption gets measured just after triggering a manual GC.Our infrastructure should make it easy to figure out which step consumes Node.js heap memory:
For now, it only logs before/after memory, but we could enhance this later with sampling and add an average memory consumption for each recorded step.
Note I'd also like to wire all this to our CI in the future so that PRs can report memory usage regressions, similar to what Astro is doing here:
Test Plan
local
Links
Related to #4765
Follow-up of #9975