Skip to content

Interface: IMemoryMonitorStatistics ​

The statistics of a MemoryMonitor, in bytes unless stated: the latest sample of the process memory (process.memoryUsage()), and the minimum, maximum, mean and percentiles of the samples taken every second since the monitor was created or reset (0 after a reset until the next sample). The percentiles are approximate (3 significant digits).

Properties ​

externalUsed ​

externalUsed: number

The memory of the C++ objects bound to JavaScript objects (the Buffers included) at the latest sample, in bytes.


externalUsedAvg ​

externalUsedAvg: number

The mean external memory of the samples, in bytes, rounded to 2 decimals.


externalUsedMax ​

externalUsedMax: number

The highest external memory sampled, in bytes.


externalUsedMin ​

externalUsedMin: number

The lowest external memory sampled, in bytes.


externalUsedP50 ​

externalUsedP50: number

The median external memory of the samples, in bytes.


externalUsedP90 ​

externalUsedP90: number

The 90th percentile of the external memory samples, in bytes.


externalUsedP95 ​

externalUsedP95: number

The 95th percentile of the external memory samples, in bytes.


externalUsedP99 ​

externalUsedP99: number

The 99th percentile of the external memory samples, in bytes.


heapTotal ​

heapTotal: number

The size of the V8 heap reserved by the process at the latest sample, in bytes.


heapUsage ​

heapUsage: number

heapUsed as a percentage of heapTotal, rounded to 2 decimals. V8 grows the heap as needed, so a high value alone is not a leak: a leak shows as heapUsedMin rising from one reset period to the next.


heapUsed ​

heapUsed: number

The part of the V8 heap occupied by JavaScript objects at the latest sample, in bytes.


heapUsedAvg ​

heapUsedAvg: number

The mean used heap of the samples, in bytes, rounded to 2 decimals.


heapUsedMax ​

heapUsedMax: number

The highest used heap sampled, in bytes.


heapUsedMin ​

heapUsedMin: number

The lowest used heap sampled, in bytes.


heapUsedP50 ​

heapUsedP50: number

The median used heap of the samples, in bytes.


heapUsedP90 ​

heapUsedP90: number

The 90th percentile of the used heap samples, in bytes.


heapUsedP95 ​

heapUsedP95: number

The 95th percentile of the used heap samples, in bytes.


heapUsedP99 ​

heapUsedP99: number

The 99th percentile of the used heap samples, in bytes.


physicalTotal ​

physicalTotal: number

The total physical memory of the host (os.totalmem()), in bytes; under a container, the host's, not the container's limit.


physicalUsage ​

physicalUsage: number

physicalUsed as a percentage of physicalTotal, rounded to 2 decimals.


physicalUsed ​

physicalUsed: number

The resident set size of the process (rss) at the latest sample: the physical memory it occupies, in bytes.


physicalUsedAvg ​

physicalUsedAvg: number

The mean resident set size of the samples, in bytes, rounded to 2 decimals.


physicalUsedMax ​

physicalUsedMax: number

The highest resident set size sampled, in bytes.


physicalUsedMin ​

physicalUsedMin: number

The lowest resident set size sampled, in bytes.


physicalUsedP50 ​

physicalUsedP50: number

The median resident set size of the samples, in bytes.


physicalUsedP90 ​

physicalUsedP90: number

The 90th percentile of the resident set size samples, in bytes.


physicalUsedP95 ​

physicalUsedP95: number

The 95th percentile of the resident set size samples, in bytes.


physicalUsedP99 ​

physicalUsedP99: number

The 99th percentile of the resident set size samples, in bytes.

Released under the MIT License.