Node.js v18.18.2 文档

node:trace_events模块#

Tracing对象#

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

创建后，Tracing对象将被禁用。调用 tracing.enable()方法将类别添加到启用的跟踪事件类别集中。调用tracing.disable()将从启用的跟踪事件类别集中删除类别。

tracing.categories#

• <字符串>

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

tracing.disable()#

禁用此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()); copy

tracing.enable()#

为Tracing对象涵盖的类别集 启用此Tracing对象。

tracing.enabled#

• <boolean> true仅当Tracing对象已启用时。

trace_events.createTracing(options)#

• options <对象>
  • categories <string[]>跟踪类别名称数组。如果可能，数组中包含的值将被强制转换为字符串。如果无法强制转换该值，则会抛出错误。
• 返回：<跟踪>。

为给定的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(); copy

trace_events.getEnabledCategories()#

• 返回：<字符串>

返回所有当前启用的跟踪事件类别的逗号分隔列表。当前启用的跟踪事件类别集由所有当前启用的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()); 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