mirror of
https://github.com/nodejs/node.git
synced 2024-12-01 16:10:02 +01:00
440057eae0
src: Add does_zap_garbage, malloced_memory and peak_malloced_memory to v8 HeapStatistics Following https://github.com/nodejs/code-and-learn/issues/56 I have exposed does_zap_garbage to HeapStatistics. The other fields, malloced_memory and peak_malloced_memory don't seem to be in the current version of v8 in master. PR-URL: https://github.com/nodejs/node/pull/8610 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
137 lines
3.6 KiB
Markdown
137 lines
3.6 KiB
Markdown
# V8
|
|
|
|
The `v8` module exposes APIs that are specific to the version of [V8][]
|
|
built into the Node.js binary. It can be accessed using:
|
|
|
|
```js
|
|
const v8 = require('v8');
|
|
```
|
|
|
|
*Note*: The APIs and implementation are subject to change at any time.
|
|
|
|
## v8.getHeapStatistics()
|
|
<!-- YAML
|
|
added: v1.0.0
|
|
-->
|
|
|
|
Returns an object with the following properties:
|
|
|
|
* `total_heap_size` {number}
|
|
* `total_heap_size_executable` {number}
|
|
* `total_physical_size` {number}
|
|
* `total_available_size` {number}
|
|
* `used_heap_size` {number}
|
|
* `heap_size_limit` {number}
|
|
* `malloced_memory` {number}
|
|
* `peak_malloced_memory` {number}
|
|
* `does_zap_garbage` {number}
|
|
|
|
`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 memory set) gets bigger because it
|
|
continuously touches all heap pages and that makes them less likely to get
|
|
swapped out by the operating system.
|
|
|
|
For example:
|
|
|
|
```js
|
|
{
|
|
total_heap_size: 7326976,
|
|
total_heap_size_executable: 4194304,
|
|
total_physical_size: 7326976,
|
|
total_available_size: 1152656,
|
|
used_heap_size: 3476208,
|
|
heap_size_limit: 1535115264,
|
|
malloced_memory: 16384,
|
|
peak_malloced_memory: 1127496,
|
|
does_zap_garbage: 0
|
|
}
|
|
```
|
|
|
|
## v8.getHeapSpaceStatistics()
|
|
<!-- YAML
|
|
added: v6.0.0
|
|
-->
|
|
|
|
Returns statistics about the V8 heap spaces, i.e. the segments which make up
|
|
the V8 heap. Neither the ordering of heap spaces, nor the availability of a
|
|
heap space can be guaranteed as the statistics are provided via the V8
|
|
[`GetHeapSpaceStatistics`][] function and may change from one V8 version to the
|
|
next.
|
|
|
|
The value returned is an array of objects containing the following properties:
|
|
* `space_name` {string}
|
|
* `space_size` {number}
|
|
* `space_used_size` {number}
|
|
* `space_available_size` {number}
|
|
* `physical_space_size` {number}
|
|
|
|
For example:
|
|
|
|
```json
|
|
[
|
|
{
|
|
"space_name": "new_space",
|
|
"space_size": 2063872,
|
|
"space_used_size": 951112,
|
|
"space_available_size": 80824,
|
|
"physical_space_size": 2063872
|
|
},
|
|
{
|
|
"space_name": "old_space",
|
|
"space_size": 3090560,
|
|
"space_used_size": 2493792,
|
|
"space_available_size": 0,
|
|
"physical_space_size": 3090560
|
|
},
|
|
{
|
|
"space_name": "code_space",
|
|
"space_size": 1260160,
|
|
"space_used_size": 644256,
|
|
"space_available_size": 960,
|
|
"physical_space_size": 1260160
|
|
},
|
|
{
|
|
"space_name": "map_space",
|
|
"space_size": 1094160,
|
|
"space_used_size": 201608,
|
|
"space_available_size": 0,
|
|
"physical_space_size": 1094160
|
|
},
|
|
{
|
|
"space_name": "large_object_space",
|
|
"space_size": 0,
|
|
"space_used_size": 0,
|
|
"space_available_size": 1490980608,
|
|
"physical_space_size": 0
|
|
}
|
|
]
|
|
```
|
|
|
|
## v8.setFlagsFromString(string)
|
|
<!-- YAML
|
|
added: v1.0.0
|
|
-->
|
|
|
|
The `v8.setFlagsFromString()` method can be used to programmatically set
|
|
V8 command line flags. This method should be used with care. Changing settings
|
|
after the VM has started may result in unpredictable behavior, including
|
|
crashes and data loss; or it may simply do nothing.
|
|
|
|
The V8 options available for a version of Node.js may be determined by running
|
|
`node --v8-options`. An unofficial, community-maintained list of options
|
|
and their effects is available [here][].
|
|
|
|
Usage:
|
|
|
|
```js
|
|
// Print GC events to stdout for one minute.
|
|
const v8 = require('v8');
|
|
v8.setFlagsFromString('--trace_gc');
|
|
setTimeout(function() { v8.setFlagsFromString('--notrace_gc'); }, 60e3);
|
|
```
|
|
|
|
[V8]: https://developers.google.com/v8/
|
|
[here]: https://github.com/thlorenz/v8-flags/blob/master/flags-0.11.md
|
|
[`GetHeapSpaceStatistics`]: https://v8docs.nodesource.com/node-5.0/d5/dda/classv8_1_1_isolate.html#ac673576f24fdc7a33378f8f57e1d13a4
|