События трассировки

Исходный код: lib/trace_events.js

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

Трассировку можно включить с помощью флага командной строки --trace-event-categories или с помощью модуля node: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: Включает захват измерений Performance API.
  • node.perf.usertiming: Включает захват только измерений и меток Performance API User Timing.
  • node.perf.timerify: Включает захват только измерений Performance API timerify.
• node.promises.rejections: Включает захват данных трассировки, отслеживающих количество необработанных отклонений Promise и обработанных после отклонений.
• node.vm.script: Включает захват данных трассировки для методов node:vm, runInNewContext(), runInContext() и runInThisContext() модуля node.vm.script.
• v8: События V8 связаны с GC, компиляцией и выполнением.
• node.http: Включает захват данных трассировки для HTTP-запросов/ответов.

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

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

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

node --trace-events-enabled

# is equivalent to

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

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

const trace_events = require('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 copy

Запуск 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 copy

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

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

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

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

const trace_events = require('node:trace_events');
const t1 = trace_events.createTracing({ categories: ['node', 'v8'] });
const t2 = trace_events.createTracing({ categories: ['node.perf', 'node'] });
t1.enable();
t2.enable();

// Prints 'node,node.perf,v8'
console.log(trace_events.getEnabledCategories());

t2.disable(); // Will only disable emission of the 'node.perf' category

// Prints 'node,v8'
console.log(trace_events.getEnabledCategories()); copy

const trace_events = require('node:trace_events');
const categories = ['node.perf', 'node.async_hooks'];
const tracing = trace_events.createTracing({ categories });
tracing.enable();
// do stuff
tracing.disable(); copy

const trace_events = require('node:trace_events');
const t1 = trace_events.createTracing({ categories: ['node.async_hooks'] });
const t2 = trace_events.createTracing({ categories: ['node.perf'] });
const t3 = trace_events.createTracing({ categories: ['v8'] });

t1.enable();
t2.enable();

console.log(trace_events.getEnabledCategories()); copy

'use strict';

const { Session } = require('inspector');
const session = new Session();
session.connect();

function post(message, data) {
  return new Promise((resolve, reject) => {
    session.post(message, data, (err, result) => {
      if (err)
        reject(new Error(JSON.stringify(err)));
      else
        resolve(result);
    });
  });
}

async function collect() {
  const data = [];
  session.on('NodeTracing.dataCollected', (chunk) => data.push(chunk));
  session.on('NodeTracing.tracingComplete', () => {
    // done
  });
  const traceConfig = { includedCategories: ['v8'] };
  await post('NodeTracing.start', { traceConfig });
  // do something
  setTimeout(() => {
    post('NodeTracing.stop').then(() => {
      session.disconnect();
      console.log(data);
    });
  }, 1000);
}

collect(); copy