new inspector.Session()

Создает новый экземпляр класса inspector.Session. Перед отправкой сообщений серверной части инспектора необходимо подключить сессию инспектора с помощью session.connect().

При использовании Session объект, выведенный API консоли, не будет освобожден, если только мы не выполним вручную команду Runtime.DiscardConsoleEntries.

Событие: 'inspectorNotification'

• Тип: <Object> Объект сообщения уведомления

Возникает при получении любого уведомления от инспектора V8.

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

Предупреждение Не рекомендуется устанавливать точки останова в сессии в том же потоке; см. поддержку точек останова.

Также можно подписаться только на уведомления с определенным методом:

Событие: <inspector-protocol-method>

• Тип: <Object> Объект сообщения уведомления

Возникает при получении уведомления инспектора, поле method которого имеет значение <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()

Подключает сессию к серверной части инспектора главного потока. Если этот API вызван не в потоке Worker, будет выброшено исключение.

session.disconnect()

Немедленно закрывает сессию. Для всех ожидающих обратных вызовов сообщений будет вызвана функция с ошибкой. Чтобы снова отправлять сообщения, необходимо вызвать session.connect(). После повторного подключения сессия потеряет все состояние инспектора, например включенные агенты или настроенные точки останова.

session.post(method[, params])

• method <string>
• params <Object>
• Возвращает: <Promise>

Отправляет сообщение серверной части инспектора.

import { Session } from 'node:inspector/promises';
try {
  const session = new Session();
  session.connect();
  const result = await session.post('Runtime.evaluate', { expression: '2 + 2' });
  console.log(result);
} catch (error) {
  console.error(error);
}
// Output: { result: { type: 'number', value: 4, description: '4' } } copy

Последняя версия протокола инспектора V8 опубликована в средстве просмотра протокола Chrome DevTools.

Инспектор Node.js поддерживает все домены протокола Chrome DevTools, объявленные V8. Домен протокола Chrome DevTools предоставляет интерфейс для взаимодействия с одним из агентов среды выполнения, используемых для проверки состояния приложения и прослушивания событий во время выполнения.

Пример использования

Помимо отладчика, через протокол DevTools доступны различные профилировщики V8.

import { Session } from 'node:inspector/promises';
import fs from 'node:fs';
const session = new Session();
session.connect();

await session.post('Profiler.enable');
await session.post('Profiler.start');
// Invoke business logic under measurement here...

// some time later...
const { profile } = await session.post('Profiler.stop');

// Write profile to disk, upload, etc.
fs.writeFileSync('./profile.cpuprofile', JSON.stringify(profile)); copy

import { Session } from 'node:inspector/promises';
import fs from 'node:fs';
const session = new Session();

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

session.connect();

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

const result = await session.post('HeapProfiler.takeHeapSnapshot', null);
console.log('HeapProfiler.takeHeapSnapshot done:', result);
session.disconnect();
fs.closeSync(fd); copy

new inspector.Session()

Создает новый экземпляр класса inspector.Session. Перед отправкой сообщений серверной части инспектора необходимо подключить сессию инспектора с помощью session.connect().

При использовании Session объект, выведенный API консоли, не будет освобожден, если только мы не выполним вручную команду Runtime.DiscardConsoleEntries.

Событие: 'inspectorNotification'

• Тип: <Object> Объект сообщения уведомления

Возникает при получении любого уведомления от инспектора V8.

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

Предупреждение Не рекомендуется устанавливать точки останова в сессии в том же потоке; см. поддержку точек останова.

Также можно подписаться только на уведомления с определенным методом:

Событие: <inspector-protocol-method>;

• Тип: <Object> Объект сообщения уведомления

Возникает при получении уведомления инспектора, поле method которого имеет значение <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()

Подключает сессию к серверной части инспектора главного потока. Если этот API вызван не в потоке Worker, будет выброшено исключение.

session.disconnect()

Немедленно закрывает сессию. Для всех ожидающих обратных вызовов сообщений будет вызвана функция с ошибкой. Чтобы снова отправлять сообщения, необходимо вызвать session.connect(). После повторного подключения сессия потеряет все состояние инспектора, например включенные агенты или настроенные точки останова.

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

• method <string>
• params <Object>
• callback <Function>

Отправляет сообщение серверной части инспектора. Когда будет получен ответ, будет вызван 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.

Инспектор Node.js поддерживает все домены протокола Chrome DevTools, объявленные V8. Домен протокола Chrome DevTools предоставляет интерфейс для взаимодействия с одним из агентов среды выполнения, используемых для проверки состояния приложения и прослушивания событий во время выполнения.

Нельзя задавать reportProgress значение true при отправке в V8 команды HeapProfiler.takeHeapSnapshot или HeapProfiler.stopTrackingHeapObjects.

Пример использования

Помимо отладчика, через протокол DevTools доступны различные профилировщики V8.

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