perf_hooks

Дополнительные сведения, относящиеся к entryType.

Общее количество миллисекунд, прошедших с момента создания этой записи. Это значение имеет смысл не для всех типов записей производительности.

Тип записи производительности. Это может быть одно из следующих значений:

• 'node' (только в Node.js)
• 'mark' (доступно в вебе)
• 'measure' (доступно в вебе)
• 'gc' (только в Node.js)
• 'function' (только в Node.js)
• 'http2' (только в Node.js)
• 'http' (только в Node.js)

Имя записи производительности.

Высокоточная временная метка в миллисекундах, обозначающая время начала записи производительности.

Высокоточная временная метка в миллисекундах, указывающая момент завершения начальной загрузки процесса Node.js. Если начальная загрузка ещё не завершена, значение свойства равно -1.

Высокоточная временная метка в миллисекундах, указывающая момент инициализации среды Node.js.

Высокоточная временная метка в миллисекундах, указывающая время простоя цикла событий внутри поставщика событий цикла событий (например, epoll_wait). Загрузка ЦП не учитывается. Если цикл событий ещё не запущен (например, на первом тике основного скрипта), значение свойства равно 0.

Высокоточная временная метка в миллисекундах, указывающая момент выхода из цикла событий Node.js. Если цикл событий ещё не завершился, значение свойства равно -1. Значение, отличное от -1, может быть только в обработчике события 'exit'.

Высокоточная временная метка в миллисекундах, указывающая момент запуска цикла событий Node.js. Если цикл событий ещё не запущен (например, на первом тике основного скрипта), значение свойства равно -1.

Высокоточная временная метка в миллисекундах, указывающая момент инициализации процесса Node.js.

Это оболочка для функции uv_metrics_info. Она возвращает текущий набор метрик цикла событий.

Рекомендуется использовать это свойство внутри функции, выполнение которой запланировано с помощью setImmediate, чтобы избежать сбора метрик до завершения всех операций, запланированных на текущую итерацию цикла.

Высокоточная временная метка в миллисекундах, указывающая момент инициализации платформы V8.

Отключает экземпляр PerformanceObserver от всех уведомлений.

Подписывает экземпляр PerformanceObserver на уведомления о новых экземплярах PerformanceEntry, определяемых с помощью options.entryTypes или options.type:

import {
  performance,
  PerformanceObserver,
} from 'node:perf_hooks';

const obs = new PerformanceObserver((list, observer) => {
  // Called once asynchronously. `list` contains three items.
});
obs.observe({ type: 'mark' });

for (let n = 0; n < 3; n++)
  performance.mark(`test${n}`);

Возвращает список объектов PerformanceEntry в хронологическом порядке относительно performanceEntry.startTime.

import {
  performance,
  PerformanceObserver,
} from 'node:perf_hooks';

const obs = new PerformanceObserver((perfObserverList, observer) => {
  console.log(perfObserverList.getEntries());

   * [
   *   PerformanceEntry {
   *     name: 'test',
   *     entryType: 'mark',
   *     startTime: 81.465639,
   *     duration: 0,
   *     detail: null
   *   },
   *   PerformanceEntry {
   *     name: 'meow',
   *     entryType: 'mark',
   *     startTime: 81.860064,
   *     duration: 0,
   *     detail: null
   *   }
   * ]

  performance.clearMarks();
  performance.clearMeasures();
  observer.disconnect();
});
obs.observe({ type: 'mark' });

performance.mark('test');
performance.mark('meow');

Возвращает список объектов PerformanceEntry в хронологическом порядке относительно performanceEntry.startTime, у которых performanceEntry.name равно name и, необязательно, performanceEntry.entryType равноtype.

import {
  performance,
  PerformanceObserver,
} from 'node:perf_hooks';

const obs = new PerformanceObserver((perfObserverList, observer) => {
  console.log(perfObserverList.getEntriesByName('meow'));

   * [
   *   PerformanceEntry {
   *     name: 'meow',
   *     entryType: 'mark',
   *     startTime: 98.545991,
   *     duration: 0,
   *     detail: null
   *   }
   * ]

  console.log(perfObserverList.getEntriesByName('nope')); // []

  console.log(perfObserverList.getEntriesByName('test', 'mark'));

   * [
   *   PerformanceEntry {
   *     name: 'test',
   *     entryType: 'mark',
   *     startTime: 63.518931,
   *     duration: 0,
   *     detail: null
   *   }
   * ]

  console.log(perfObserverList.getEntriesByName('test', 'measure')); // []

  performance.clearMarks();
  performance.clearMeasures();
  observer.disconnect();
});
obs.observe({ entryTypes: ['mark', 'measure'] });

performance.mark('test');
performance.mark('meow');

Возвращает список объектов PerformanceEntry в хронологическом порядке относительно performanceEntry.startTime, у которых performanceEntry.entryType равно type.

import {
  performance,
  PerformanceObserver,
} from 'node:perf_hooks';

const obs = new PerformanceObserver((perfObserverList, observer) => {
  console.log(perfObserverList.getEntriesByType('mark'));

   * [
   *   PerformanceEntry {
   *     name: 'test',
   *     entryType: 'mark',
   *     startTime: 55.897834,
   *     duration: 0,
   *     detail: null
   *   },
   *   PerformanceEntry {
   *     name: 'meow',
   *     entryType: 'mark',
   *     startTime: 56.350146,
   *     duration: 0,
   *     detail: null
   *   }
   * ]

  performance.clearMarks();
  performance.clearMeasures();
  observer.disconnect();
});
obs.observe({ type: 'mark' });

performance.mark('test');
performance.mark('meow');

Метка времени с высокой точностью в миллисекундах, обозначающая момент сразу после того, как Node.js завершает установление соединения с сервером для получения ресурса.

Метка времени с высокой точностью в миллисекундах, обозначающая момент непосредственно перед тем, как Node.js начинает устанавливать соединение с сервером для получения ресурса.

Число, представляющее размер (в октетах) тела сообщения, полученного в результате выборки (по HTTP или из кэша), после удаления применённых кодировок содержимого.

Метка времени с высокой точностью в миллисекундах, обозначающая момент сразу после того, как Node.js завершает поиск доменного имени ресурса.

Метка времени с высокой точностью в миллисекундах непосредственно перед тем, как Node.js начинает поиск доменного имени ресурса.

Число, представляющее размер (в октетах) тела полезной нагрузки, полученного в результате выборки (по HTTP или из кэша), до удаления применённых кодировок содержимого.

Метка времени с высокой точностью в миллисекундах непосредственно перед тем, как Node.js начинает получать ресурс.

Метка времени с высокой точностью в миллисекундах, которая будет зафиксирована сразу после получения последнего байта ответа на последнее перенаправление.

Метка времени с высокой точностью в миллисекундах, обозначающая время начала выборки, инициирующей перенаправление.

Метка времени с высокой точностью в миллисекундах, обозначающая момент непосредственно перед тем, как Node.js получает первый байт ответа от сервера.

Метка времени с высокой точностью в миллисекундах, обозначающая момент сразу после получения Node.js последнего байта ресурса или непосредственно перед закрытием транспортного соединения — в зависимости от того, что произойдёт раньше.

Метка времени с точностью до миллисекунды и высоким разрешением, обозначающая момент непосредственно перед тем, как Node.js начинает процесс рукопожатия для защиты текущего соединения.

Число, представляющее размер (в октетах) полученного ресурса. Размер включает поля заголовка ответа и тело полезной нагрузки ответа.

Метка времени с точностью до миллисекунды и высоким разрешением, обозначающая момент непосредственно перед отправкой запроса fetch. Если ресурс не перехватывается обработчиком, свойство всегда возвращает 0.

Возвращает object, представляющий объект PerformanceResourceTiming в формате JSON

Минимальное записываемое значение. Должно быть целым числом больше 0.

Максимальное записываемое значение. Должно быть целым числом больше min.

Количество цифр точности. Должно быть числом от 1 до 5.

Частота измерений в миллисекундах. Должна быть больше нуля.

Количество выборок, записанных гистограммой.

Количество выборок, записанных гистограммой. v17.4.0, v16.14.0

Количество случаев, когда задержка цикла событий превышала максимальный порог задержки цикла событий, равный 1 часу.

Количество случаев, когда задержка цикла событий превышала максимальный порог задержки цикла событий, равный 1 часу.

Максимальная зарегистрированная задержка цикла событий.

Максимальная зарегистрированная задержка цикла событий. v17.4.0, v16.14.0

Среднее значение зарегистрированных задержек цикла событий.

Минимальная зарегистрированная задержка цикла событий.

Минимальная зарегистрированная задержка цикла событий. v17.4.0, v16.14.0

Возвращает объект Map с накопленным распределением процентилей.

Возвращает объект Map с накопленным распределением процентилей.

Стандартное отклонение зарегистрированных задержек цикла событий.

Возвращает значение для указанного процентиля.

Возвращает значение для указанного процентиля.

Сбрасывает собранные данные гистограммы.

Включает таймер интервала обновления. Возвращает true, если таймер был запущен, и false, если он уже был запущен.

Отключает таймер интервала обновления. Возвращает true, если таймер был остановлен, и false, если он уже был остановлен.

Дополнительные необязательные сведения, которые можно включить в отметку.

Необязательная временная метка, используемая в качестве времени отметки.

Дополнительные необязательные сведения, которые можно включить в отметку.

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

Временная метка, используемая в качестве времени окончания, или строка, идентифицирующая ранее записанную отметку.

Временная метка, используемая в качестве времени начала, или строка, идентифицирующая ранее записанную отметку.

Если performanceEntry.entryType равно 'gc', свойство performance.kind указывает тип выполненной операции сборки мусора. Допустимые значения см. в perf_hooks.constants.

Если performanceEntry.entryType равно 'gc', свойство performance.flags содержит дополнительную информацию об операции сборки мусора. Допустимые значения см. в perf_hooks.constants.

eventLoopUtilization похож на загрузку ЦП, но рассчитывается с использованием высокоточного астрономического времени. Он показывает, какой процент времени цикл обработки событий провёл вне поставщика событий цикла обработки событий (например, epoll_wait). Другое время простоя ЦП не учитывается.

Это свойство является расширением Node.js. Оно недоступно в веб-браузерах.

Экземпляр класса PerformanceNodeTiming, предоставляющий показатели производительности для определённых этапов работы Node.js.

timeOrigin задаёт временную метку с точностью до миллисекунды, соответствующую моменту запуска текущего процесса node, измеренную в формате Unix.

Если name не указано, удаляет все объекты PerformanceMark из шкалы производительности. Если name указано, удаляет только пометку с указанным именем.

Если name не указано, удаляет все объекты PerformanceMeasure из шкалы производительности. Если name указано, удаляет только измерение с указанным именем.

Если name не указано, удаляет все объекты PerformanceResourceTiming из шкалы ресурсов. Если name указано, удаляет только ресурс с указанным именем.

Возвращает список объектов PerformanceEntry в хронологическом порядке относительно performanceEntry.startTime. Если вас интересуют только записи о производительности определенных типов или с определенными именами, см. performance.getEntriesByType() и performance.getEntriesByName().

Возвращает список объектов PerformanceEntry в хронологическом порядке относительно performanceEntry.startTime, у которых performanceEntry.name равно name и, при необходимости, performanceEntry.entryType равно type.

Возвращает список объектов PerformanceEntry в хронологическом порядке относительно performanceEntry.startTime, у которых performanceEntry.entryType равно type.

Создает новую запись PerformanceMark в шкале производительности. PerformanceMark — это подкласс PerformanceEntry, у которого performanceEntry.entryType всегда равно 'mark', а performanceEntry.duration всегда равно 0. Метки производительности используются для обозначения важных моментов в шкале производительности.

Созданная запись PerformanceMark добавляется в глобальную шкалу производительности, и ее можно запросить с помощью performance.getEntries, performance.getEntriesByName и performance.getEntriesByType. После выполнения наблюдения записи следует вручную удалить из глобальной шкалы производительности с помощью performance.clearMarks.

Создает новую запись PerformanceResourceTiming в шкале ресурсов. PerformanceResourceTiming — это подкласс PerformanceEntry, у которого performanceEntry.entryType всегда равно 'resource'. Ресурсы производительности используются для обозначения моментов в шкале ресурсов.

Создает новую запись PerformanceMeasure в шкале производительности. PerformanceMeasure — это подкласс PerformanceEntry, у которого performanceEntry.entryType всегда равно 'measure', а performanceEntry.duration показывает количество миллисекунд, прошедших между startMark и endMark.

Аргумент startMark может указывать на любой существующий PerformanceMark в шкале производительности или на любое из свойств временных меток, предоставляемых классом PerformanceNodeTiming. Если указанного startMark не существует, по умолчанию startMark устанавливается в значение timeOrigin.

Аргумент endMark должен указывать на любой существующий PerformanceMark в шкале производительности или на любое из свойств временных меток, предоставляемых классом PerformanceNodeTiming. Если указанного endMark не существует, будет вызвана ошибка.

Возвращает текущую высокоточную временную метку в миллисекундах, где 0 соответствует началу текущего процесса node.

Устанавливает размер глобального буфера временных характеристик ресурсов равным указанному числу объектов записей о производительности типа "resource".

По умолчанию максимальный размер буфера равен 250.

Это свойство является расширением Node.js. Оно недоступно в веб-браузерах.

Оборачивает функцию в новую функцию, которая измеряет время выполнения обёрнутой функции. Для доступа к сведениям о времени необходимо, чтобы PerformanceObserver был подписан на тип события 'function'.

import {
  performance,
  PerformanceObserver,
} from 'node:perf_hooks';

function someFunction() {
  console.log('hello world');
}

const wrapped = performance.timerify(someFunction);

const obs = new PerformanceObserver((list) => {
  console.log(list.getEntries()[0].duration);

  performance.clearMarks();
  performance.clearMeasures();
  obs.disconnect();
});
obs.observe({ entryTypes: ['function'] });

// A performance timeline entry will be created
wrapped();

Если обёрнутая функция возвращает промис, к нему будет добавлен обработчик finally, и длительность будет сообщена после вызова этого обработчика.

Объект, представляющий собой JSON-представление объекта performance. Он аналогичен window.performance.toJSON в браузерах.

Вычисляет время (в наносекундах), прошедшее с момента предыдущего вызова recordDelta(), и записывает это значение в гистограмму.

Добавляет значения из other в эту гистограмму.

Объект гистограммы, созданный с помощью perf_hooks.createHistogram(), который будет записывать длительность выполнения в наносекундах.

Количество итераций цикла событий.

Количество событий, обработанных обработчиком событий.

Количество событий, ожидавших обработки на момент вызова поставщика событий.