Использование Heap Snapshot

Вы можете снять Heap Snapshot (снимок кучи) с работающего приложения и загрузить его в Chrome Developer Tools, чтобы инспектировать определённые переменные или проверить размер удерживающих ссылок (retainer). Можно также сравнивать несколько снапшотов, чтобы увидеть различия во времени.

Предупреждение

При создании снапшота вся остальная работа в главном потоке останавливается. В зависимости от содержимого кучи это может занять даже больше минуты. Снапшот строится в памяти, поэтому может удвоить размер кучи, в результате заполнив всю память и уронив приложение.

Если вы собираетесь снимать heap snapshot в production, убедитесь, что процесс, с которого вы его снимаете, может упасть, не влияя на доступность вашего приложения.

Как это сделать

Получить Heap Snapshot

Есть несколько способов получить heap snapshot:

через inspector,
через внешний сигнал и флаг командной строки,
через вызов writeHeapSnapshot внутри процесса,
через протокол inspector.

1. Использовать профилирование памяти в inspector

Работает во всех активно поддерживаемых версиях Node.js

Запустите node с флагом --inspect и откройте inspector. ![открыть inspector][open inspector image]

Самый простой способ получить Heap Snapshot — подключить inspector к вашему процессу, работающему локально. Затем перейдите на вкладку Memory и снимите heap snapshot.

![снять heap snapshot][take a heap snapshot image]

2. Использовать флаг `--heapsnapshot-signal`

Работает в v12.0.0 или новее

Можно запустить node с флагом командной строки, включающим реакцию на сигнал для создания heap snapshot.

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

Подробнее см. актуальную документацию флага heapsnapshot-signal.

3. Использовать функцию `writeHeapSnapshot`

Работает в v11.13.0 или новее Может работать в более старых версиях с пакетом heapdump

Если вам нужен снапшот с работающего процесса, например приложения, работающего на сервере, вы можете реализовать его получение так:

require('node:v8').writeHeapSnapshot();

Смотрите документацию writeHeapSnapshot для опций имени файла.

Вам нужен способ вызвать её, не останавливая процесс, поэтому советуем вызывать её в HTTP-обработчике или как реакцию на сигнал операционной системы. Будьте осторожны, чтобы не выставить наружу HTTP-эндпоинт, инициирующий снапшот. Ни у кого другого не должно быть возможности до него достучаться.

Для версий Node.js до v11.13.0 можно использовать пакет heapdump.

4. Инициировать Heap Snapshot через протокол inspector

Протокол inspector можно использовать, чтобы инициировать Heap Snapshot извне процесса.

Чтобы использовать этот API, не обязательно запускать настоящий inspector из Chromium.

Вот пример триггера снапшота в 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>&-

Shell

Вот неполный список инструментов профилирования памяти, пригодных для использования с протоколом inspector:

OpenProfiling for Node.js

Как найти утечку памяти с помощью Heap Snapshot

Найти утечку памяти можно, сравнив два снапшота. Важно убедиться, что разница между снапшотами не содержит лишней информации. Следующие шаги должны дать чистый diff между снапшотами.

Дайте процессу загрузить все исходники и закончить бутстрап. Это должно занять максимум несколько секунд.
Начните использовать функциональность, которую вы подозреваете в утечке памяти. Скорее всего, она делает некоторые начальные аллокации, которые не являются утекающими.
Снимите один heap snapshot.
Продолжайте использовать функциональность какое-то время, желательно не запуская ничего другого в промежутке.
Снимите ещё один heap snapshot. Разница между двумя должна в основном содержать то, что утекало.
Откройте dev tools в Chromium/Chrome и перейдите на вкладку Memory
Загрузите сначала более старый файл снапшота, а вторым — более новый. ![Кнопка Load в инструментах][load button image]
Выберите более новый снапшот и переключите режим в выпадающем списке сверху с Summary на Comparison. ![Выпадающий список Comparison][comparison image]
Ищите большие положительные дельты и исследуйте ссылки, которые их вызвали, в нижней панели.

Вы можете попрактиковаться в снятии heap snapshot и поиске утечек памяти с этим упражнением по heap snapshot.