跟踪事件#

稳定性：1 - 实验性

源代码： 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：启用捕获 性能 API 度量。
    • node.perf.usertiming：启用仅捕获性能 API 用户计时测量和标记。
    • node.perf.timerify：启用仅捕获性能 API timerify 测量。
  • node.promises.rejections：启用捕获跟踪未处理的 Promise 拒绝和拒绝后处理数量的跟踪数据。
  • node.vm.script：启用捕获 node:vm 模块的 runInNewContext()、runInContext() 和 runInThisContext() 方法的跟踪数据。
  • v8： V8 事件与 GC、编译和执行相关。
  • 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

# is equivalent to

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

或者，可以使用 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

在启用跟踪的情况下运行 Node.js 将生成日志文件，这些文件可以在 Chrome 的 chrome://tracing 选项卡中打开。

默认情况下，日志文件名为 node_trace.${rotation}.log，其中 ${rotation} 是递增的日志轮换 ID。可以使用 --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 线程中不可用。

node:trace_events 模块#

添加于：v10.0.0

Tracing 对象#

添加于：v10.0.0

Tracing 对象用于启用或禁用对一组类别的跟踪。实例使用 trace_events.createTracing() 方法创建。

创建时，Tracing 对象处于禁用状态。调用 tracing.enable() 方法会将类别添加到已启用的跟踪事件类别集中。调用 tracing.disable() 将从已启用的跟踪事件类别集中删除类别。

tracing.categories#
添加于：v10.0.0

此 Tracing 对象涵盖的跟踪事件类别的逗号分隔列表。

tracing.disable()#
添加于：v10.0.0

禁用此 Tracing 对象。

只有未被其他已启用的 Tracing 对象涵盖且未由 --trace-event-categories 标志指定的跟踪事件类别将被禁用。

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());
tracing.enable()#
添加于：v10.0.0

启用此 Tracing 对象，以涵盖 Tracing 对象所包含的类别集。

tracing.enabled#
添加于：v10.0.0
  • <boolean> 仅当 Tracing 对象已启用时为 true。

trace_events.createTracing(options)#

添加于：v10.0.0
  • options <Object>
    • categories <string[]> 跟踪类别名称数组。数组中包含的值在可能的情况下会强制转换为字符串。如果值无法强制转换，则会抛出错误。
  • 返回值：<Tracing>.

为给定的 categories 集创建并返回 Tracing 对象。

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();

trace_events.getEnabledCategories()#

添加于：v10.0.0

返回所有当前启用的跟踪事件类别的逗号分隔列表。当前启用的跟踪事件类别集由所有当前启用的 Tracing 对象和使用 --trace-event-categories 标志启用的任何类别的并集决定。

给定下面的文件 test.js，命令 node --trace-event-categories node.perf test.js 将在控制台中打印 'node.async_hooks,node.perf'。

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());

示例#

通过检查器收集跟踪事件数据#

'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();