From 2f5b98ee1f9ea7f1903b1a8d117b38f7fd72c732 Mon Sep 17 00:00:00 2001 From: Benji Marinacci Date: Wed, 28 Aug 2024 22:12:56 -0700 Subject: [PATCH] doc: add getHeapStatistics() property descriptions PR-URL: https://github.com/nodejs/node/pull/54584 Reviewed-By: James M Snell Reviewed-By: Luigi Pinca --- doc/api/v8.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/doc/api/v8.md b/doc/api/v8.md index 3b71e33cd3270e..bfd475afdda025 100644 --- a/doc/api/v8.md +++ b/doc/api/v8.md @@ -198,6 +198,35 @@ Returns an object with the following properties: * `used_global_handles_size` {number} * `external_memory` {number} +`total_heap_size` The value of total\_heap\_size is the number of bytes V8 has +allocated for the heap. This can grow if used\_heap needs more memory. + +`total_heap_size_executable` The value of total\_heap\_size\_executable is the +portion of the heap that can contain executable code, in bytes. This includes +memory used by JIT-compiled code and any memory that must be kept executable. + +`total_physical_size` The value of total\_physical\_size is the actual physical memory +used by the V8 heap, in bytes. This is the amount of memory that is committed +(or in use) rather than reserved. + +`total_available_size` The value of total\_available\_size is the number of +bytes of memory available to the V8 heap. This value represents how much +more memory V8 can use before it exceeds the heap limit. + +`used_heap_size` The value of used\_heap\_size is number of bytes currently +being used by V8’s JavaScript objects. This is the actual memory in use and +does not include memory that has been allocated but not yet used. + +`heap_size_limit` The value of heap\_size\_limit is the maximum size of the V8 +heap, in bytes (either the default limit, determined by system resources, or +the value passed to the `--max_old_space_size` option). + +`malloced_memory` The value of malloced\_memory is the number of bytes allocated +through `malloc` by V8. + +`peak_malloced_memory` The value of peak\_malloced\_memory is the peak number of +bytes allocated through `malloc` by V8 during the lifetime of the process. + `does_zap_garbage` is a 0/1 boolean, which signifies whether the `--zap_code_space` option is enabled or not. This makes V8 overwrite heap garbage with a bit pattern. The RSS footprint (resident set size) gets bigger