Node.js v24.0.0 文档

performance.clearMarks([name])#

• name <string>

如果未提供 name，则从性能时间线中删除所有 PerformanceMark 对象。 如果提供了 name，则仅删除指定的标记。

performance.clearMeasures([name])#

• name <string>

如果未提供 name，则从性能时间线中删除所有 PerformanceMeasure 对象。 如果提供了 name，则仅删除指定的测量。

performance.clearResourceTimings([name])#

• name <string>

如果未提供 name，则从资源时间线中删除所有 PerformanceResourceTiming 对象。 如果提供了 name，则仅删除指定的资源。

performance.eventLoopUtilization([utilization1[, utilization2]])#

• utilization1 <Object> 先前调用 eventLoopUtilization() 的结果。
• utilization2 <Object> 在 utilization1 之前先前调用 eventLoopUtilization() 的结果。
• 返回： <Object>
  • idle <number>
  • active <number>
  • utilization <number>

eventLoopUtilization() 方法返回一个对象，其中包含事件循环空闲和活动状态的累积持续时间，以高分辨率毫秒计时器表示。 utilization 值是计算出的事件循环利用率 (ELU)。

如果在主线程上尚未完成引导，则属性的值为 0。ELU 在 Worker 线程 上立即可用，因为引导发生在事件循环中。

utilization1 和 utilization2 都是可选参数。

如果传递了 utilization1，则会计算并返回当前调用 active 和 idle 时间之间的差值，以及相应的 utilization 值（类似于 process.hrtime()）。

如果同时传递了 utilization1 和 utilization2，则会计算两个参数之间的差值。 这是一个方便的选项，因为与 process.hrtime() 不同，计算 ELU 比单个减法更复杂。

ELU 类似于 CPU 利用率，但它仅测量事件循环统计信息，而不测量 CPU 使用率。 它表示事件循环在事件循环的事件提供程序之外（例如 epoll_wait）花费的时间百分比。 不考虑任何其他 CPU 空闲时间。 以下是一个主要空闲进程将具有高 ELU 的示例。

import { eventLoopUtilization } from 'node:perf_hooks';
import { spawnSync } from 'node:child_process';

setImmediate(() => {
  const elu = eventLoopUtilization();
  spawnSync('sleep', ['5']);
  console.log(eventLoopUtilization(elu).utilization);
});'use strict';
const { eventLoopUtilization } = require('node:perf_hooks').performance;
const { spawnSync } = require('node:child_process');

setImmediate(() => {
  const elu = eventLoopUtilization();
  spawnSync('sleep', ['5']);
  console.log(eventLoopUtilization(elu).utilization);
});copy

虽然 CPU 在运行此脚本时大部分时间处于空闲状态，但 utilization 的值为 1。 这是因为调用 child_process.spawnSync() 会阻止事件循环继续进行。

传入用户定义的对象而不是先前调用 eventLoopUtilization() 的结果将导致未定义的行为。 不能保证返回值反映事件循环的任何正确状态。

performance.getEntries()#

• 返回： <PerformanceEntry[]>

返回按 performanceEntry.startTime 的时间顺序排列的 PerformanceEntry 对象列表。 如果你只对某些类型或具有某些名称的性能条目感兴趣，请参阅 performance.getEntriesByType() 和 performance.getEntriesByName()。

performance.getEntriesByName(name[, type])#

• name <string>
• type <string>
• 返回： <PerformanceEntry[]>

返回按 performanceEntry.startTime 的时间顺序排列的 PerformanceEntry 对象列表，这些对象的 performanceEntry.name 等于 name，并且可以选择地，其 performanceEntry.entryType 等于 type。

performance.getEntriesByType(type)#

• type <string>
• 返回： <PerformanceEntry[]>

返回按 performanceEntry.startTime 的时间顺序排列的 PerformanceEntry 对象列表，这些对象的 performanceEntry.entryType 等于 type。

performance.mark(name[, options])#

• name <string>
• options <Object>
  • detail <any> 要包含在标记中的其他可选详细信息。
  • startTime <number> 用作标记时间的可选时间戳。默认值：performance.now()。

在 Performance Timeline 中创建一个新的 PerformanceMark 条目。PerformanceMark 是 PerformanceEntry 的一个子类，其 performanceEntry.entryType 始终为 'mark'，并且其 performanceEntry.duration 始终为 0。Performance mark 用于标记 Performance Timeline 中的特定重要时刻。

创建的 PerformanceMark 条目被放入全局 Performance Timeline 中，并且可以使用 performance.getEntries、performance.getEntriesByName 和 performance.getEntriesByType 进行查询。执行观察后，应使用 performance.clearMarks 手动从全局 Performance Timeline 中清除条目。

performance.markResourceTiming(timingInfo, requestedUrl, initiatorType, global, cacheMode, bodyInfo, responseStatus[, deliveryType])#

• timingInfo <Object> Fetch Timing Info
• requestedUrl <string> 资源 URL
• initiatorType <string> 发起者名称，例如：'fetch'
• global <Object>
• cacheMode <string> 缓存模式必须是空字符串 ('') 或 'local'
• bodyInfo <Object> Fetch Response Body Info
• responseStatus <number> 响应的状态码
• deliveryType <string> 交付类型。默认值： ''。

此属性是 Node.js 的扩展。它在 Web 浏览器中不可用。

在 Resource Timeline 中创建一个新的 PerformanceResourceTiming 条目。PerformanceResourceTiming 是 PerformanceEntry 的一个子类，其 performanceEntry.entryType 始终为 'resource'。Performance resources 用于标记 Resource Timeline 中的时刻。

创建的 PerformanceMark 条目被放入全局 Resource Timeline 中，并且可以使用 performance.getEntries、performance.getEntriesByName 和 performance.getEntriesByType 进行查询。执行观察后，应使用 performance.clearResourceTimings 手动从全局 Performance Timeline 中清除条目。

performance.measure(name[, startMarkOrOptions[, endMark]])#

• name <string>
• startMarkOrOptions <string> | <Object> 可选。
  • detail <any> 要包含在度量中的其他可选详细信息。
  • duration <number> 开始时间和结束时间之间的持续时间。
  • end <number> | <string> 用作结束时间的时间戳，或标识先前记录的标记的字符串。
  • start <number> | <string> 用作开始时间的时间戳，或标识先前记录的标记的字符串。
• endMark <string> 可选。如果 startMarkOrOptions 是 <Object>，则必须省略。

在 Performance Timeline 中创建一个新的 PerformanceMeasure 条目。PerformanceMeasure 是 PerformanceEntry 的一个子类，其 performanceEntry.entryType 始终为 'measure'，并且其 performanceEntry.duration 测量自 startMark 和 endMark 以来经过的毫秒数。

startMark 参数可以标识 Performance Timeline 中的任何现有 PerformanceMark，或者可以标识 PerformanceNodeTiming 类提供的任何时间戳属性。如果指定的 startMark 不存在，则会抛出一个错误。

可选的 endMark 参数必须标识 Performance Timeline 中的任何现有 PerformanceMark 或 PerformanceNodeTiming 类提供的任何时间戳属性。如果未传递参数，endMark 将为 performance.now()，否则如果指定的 endMark 不存在，则会抛出一个错误。

创建的 PerformanceMeasure 条目被放入全局 Performance Timeline 中，并且可以使用 performance.getEntries、performance.getEntriesByName 和 performance.getEntriesByType 进行查询。执行观察后，应使用 performance.clearMeasures 手动从全局 Performance Timeline 中清除条目。

performance.nodeTiming#

• <PerformanceNodeTiming>

此属性是 Node.js 的扩展。它在 Web 浏览器中不可用。

PerformanceNodeTiming 类的一个实例，它提供特定 Node.js 操作里程碑的性能指标。

performance.now()#

• 返回：<number>

返回当前高精度毫秒时间戳，其中 0 表示当前 node 进程的开始。

performance.setResourceTimingBufferSize(maxSize)#

将全局性能资源计时缓冲区大小设置为指定数量的 "resource" 类型性能条目对象。

默认情况下，最大缓冲区大小设置为 250。

performance.timeOrigin#

• <number>

timeOrigin 指定当前 node 进程开始时的高精度毫秒时间戳，以 Unix 时间测量。

performance.timerify(fn[, options])#

• fn <Function>
• options <Object>
  • histogram <RecordableHistogram> 使用 perf_hooks.createHistogram() 创建的直方图对象，它将以纳秒为单位记录运行时持续时间。

此属性是 Node.js 的扩展。它在 Web 浏览器中不可用。

将函数包装在一个新函数中，该函数测量被包装函数的运行时间。必须将 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();const {
  performance,
  PerformanceObserver,
} = require('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();copy

如果被包装的函数返回一个 promise，则 finally 处理程序将附加到该 promise，并且一旦调用 finally 处理程序，就会报告持续时间。

performance.toJSON()#

一个对象，它是 performance 对象的 JSON 表示形式。它类似于浏览器中的 window.performance.toJSON。

performanceEntry.duration#

• <number>

此条目的总经过毫秒数。此值对于所有 Performance Entry 类型都没有意义。

performanceEntry.entryType#

• <string>

性能条目的类型。它可以是以下之一

• 'dns' (仅限 Node.js)
• 'function' (仅限 Node.js)
• 'gc' (仅限 Node.js)
• 'http2' (仅限 Node.js)
• 'http' (仅限 Node.js)
• 'mark' (在 Web 上可用)
• 'measure' (在 Web 上可用)
• 'net' (仅限 Node.js)
• 'node' (仅限 Node.js)
• 'resource' (在 Web 上可用)

performanceEntry.name#

• <string>

性能条目的名称。

performanceEntry.startTime#

• <number>

标记 Performance Entry 开始时间的高精度毫秒时间戳。

performanceMark.detail#

• <any>

使用 Performance.mark() 方法创建时指定的其他详细信息。

performanceMeasure.detail#

• <any>

使用 Performance.measure() 方法创建时指定的其他详细信息。

performanceNodeEntry.detail#

• <any>

特定于 entryType 的其他详细信息。

performanceNodeEntry.flags#

• <number>

当 performanceEntry.entryType 等于 'gc' 时，performance.flags 属性包含有关垃圾回收操作的其他信息。 该值可以是以下之一

• perf_hooks.constants.NODE_PERFORMANCE_GC_FLAGS_NO
• perf_hooks.constants.NODE_PERFORMANCE_GC_FLAGS_CONSTRUCT_RETAINED
• perf_hooks.constants.NODE_PERFORMANCE_GC_FLAGS_FORCED
• perf_hooks.constants.NODE_PERFORMANCE_GC_FLAGS_SYNCHRONOUS_PHANTOM_PROCESSING
• perf_hooks.constants.NODE_PERFORMANCE_GC_FLAGS_ALL_AVAILABLE_GARBAGE
• perf_hooks.constants.NODE_PERFORMANCE_GC_FLAGS_ALL_EXTERNAL_MEMORY
• perf_hooks.constants.NODE_PERFORMANCE_GC_FLAGS_SCHEDULE_IDLE

performanceNodeEntry.kind#

• <number>

当 performanceEntry.entryType 等于 'gc' 时，performance.kind 属性标识发生的垃圾回收操作的类型。 该值可以是以下之一

• perf_hooks.constants.NODE_PERFORMANCE_GC_MAJOR
• perf_hooks.constants.NODE_PERFORMANCE_GC_MINOR
• perf_hooks.constants.NODE_PERFORMANCE_GC_INCREMENTAL
• perf_hooks.constants.NODE_PERFORMANCE_GC_WEAKCB

垃圾回收 ('gc') 详情#

当 performanceEntry.type 等于 'gc' 时，performanceNodeEntry.detail 属性将是一个 <Object>，其中包含两个属性

• kind <number> 其中之一
  • perf_hooks.constants.NODE_PERFORMANCE_GC_MAJOR
  • perf_hooks.constants.NODE_PERFORMANCE_GC_MINOR
  • perf_hooks.constants.NODE_PERFORMANCE_GC_INCREMENTAL
  • perf_hooks.constants.NODE_PERFORMANCE_GC_WEAKCB
• flags <number> 其中之一
  • perf_hooks.constants.NODE_PERFORMANCE_GC_FLAGS_NO
  • perf_hooks.constants.NODE_PERFORMANCE_GC_FLAGS_CONSTRUCT_RETAINED
  • perf_hooks.constants.NODE_PERFORMANCE_GC_FLAGS_FORCED
  • perf_hooks.constants.NODE_PERFORMANCE_GC_FLAGS_SYNCHRONOUS_PHANTOM_PROCESSING
  • perf_hooks.constants.NODE_PERFORMANCE_GC_FLAGS_ALL_AVAILABLE_GARBAGE
  • perf_hooks.constants.NODE_PERFORMANCE_GC_FLAGS_ALL_EXTERNAL_MEMORY
  • perf_hooks.constants.NODE_PERFORMANCE_GC_FLAGS_SCHEDULE_IDLE

HTTP ('http') 详情#

当 performanceEntry.type 等于 'http' 时，performanceNodeEntry.detail 属性将是一个包含附加信息的 <Object>。

如果 performanceEntry.name 等于 HttpClient，则 detail 将包含以下属性：req、res。 并且 req 属性将是一个包含 method、url、headers 的 <Object>，res 属性将是一个包含 statusCode、statusMessage、headers 的 <Object>。

如果 performanceEntry.name 等于 HttpRequest，则 detail 将包含以下属性：req、res。 并且 req 属性将是一个包含 method、url、headers 的 <Object>，res 属性将是一个包含 statusCode、statusMessage、headers 的 <Object>。

这可能会增加额外的内存开销，仅应用于诊断目的，默认情况下不应在生产环境中启用。

HTTP/2 ('http2') 详情#

当 performanceEntry.type 等于 'http2' 时，performanceNodeEntry.detail 属性将是一个包含附加性能信息的 <Object>。

如果 performanceEntry.name 等于 Http2Stream，则 detail 将包含以下属性

• bytesRead <number> 此 Http2Stream 接收到的 DATA 帧字节数。
• bytesWritten <number> 为此 Http2Stream 发送的 DATA 帧字节数。
• id <number> 相关联的 Http2Stream 的标识符
• timeToFirstByte <number> 从 PerformanceEntry startTime 到接收到第一个 DATA 帧所经过的毫秒数。
• timeToFirstByteSent <number> 从 PerformanceEntry startTime 到发送第一个 DATA 帧所经过的毫秒数。
• timeToFirstHeader <number> 从 PerformanceEntry startTime 到接收到第一个标头所经过的毫秒数。

如果 performanceEntry.name 等于 Http2Session，则 detail 将包含以下属性

• bytesRead <number> 此 Http2Session 接收的字节数。
• bytesWritten <number> 为此 Http2Session 发送的字节数。
• framesReceived <number> Http2Session 接收的 HTTP/2 帧数。
• framesSent <number> Http2Session 发送的 HTTP/2 帧数。
• maxConcurrentStreams <number> 在 Http2Session 的生命周期内并发打开的最大流数。
• pingRTT <number> 自传输 PING 帧到接收其确认以来经过的毫秒数。 仅当在 Http2Session 上发送了 PING 帧时才存在。
• streamAverageDuration <number> 所有 Http2Stream 实例的平均持续时间（以毫秒为单位）。
• streamCount <number> Http2Session 处理的 Http2Stream 实例数。
• type <string> 'server' 或 'client'，用于标识 Http2Session 的类型。

Timerify ('function') 详情#

当 performanceEntry.type 等于 'function' 时，performanceNodeEntry.detail 属性将是一个 <Array>，其中列出了定时函数的输入参数。

Net ('net') 详情#

当 performanceEntry.type 等于 'net' 时，performanceNodeEntry.detail 属性将是一个包含附加信息的 <Object>。

如果 performanceEntry.name 等于 connect，则 detail 将包含以下属性：host、port。

DNS ('dns') 详情#

当 performanceEntry.type 等于 'dns' 时，performanceNodeEntry.detail 属性将是一个包含附加信息的 <Object>。

如果 performanceEntry.name 等于 lookup，则 detail 将包含以下属性：hostname、family、hints、verbatim、addresses。

如果 performanceEntry.name 等于 lookupService，则 detail 将包含以下属性：host、port、hostname、service。

如果 performanceEntry.name 等于 queryxxx 或 getHostByAddr，则 detail 将包含以下属性：host、ttl、result。 result 的值与 queryxxx 或 getHostByAddr 的结果相同。

performanceNodeTiming.bootstrapComplete#

• <number>

Node.js 进程完成引导程序的高分辨率毫秒时间戳。 如果引导程序尚未完成，则该属性的值为 -1。

performanceNodeTiming.environment#

• <number>

Node.js 环境初始化的毫秒高分辨率时间戳。

performanceNodeTiming.idleTime#

• <number>

事件循环在事件循环的事件提供程序（例如 epoll_wait）中空闲的时间量的高分辨率毫秒时间戳。 这不考虑 CPU 使用率。 如果事件循环尚未启动（例如，在主脚本的第一个节拍中），则该属性的值为 0。

performanceNodeTiming.loopExit#

• <number>

Node.js 事件循环退出的高分辨率毫秒时间戳。 如果事件循环尚未退出，则该属性的值为 -1。 它只能在 'exit' 事件的处理程序中具有非 -1 的值。

performanceNodeTiming.loopStart#

• <number>

Node.js 事件循环启动的高分辨率毫秒时间戳。 如果事件循环尚未启动（例如，在主脚本的第一个节拍中），则该属性的值为 -1。

performanceNodeTiming.nodeStart#

• <number>

Node.js 进程初始化的毫秒高分辨率时间戳。

performanceNodeTiming.uvMetricsInfo#

• 返回： <Object>
  • loopCount <number> 事件循环的迭代次数。
  • events <number> 事件处理程序已处理的事件数。
  • eventsWaiting <number> 调用事件提供程序时等待处理的事件数。

这是 uv_metrics_info 函数的包装器。 它返回当前的一组事件循环指标。

建议在函数中使用此属性，该函数的执行计划通过 setImmediate 安排，以避免在完成当前循环迭代期间安排的所有操作之前收集指标。

const { performance } = require('node:perf_hooks');

setImmediate(() => {
  console.log(performance.nodeTiming.uvMetricsInfo);
});import { performance } from 'node:perf_hooks';

setImmediate(() => {
  console.log(performance.nodeTiming.uvMetricsInfo);
});copy

performanceNodeTiming.v8Start#

• <number>

V8 平台初始化的毫秒级高精度时间戳。

performanceResourceTiming.workerStart#

• <number>

立即在调度 fetch 请求之前的高分辨率毫秒时间戳。 如果资源未被 worker 拦截，则该属性将始终返回 0。

performanceResourceTiming.redirectStart#

• <number>

表示启动重定向的 fetch 的开始时间的高分辨率毫秒时间戳。

performanceResourceTiming.redirectEnd#

• <number>

将在收到最后一个重定向响应的最后一个字节后立即创建的高分辨率毫秒时间戳。

performanceResourceTiming.fetchStart#

• <number>

Node.js 开始获取资源之前立即的高分辨率毫秒时间戳。

performanceResourceTiming.domainLookupStart#

• <number>

Node.js 开始为资源查找域名之前立即的高分辨率毫秒时间戳。

performanceResourceTiming.domainLookupEnd#

• <number>

表示 Node.js 完成资源域名查找之后立即的时间的高分辨率毫秒时间戳。

performanceResourceTiming.connectStart#

• <number>

表示 Node.js 开始建立与服务器的连接以检索资源之前立即的时间的高分辨率毫秒时间戳。

performanceResourceTiming.connectEnd#

• <number>

表示 Node.js 完成建立与服务器的连接以检索资源之后立即的时间的高分辨率毫秒时间戳。

performanceResourceTiming.secureConnectionStart#

• <number>

表示 Node.js 开始握手过程以保护当前连接之前立即的时间的高分辨率毫秒时间戳。

performanceResourceTiming.requestStart#

• <number>

表示 Node.js 从服务器接收到响应的第一个字节之前立即的时间的高分辨率毫秒时间戳。

performanceResourceTiming.responseEnd#

• <number>

表示 Node.js 接收到资源的最后一个字节之后立即的时间或者传输连接关闭之前立即的时间（以先到者为准）的高分辨率毫秒时间戳。

performanceResourceTiming.transferSize#

• <number>

一个表示获取的资源的大小（以八位字节为单位）的数字。 该大小包括响应头字段加上响应有效载荷正文。

performanceResourceTiming.encodedBodySize#

• <number>

一个表示从 fetch（HTTP 或缓存）接收到的有效载荷正文的大小（以八位字节为单位）的数字，在删除任何已应用的内容编码之前。

performanceResourceTiming.decodedBodySize#

• <number>

一个表示从 fetch（HTTP 或缓存）接收到的消息正文的大小（以八位字节为单位）的数字，在删除任何已应用的内容编码之后。

performanceResourceTiming.toJSON()#

返回一个 object，它是 PerformanceResourceTiming 对象的 JSON 表示形式

PerformanceObserver.supportedEntryTypes#

• <string[]>

获取支持的类型。

new PerformanceObserver(callback)#

• callback <Function>
  • list <PerformanceObserverEntryList>
  • observer <PerformanceObserver>

当新的 PerformanceEntry 实例已添加到性能时间线时，PerformanceObserver 对象提供通知。

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

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

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

performance.mark('test');const {
  performance,
  PerformanceObserver,
} = require('node:perf_hooks');

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

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

performance.mark('test');copy

由于 PerformanceObserver 实例会引入自己的额外性能开销，因此不应无限期地订阅通知。 用户应在不再需要观察者时立即断开连接。

当 PerformanceObserver 被通知有关新的 PerformanceEntry 实例时，将调用 callback。 该回调接收一个 PerformanceObserverEntryList 实例和一个对 PerformanceObserver 的引用。

performanceObserver.disconnect()#

断开 PerformanceObserver 实例与所有通知的连接。

performanceObserver.observe(options)#

• options <Object>
  • type <string> 单个 <PerformanceEntry> 类型。 如果已指定 entryTypes，则不得给出。
  • entryTypes <string[]> 一个字符串数组，用于标识观察者感兴趣的 <PerformanceEntry> 实例的类型。 如果未提供，则会抛出错误。
  • buffered <boolean> 如果为 true，则使用全局 PerformanceEntry 缓冲条目的列表调用观察者回调。 如果为 false，则仅将时间点之后创建的 PerformanceEntry 发送到观察者回调。 默认: false。

将 <PerformanceObserver> 实例订阅到由 options.entryTypes 或 options.type 标识的新的 <PerformanceEntry> 实例的通知

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}`);const {
  performance,
  PerformanceObserver,
} = require('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}`);copy

performanceObserver.takeRecords()#

• 返回: <PerformanceEntry[]> 存储在性能观察器中的条目的当前列表，清空它。

performanceObserverEntryList.getEntries()#

• 返回： <PerformanceEntry[]>

返回按 performanceEntry.startTime 排序的 PerformanceEntry 对象列表。

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');const {
  performance,
  PerformanceObserver,
} = require('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');copy

performanceObserverEntryList.getEntriesByName(name[, type])#

• name <string>
• type <string>
• 返回： <PerformanceEntry[]>

返回按 performanceEntry.startTime 的时间顺序排列的 PerformanceEntry 对象列表，这些对象的 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');const {
  performance,
  PerformanceObserver,
} = require('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');copy

performanceObserverEntryList.getEntriesByType(type)#

• type <string>
• 返回： <PerformanceEntry[]>

返回按 performanceEntry.startTime 的时间顺序排列的 PerformanceEntry 对象列表，这些对象的 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');const {
  performance,
  PerformanceObserver,
} = require('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');copy

histogram.count#

• <number>

直方图记录的样本数量。

histogram.countBigInt#

• <bigint>

直方图记录的样本数量。

histogram.exceeds#

• <number>

事件循环延迟超过最大 1 小时事件循环延迟阈值的次数。

histogram.exceedsBigInt#

• <bigint>

事件循环延迟超过最大 1 小时事件循环延迟阈值的次数。

histogram.max#

• <number>

记录的最大事件循环延迟。

histogram.maxBigInt#

• <bigint>

记录的最大事件循环延迟。

histogram.mean#

• <number>

记录的事件循环延迟的平均值。

histogram.min#

• <number>

记录的最小事件循环延迟。

histogram.minBigInt#

• <bigint>

记录的最小事件循环延迟。

histogram.percentile(percentile)#

• percentile <number> 百分位数，范围 (0, 100]。
• 返回：<number>

返回给定百分位数的值。

histogram.percentileBigInt(percentile)#

• percentile <number> 百分位数，范围 (0, 100]。
• 返回: <bigint>

返回给定百分位数的值。

histogram.percentiles#

• <Map>

返回一个 Map 对象，详细说明累积的百分比分布。

histogram.percentilesBigInt#

• <Map>

返回一个 Map 对象，详细说明累积的百分比分布。

histogram.reset()#

重置收集的直方图数据。

histogram.stddev#

• <number>

记录的事件循环延迟的标准差。

histogram.disable()#

• 返回: <boolean>

禁用更新间隔计时器。 如果计时器已停止，则返回 true，如果已停止，则返回 false。

histogram.enable()#

• 返回: <boolean>

启用更新间隔计时器。 如果计时器已启动，则返回 true，如果已启动，则返回 false。

克隆一个 IntervalHistogram#

<IntervalHistogram> 实例可以通过 <MessagePort> 进行克隆。 在接收端，直方图被克隆为一个普通的 <Histogram> 对象，该对象不实现 enable() 和 disable() 方法。

histogram.add(other)#

• other <RecordableHistogram>

将 other 中的值添加到此直方图。

histogram.record(val)#

• val <number> | <bigint> 要在直方图中记录的数量。

histogram.recordDelta()#

计算自上次调用 recordDelta() 以来经过的时间量（以纳秒为单位），并将该数量记录在直方图中。

测量异步操作的持续时间#

以下示例使用 Async Hooks 和 Performance API 来测量 Timeout 操作的实际持续时间（包括执行回调所需的时间）。

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

const set = new Set();
const hook = createHook({
  init(id, type) {
    if (type === 'Timeout') {
      performance.mark(`Timeout-${id}-Init`);
      set.add(id);
    }
  },
  destroy(id) {
    if (set.has(id)) {
      set.delete(id);
      performance.mark(`Timeout-${id}-Destroy`);
      performance.measure(`Timeout-${id}`,
                          `Timeout-${id}-Init`,
                          `Timeout-${id}-Destroy`);
    }
  },
});
hook.enable();

const obs = new PerformanceObserver((list, observer) => {
  console.log(list.getEntries()[0]);
  performance.clearMarks();
  performance.clearMeasures();
  observer.disconnect();
});
obs.observe({ entryTypes: ['measure'], buffered: true });

setTimeout(() => {}, 1000);'use strict';
const async_hooks = require('node:async_hooks');
const {
  performance,
  PerformanceObserver,
} = require('node:perf_hooks');

const set = new Set();
const hook = async_hooks.createHook({
  init(id, type) {
    if (type === 'Timeout') {
      performance.mark(`Timeout-${id}-Init`);
      set.add(id);
    }
  },
  destroy(id) {
    if (set.has(id)) {
      set.delete(id);
      performance.mark(`Timeout-${id}-Destroy`);
      performance.measure(`Timeout-${id}`,
                          `Timeout-${id}-Init`,
                          `Timeout-${id}-Destroy`);
    }
  },
});
hook.enable();

const obs = new PerformanceObserver((list, observer) => {
  console.log(list.getEntries()[0]);
  performance.clearMarks();
  performance.clearMeasures();
  observer.disconnect();
});
obs.observe({ entryTypes: ['measure'] });

setTimeout(() => {}, 1000);copy

测量加载依赖项所需的时间#

以下示例测量 require() 操作加载依赖项的持续时间

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

// Activate the observer
const obs = new PerformanceObserver((list) => {
  const entries = list.getEntries();
  entries.forEach((entry) => {
    console.log(`import('${entry[0]}')`, entry.duration);
  });
  performance.clearMarks();
  performance.clearMeasures();
  obs.disconnect();
});
obs.observe({ entryTypes: ['function'], buffered: true });

const timedImport = performance.timerify(async (module) => {
  return await import(module);
});

await timedImport('some-module');'use strict';
const {
  performance,
  PerformanceObserver,
} = require('node:perf_hooks');
const mod = require('node:module');

// Monkey patch the require function
mod.Module.prototype.require =
  performance.timerify(mod.Module.prototype.require);
require = performance.timerify(require);

// Activate the observer
const obs = new PerformanceObserver((list) => {
  const entries = list.getEntries();
  entries.forEach((entry) => {
    console.log(`require('${entry[0]}')`, entry.duration);
  });
  performance.clearMarks();
  performance.clearMeasures();
  obs.disconnect();
});
obs.observe({ entryTypes: ['function'] });

require('some-module');copy

测量一个 HTTP 往返所需的时间#

以下示例用于跟踪 HTTP 客户端 (OutgoingMessage) 和 HTTP 请求 (IncomingMessage) 所花费的时间。 对于 HTTP 客户端，这意味着从启动请求到接收响应的时间间隔，对于 HTTP 请求，这意味着从接收请求到发送响应的时间间隔

import { PerformanceObserver } from 'node:perf_hooks';
import { createServer, get } from 'node:http';

const obs = new PerformanceObserver((items) => {
  items.getEntries().forEach((item) => {
    console.log(item);
  });
});

obs.observe({ entryTypes: ['http'] });

const PORT = 8080;

createServer((req, res) => {
  res.end('ok');
}).listen(PORT, () => {
  get(`http://127.0.0.1:${PORT}`);
});'use strict';
const { PerformanceObserver } = require('node:perf_hooks');
const http = require('node:http');

const obs = new PerformanceObserver((items) => {
  items.getEntries().forEach((item) => {
    console.log(item);
  });
});

obs.observe({ entryTypes: ['http'] });

const PORT = 8080;

http.createServer((req, res) => {
  res.end('ok');
}).listen(PORT, () => {
  http.get(`http://127.0.0.1:${PORT}`);
});copy

测量连接成功时 net.connect（仅适用于 TCP）所需的时间#

import { PerformanceObserver } from 'node:perf_hooks';
import { connect, createServer } from 'node:net';

const obs = new PerformanceObserver((items) => {
  items.getEntries().forEach((item) => {
    console.log(item);
  });
});
obs.observe({ entryTypes: ['net'] });
const PORT = 8080;
createServer((socket) => {
  socket.destroy();
}).listen(PORT, () => {
  connect(PORT);
});'use strict';
const { PerformanceObserver } = require('node:perf_hooks');
const net = require('node:net');
const obs = new PerformanceObserver((items) => {
  items.getEntries().forEach((item) => {
    console.log(item);
  });
});
obs.observe({ entryTypes: ['net'] });
const PORT = 8080;
net.createServer((socket) => {
  socket.destroy();
}).listen(PORT, () => {
  net.connect(PORT);
});copy

测量请求成功时 DNS 所需的时间#

import { PerformanceObserver } from 'node:perf_hooks';
import { lookup, promises } from 'node:dns';

const obs = new PerformanceObserver((items) => {
  items.getEntries().forEach((item) => {
    console.log(item);
  });
});
obs.observe({ entryTypes: ['dns'] });
lookup('localhost', () => {});
promises.resolve('localhost');'use strict';
const { PerformanceObserver } = require('node:perf_hooks');
const dns = require('node:dns');
const obs = new PerformanceObserver((items) => {
  items.getEntries().forEach((item) => {
    console.log(item);
  });
});
obs.observe({ entryTypes: ['dns'] });
dns.lookup('localhost', () => {});
dns.promises.resolve('localhost');copy