使用堆快照

您可以从正在运行的应用程序中获取堆快照，并将其加载到 Chrome 开发者工具中，以检查某些变量或检查保留大小。您还可以比较多个快照以查看随时间的变化。

警告

创建快照时，主线程中的所有其他工作都将停止。根据堆内容，甚至可能需要一分钟以上。快照是在内存中构建的，因此可能会使堆大小加倍，导致填满所有内存，然后使应用程序崩溃。

如果您要在生产环境中获取堆快照，请确保您从中获取快照的进程可以在不影响应用程序可用性的情况下崩溃。

操作方法

获取堆快照

有多种方法可以获取堆快照

通过检查器，
通过外部信号和命令行标志，
通过进程内的 writeHeapSnapshot 调用，
通过检查器协议。

1. 使用检查器中的内存分析

适用于所有积极维护的 Node.js 版本

使用 --inspect 标志运行 node 并打开检查器。

获取堆快照的最简单方法是将检查器连接到本地运行的进程。然后转到“内存”选项卡并获取堆快照。

2. 使用 `--heapsnapshot-signal` 标志

适用于 v12.0.0 或更高版本

您可以使用命令行标志启动 node，启用对信号做出反应以创建堆快照。

$ node --heapsnapshot-signal=SIGUSR2 index.js

有关详细信息，请参阅 heapsnapshot-signal 标志的最新文档。

3. 使用 `writeHeapSnapshot` 函数

适用于 v11.13.0 或更高版本。可以与 heapdump 包一起用于旧版本

如果您需要从工作进程获取快照，例如在服务器上运行的应用程序，您可以实现使用以下方法获取它

require('v8').writeHeapSnapshot();

查看 writeHeapSnapshot 文档了解文件名选项。

您需要有一种无需停止进程即可调用它的方法，因此建议在 HTTP 处理程序中或作为对来自操作系统的信号的反应来调用它。小心不要公开触发快照的 HTTP 端点。应该不允许其他人访问它。

对于 v11.13.0 之前的 Node.js 版本，您可以使用 heapdump 包。

4. 使用检查器协议触发堆快照

检查器协议可用于从进程外部触发堆快照。

没有必要从 Chromium 运行实际的检查器来使用 API。

这是一个在 bash 中使用 websocat 和 jq 的快照触发器示例

#!/bin/bash
set -e

kill -USR1 "$1"
rm -f fifo out
mkfifo ./fifo
websocat -B 10000000000 "$(curl -s http://localhost:9229/json | jq -r '.[0].webSocketDebuggerUrl')" < ./fifo > ./out &
exec 3>./fifo
echo '{"method": "HeapProfiler.enable", "id": 1}' > ./fifo
echo '{"method": "HeapProfiler.takeHeapSnapshot", "id": 2}' > ./fifo
while jq -e "[.id != 2, .result != {}] | all" < <(tail -n 1 ./out); do
  sleep 1s
  echo "Capturing Heap Snapshot..."
done

echo -n "" > ./out.heapsnapshot
while read -r line; do
  f="$(echo "$line" | jq -r '.params.chunk')"
  echo -n "$f" >> out.heapsnapshot
  i=$((i+1))
done < <(cat out | tail -n +2 | head -n -1)

exec 3>&-

以下是可以与检查器协议一起使用的内存分析工具的不完整列表

OpenProfiling for Node.js

如何使用堆快照查找内存泄漏

您可以通过比较两个快照来查找内存泄漏。重要的是确保快照差异不包含不必要的信息。以下步骤应产生快照之间的清晰差异。

让进程加载所有源并完成引导。它最多应该需要几秒钟。
开始使用您怀疑会泄漏内存的功能。它很可能会进行一些初始分配，而不是泄漏的分配。
获取一个堆快照。
继续使用该功能一段时间，最好不要在中间运行任何其他东西。
获取另一个堆快照。两者之间的差异应主要包含泄漏的内容。
打开 Chromium/Chrome 开发工具并转到内存选项卡
首先加载较旧的快照文件，然后加载较新的快照文件。
选择较新的快照，然后在顶部的下拉列表中将模式从摘要切换到比较。
查找大的正增量，并在底部面板中浏览导致它们的引用。

您可以通过此堆快照练习来练习捕获堆快照和查找内存泄漏。

Node.js 简介