trace_events

Модуль node:trace_events предоставляет механизм централизованного сбора данных трассировки, генерируемых V8, ядром Node.js и пользовательским кодом.

Трассировку можно включить с помощью флага командной строки --trace-event-categories или модуля trace_events. Флаг --trace-event-categories принимает список имен категорий, разделенных запятыми.

Доступны следующие категории:

• node: пустой заполнитель.
• node.async_hooks: включает сбор подробных данных трассировки async_hooks. События async_hooks имеют уникальный asyncId и специальное свойство triggerId triggerAsyncId.
• node.bootstrap: включает сбор данных об этапах загрузки Node.js.
• node.console: включает сбор вывода console.time() и console.count().
• node.threadpoolwork.sync: включает сбор данных трассировки синхронных операций пула потоков, таких как blob, zlib, crypto и node_api.
• node.threadpoolwork.async: включает сбор данных трассировки асинхронных операций пула потоков, таких как blob, zlib, crypto и node_api.
• node.dns.native: включает сбор данных трассировки DNS-запросов.
• node.net.native: включает сбор данных трассировки для сети.
• node.environment: включает сбор данных об этапах среды Node.js.
• node.fs.sync: включает сбор данных трассировки синхронных методов файловой системы.
• node.fs_dir.sync: включает сбор данных трассировки синхронных методов каталогов файловой системы.
• node.fs.async: включает сбор данных трассировки асинхронных методов файловой системы.
• node.fs_dir.async: включает сбор данных трассировки асинхронных методов каталогов файловой системы.
• node.perf: включает сбор измерений API производительности.
  • node.perf.usertiming: включает сбор только пользовательских измерений и меток времени API производительности.
  • node.perf.timerify: включает сбор только измерений timerify API производительности.
• node.promises.rejections: включает сбор данных трассировки, отслеживающих количество необработанных отклонений Promise и отклонений, обработанных после возникновения.
• node.vm.script: включает сбор данных трассировки для методов runInNewContext(), runInContext() и runInThisContext() модуля node:vm.
• v8: события V8 связаны со сборкой мусора, компиляцией и выполнением.
• node.http: включает сбор данных трассировки HTTP-запросов и ответов.

По умолчанию включены категории node, node.async_hooks и v8.

node --trace-event-categories v8,node,node.async_hooks server.js

В предыдущих версиях Node.js для включения событий трассировки требовалось использовать флаг --trace-events-enabled. Это требование было отменено. Однако флаг --trace-events-enabled можно использовать; по умолчанию он включает категории событий трассировки node, node.async_hooks и v8.

node --trace-events-enabled


node --trace-event-categories v8,node,node.async_hooks

Кроме того, события трассировки можно включить с помощью модуля node:trace_events:

import trace_events from 'node:trace_events';
const tracing = trace_events.createTracing({ categories: ['node.perf'] });
tracing.enable();  // Enable trace event capture for the 'node.perf' category

// do work

tracing.disable();  // Disable trace event capture for the 'node.perf' category

При запуске Node.js с включенной трассировкой создаются файлы журнала, которые можно открыть на вкладке chrome://tracing в Chrome.

По умолчанию файл журнала называется node_trace.${rotation}.log, где ${rotation} — идентификатор ротации журнала, который увеличивается при каждой ротации. Шаблон пути к файлу можно задать с помощью --trace-event-file-pattern, принимающего строку шаблона с поддержкой ${rotation} и ${pid}:

node --trace-event-categories v8 --trace-event-file-pattern '${pid}-${rotation}.log' server.js

Чтобы гарантировать правильное создание файла журнала после таких сигнальных событий, как SIGINT, SIGTERM или SIGBREAK, предусмотрите в коде соответствующие обработчики, например:

process.on('SIGINT', function onSigint() {
  console.info('Received SIGINT.');
  process.exit(130);  // Or applicable exit code depending on OS and signal
});

Система трассировки использует тот же источник времени, что и process.hrtime(). Однако временные метки событий трассировки выражаются в микросекундах, в отличие от process.hrtime(), возвращающего наносекунды.

Функции этого модуля недоступны в потоках Worker.