使用 Node.js 开发后端程序的时候,在某些情况下可能会需要查看运行环境还剩下多少的内存来决定是否继续进行工作,那么该如何使用 Node.js 来获取运行环境的内存信息呢?

os.totalmem 和 os.freemem

Node.js 内置的 os 模块其实就有提供 totalmem 和 freemem 函数来分别抓取操作系统的内存总量和闲置的内存,用法如下:

const os = require("os");

console.log(os.freemem()); // 8488792064 (bytes)
console.log(os.totalmem()); // 33638309888 (bytes)

然而在实际应用上,只知道内存总量和闲置的内存是没什么用处的。因为现在的操作系统都倾向利用更多没有使用到的内存来做缓存和缓冲,来加速非主内存设备的 I/O 速度,当操作系统需要分配超过闲置内存大小的内存给进程使用时,不足的部份就会借由释放被用来做缓存和缓冲的内存区块来补足。所以透过 os.freemem() 所得到的闲置内存总是比操作系统实际的「可用内存」还要来得少很多,而且也愈来愈没有参考价值了。

在 Linux 系统上,常会使用 free 或是 top 指令来查看操作系统的内存信息。例如:

free -b

以 free -b 查看内存信息

              total        used        free      shared  buff/cache   available
Mem:    33638309888  6050537472  8488792064   185831424 19098980352 26580381696
置换:           0           0           0

其中选项「-b」表示内存大小的单位为字节(byte)。而且可以看到光是内存信息就有分 total、used、free、shared、buff/cache、available 这几个字段,甚至还有「Mem(主内存 RAM)」和「置换(Swap)」两列,这比起 Node.js 内置提供的 totalmem 和 freemem 还要多了很多个项目能参考。

先来看主内存的部份,total 的部份指的就是主内存的大小,其数值会和 Node.js 内置的 os 模块的 totalmem 相同。used 的部份指的是已被使用的内存,也就是 total 减去 free 和 buff/cache 的值,不包含被用来做缓存和缓冲的部份。由于共享内存会被算在缓存中,所以 used 也不包含共享内存。free 是完全没被使用到的闲置内存,其数值会和 Node.js 内置的 os 模块的「freemem」相同。shared 是可供不同进程(Process)一起使用的共享内存。buff/cache 是缓存和缓冲还有用来管理其他内存的 Slab 缓存(Slab Allocator)所占用的内存。available 则才是操作系统目前真正的「可用内存」。

再来是置换空间(Swap)的部份,因为置换空间是把次级保存器(Secondary Storage)或是外部保存器(External Storage)作为内存使用,速度不快,通常会是在主内存不够用的情况下才会去使用,但着实可以成为操作系统可用内存的一部份。因此在计算操作系统真正最高可以配置的可用内存大小的时候,会把主内存的 available 和置换空间的 free 相加,也就是说,如果进程需要配置的内存大小超过这个值的话,操作系统将会因为没有足够的内存能够使用而导致当机。

回到 Node.js 的主题上,那么要如何使用 Node.js 来得知这些详细的内存信息呢?Linux 系统的话,可以透过读取 /proc/meminfo 这个文件来取得实时的内存信息。顺带一提,free 和 top 指令在程序实作上其实也是去读取 /proc/meminfo 再将信息编排出来。

使用 cat 指令来读取 /proc/meminfo 文件:

cat /proc/meminfo

以 cat 读取 /proc/meminfo

MemTotal:       32849912 kB
MemFree:         7000712 kB
MemAvailable:   24702036 kB
Buffers:           50048 kB
Cached:         17159880 kB
SwapCached:            0 kB
Active:         19296416 kB
Inactive:        4682504 kB
Active(anon):    6772572 kB
Inactive(anon):   204088 kB
Active(file):   12523844 kB
Inactive(file):  4478416 kB
Unevictable:        1016 kB
Mlocked:            1016 kB
SwapTotal:             0 kB
SwapFree:              0 kB
Dirty:               896 kB
Writeback:             0 kB
AnonPages:       5993088 kB
Mapped:          1352728 kB
Shmem:            207672 kB
Slab:            1506992 kB
SReclaimable:    1169828 kB
SUnreclaim:       337164 kB
KernelStack:       25180 kB
PageTables:        99816 kB
NFS_Unstable:          0 kB
Bounce:                0 kB
WritebackTmp:          0 kB
CommitLimit:    16424956 kB
Committed_AS:   20239936 kB
VmallocTotal:   34359738367 kB
VmallocUsed:           0 kB
VmallocChunk:          0 kB
HardwareCorrupted:     0 kB
AnonHugePages:   2236416 kB
ShmemHugePages:        0 kB
ShmemPmdMapped:        0 kB
CmaTotal:              0 kB
CmaFree:               0 kB
HugePages_Total:       0
HugePages_Free:        0
HugePages_Rsvd:        0
HugePages_Surp:        0
Hugepagesize:       2048 kB
DirectMap4k:     4365648 kB
DirectMap2M:    29093888 kB
DirectMap1G:     1048576 kB

透过 /proc/meminfo 文件可以得到非常详细的内存信息,只要在 Node.js 中使用文件相关的模块去读取 /proc/meminfo 的内容回来,再去解析(parse)有用的信息即可。当然,也可以直接用底下将要介绍的模块。

node-meminfo

node-meminfo 是一个使用 Node.js 8 之后才支持的 N-API 所开发的模块,使用 Rust 语言来读取 Linux 操作系统中的 /proc/meminfo 所保存的内存信息。

npmjs.com

npm 安装指令

npm install node-meminfo

使用方法

使用模块提供的 meminfo 函数可以完整地取得 /proc/meminfo 所保存的内存信息,用法如下:

import { meminfo } from "node-meminfo";

console.log(meminfo());
/*
{
    MemTotal: 33638309888,
    MemFree: 6813110272,
    MemAvailable: 25217355776,
    Buffers: 45658112,
    Cached: 17956536320,
    SwapCached: 0,
    Active: 20752044032,
    Inactive: 4362379264,
    'Active(anon)': 7117885440,
    'Inactive(anon)': 199598080,
    'Active(file)': 13634158592,
    'Inactive(file)': 4162781184,
    Unevictable: 1343488,
    Mlocked: 1343488,
    SwapTotal: 0,
    SwapFree: 0,
    Dirty: 1826816,
    Writeback: 0,
    AnonPages: 6723411968,
    Mapped: 1297338368,
    Shmem: 205258752,
    Slab: 1387651072,
    SReclaimable: 1089368064,
    SUnreclaim: 298283008,
    KernelStack: 23089152,
    PageTables: 84766720,
    NFS_Unstable: 0,
    Bounce: 0,
    WritebackTmp: 0,
    CommitLimit: 16819154944,
    Committed_AS: 18899087360,
    VmallocTotal: 35184372087808,
    VmallocUsed: 0,
    VmallocChunk: 0,
    HardwareCorrupted: 0,
    AnonHugePages: 3951034368,
    ShmemHugePages: 0,
    ShmemPmdMapped: 0,
    CmaTotal: 0,
    CmaFree: 0,
    HugePages_Total: 0,
    HugePages_Free: 0,
    HugePages_Rsvd: 0,
    HugePages_Surp: 0,
    Hugepagesize: 2097152,
    DirectMap4k: 3071623168,
    DirectMap2M: 26895974400,
    DirectMap1G: 5368709120
}
*/

这里要注意的是,模块取得的数值所用的单位是字节(byte),而不是 /proc/meminfo 原先的 KB。

另外,若您像笔者一样比较习惯 free 指令所提供的信息格式的话,也可以使用模块提供的 free 函数来取得内存信息,用法如下:

import { free } from "node-meminfo";

console.log(free());
/*
{ 
    mem: { 
        total: 33638309888,
        used: 7504060416,
        free: 6697676800,
        shared: 211382272,
        buff: 45658112,
        cache: 19390914560,
        available: 25142546432
    },
    swap: {
        total: 0,
        used: 0, 
        free: 0,
        cache: 0
    }
}
*/