Node.js v18.18.2 文档

inspector.close()#

停用检查员。阻塞直到没有事件连接。

当使用Session时，控制台 API 输出的对象不会被释放，除非我们手动执行Runtime.DiscardConsoleEntries 命令。

inspector.console#

• <Object>用于向远程检查器控制台发送消息的对象。

require('node:inspector').console.log('a message'); copy

检查器控制台不具有与 Node.js 控制台相同的 API。

inspector.open([port[, host[, wait]]])#

• port <number>用于侦听检查器连接的端口。选修的。 默认值： CLI 上指定的内容。
• host <string>用于侦听检查器连接的主机。选修的。 默认值： CLI 上指定的内容。
• wait <boolean>阻止，直到客户端连接。选修的。 默认值： false。

激活主机和端口上的检查器。相当于 node --inspect=[[host:]port]，但可以在节点启动后以编程方式完成。

如果 wait 为true，则将阻塞，直到客户端连接到检查端口并且流控制已传递到调试器客户端。

请参阅有关host参数使用的安全警告 。

inspector.url()#

• 返回：<字符串> | <未定义>

返回事件检查器的 URL，如果没有，则返回undefined 。

$ node --inspect -p 'inspector.url()'
Debugger listening on ws://127.0.0.1:9229/166e272e-7a30-4d09-97ce-f1c012b43c34
For help, see: https://nodejs.org/en/docs/inspector
ws://127.0.0.1:9229/166e272e-7a30-4d09-97ce-f1c012b43c34

$ node --inspect=localhost:3000 -p 'inspector.url()'
Debugger listening on ws://localhost:3000/51cf8d0e-3c36-4c59-8efd-54519839e56a
For help, see: https://nodejs.org/en/docs/inspector
ws://localhost:3000/51cf8d0e-3c36-4c59-8efd-54519839e56a

$ node -p 'inspector.url()'
undefined copy

inspector.waitForDebugger()#

阻塞，直到客户端（现有的或稍后连接的）发送了 Runtime.runIfWaitingForDebugger命令。

如果没有事件的检查器，则会抛出异常。

类：inspector.Session#

• 扩展：<EventEmitter>

inspector.Session用于将消息分派到 V8 检查器后端并接收消息响应和通知。

new inspector.Session()#

创建inspector.Session类的新实例。检查器会话需要通过session.connect()连接，然后才能将消息分派到检查器后端。

当使用Session时，控制台 API 输出的对象不会被释放，除非我们手动执行Runtime.DiscardConsoleEntries 命令。

事件：'inspectorNotification'#

• <Object>通知消息对象

当收到来自 V8 Inspector 的任何通知时发出。

session.on('inspectorNotification', (message) => console.log(message.method));
// Debugger.paused
// Debugger.resumed copy

也可以仅使用特定方法订阅通知：

事件：<inspector-protocol-method>；#

• <Object>通知消息对象

当收到方法字段设置为<inspector-protocol-method>值的检查器通知时发出。

以下代码片段在'Debugger.paused' 事件上安装一个侦听器，并在程序执行暂停时（例如通过断点）打印程序暂停的原因：

session.on('Debugger.paused', ({ params }) => {
  console.log(params.hitBreakpoints);
});
// [ '/the/file/that/has/the/breakpoint.js:11:0' ] copy

session.connect()#

将会话连接到检查器后端。

session.connectToMainThread()#

将会话连接到主线程检查器后端。如果未在 Worker 线程上调用此 API，则会抛出异常。

session.disconnect()#

立即关闭会话。所有挂起的消息回调将被调用并出现错误。需要调用session.connect()才能再次发送消息。重新连接的会话将丢失所有检查器状态，例如启用的代理或配置的断点。

session.post(method[, params][, callback])#

• method <字符串>
• params <对象>
• callback <函数>

向检查员后端发布消息。收到回复后，callback将收到通知。callback是一个接受两个可选参数的函数：错误和特定于消息的结果。

session.post('Runtime.evaluate', { expression: '2 + 2' },
             (error, { result }) => console.log(result));
// Output: { type: 'number', value: 4, description: '4' } copy

最新版本的 V8 检查器协议已发布在 Chrome DevTools Protocol Viewer上。

Node.js 检查器支持 V8 声明的所有 Chrome DevTools 协议域。Chrome DevTools 协议域提供了一个接口，用于与用于检查应用程序状态并侦听运行时事件的运行时代理之一进行交互。

向 V8发送 HeapProfiler.takeHeapSnapshot或HeapProfiler.stopTrackingHeapObjects命令时，不能将 reportProgress 设置为 true。

用法示例#

除了调试器之外，还可以通过 DevTools 协议使用各种 V8 Profiler。

CPU分析器#

以下示例展示了如何使用CPU Profiler：

const inspector = require('node:inspector');
const fs = require('node:fs');
const session = new inspector.Session();
session.connect();

session.post('Profiler.enable', () => {
  session.post('Profiler.start', () => {
    // Invoke business logic under measurement here...

    // some time later...
    session.post('Profiler.stop', (err, { profile }) => {
      // Write profile to disk, upload, etc.
      if (!err) {
        fs.writeFileSync('./profile.cpuprofile', JSON.stringify(profile));
      }
    });
  });
}); copy

堆分析器#

下面的示例展示了如何使用堆分析器：

const inspector = require('node:inspector');
const fs = require('node:fs');
const session = new inspector.Session();

const fd = fs.openSync('profile.heapsnapshot', 'w');

session.connect();

session.on('HeapProfiler.addHeapSnapshotChunk', (m) => {
  fs.writeSync(fd, m.params.chunk);
});

session.post('HeapProfiler.takeHeapSnapshot', null, (err, r) => {
  console.log('HeapProfiler.takeHeapSnapshot done:', err, r);
  session.disconnect();
  fs.closeSync(fd);
}); copy