Node.js v21.7.2 文档

perf_hooks.performance#

一个可用于从当前 Node.js 实例收集性能指标的对象。它类似于浏览器中的 window.performance。

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> 先前调用 eventLoopUtilization() 的结果，在 utilization1 之前。
• 返回值：<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 的示例。

'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对象的列表，按performanceEntry.startTime的顺序排列。如果您只对特定类型或具有特定名称的性能条目感兴趣，请参见performance.getEntriesByType()和performance.getEntriesByName()。

performance.getEntriesByName(name[, type])#

• name <string>
• type <string>
• 返回值: <PerformanceEntry[]>

返回一个PerformanceEntry对象的列表，按performanceEntry.startTime的顺序排列，其performanceEntry.name等于name，并且可选地，其performanceEntry.entryType等于type。

performance.getEntriesByType(type)#

• type <string>
• 返回值: <PerformanceEntry[]>

返回一个PerformanceEntry对象的列表，按performanceEntry.startTime的顺序排列，其performanceEntry.entryType等于type。

performance.mark(name[, options])#

• name <string>
• options <Object>
  • detail <any> 要与标记一起包含的可选附加详细信息。
  • startTime <number> 可选的时间戳，用作标记时间。默认值：performance.now()。

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

创建的 PerformanceMark 条目将被放入全局性能时间轴中，可以使用 performance.getEntries、performance.getEntriesByName 和 performance.getEntriesByType 查询。在执行观察时，应使用 performance.clearMarks 手动从全局性能时间轴中清除条目。

performance.markResourceTiming(timingInfo, requestedUrl, initiatorType, global, cacheMode)#

• timingInfo <Object> 获取时间信息
• requestedUrl <string> 资源 URL
• initiatorType <string> 发起者名称，例如：'fetch'
• global <Object>
• cacheMode <string> 缓存模式必须为空字符串 ('') 或 'local'

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

在资源时间轴中创建一个新的 PerformanceResourceTiming 条目。PerformanceResourceTiming 是 PerformanceEntry 的子类，其 performanceEntry.entryType 始终为 'resource'。性能资源用于标记资源时间轴中的时刻。

创建的 PerformanceMark 条目将被放入全局资源时间轴中，可以使用 performance.getEntries、performance.getEntriesByName 和 performance.getEntriesByType 查询。在执行观察时，应使用 performance.clearResourceTimings 手动从全局性能时间轴中清除条目。

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

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

在性能时间轴中创建一个新的 PerformanceMeasure 条目。PerformanceMeasure 是 PerformanceEntry 的子类，其 performanceEntry.entryType 始终为 'measure'，其 performanceEntry.duration 度量自 startMark 和 endMark 以来经过的毫秒数。

startMark 参数可以标识性能时间轴中的任何现有 PerformanceMark，或者可以标识 PerformanceNodeTiming 类提供的任何时间戳属性。如果命名的 startMark 不存在，则会抛出错误。

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

创建的 PerformanceMeasure 条目被放入全局性能时间轴中，可以使用 performance.getEntries、performance.getEntriesByName 和 performance.getEntriesByType 查询。执行观察时，应使用 performance.clearMeasures 手动从全局性能时间轴中清除条目。

performance.nodeTiming#

• <PerformanceNodeTiming>

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

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

performance.now()#

• 返回值：<number>

返回当前高分辨率毫秒时间戳，其中 0 代表当前 node 进程的开始时间。

performance.setResourceTimingBufferSize(maxSize)#

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

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

performance.timeOrigin#

• <number>

The timeOrigin 指定当前 node 进程开始时的高分辨率毫秒时间戳，以 Unix 时间计量。

performance.timerify(fn[, options])#

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

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

将函数包装在一个新函数中，该函数测量包装函数的运行时间。必须将 PerformanceObserver 订阅到 'function' 事件类型，才能访问计时详细信息。

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。

事件：'resourcetimingbufferfull'#

当全局性能资源计时缓冲区已满时，将触发 'resourcetimingbufferfull' 事件。使用 performance.setResourceTimingBufferSize() 调整资源计时缓冲区大小，或在事件监听器中使用 performance.clearResourceTimings() 清除缓冲区，以允许将更多条目添加到性能时间线缓冲区。

类：PerformanceEntry#

此类的构造函数不会直接公开给用户。

performanceEntry.duration#

• <number>

此条目所用总毫秒数。此值对所有性能条目类型而言都没有意义。

performanceEntry.entryType#

• <string>

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

• 'node'（仅限 Node.js）
• 'mark'（在 Web 上可用）
• 'measure'（在 Web 上可用）
• 'gc'（仅限 Node.js）
• 'function'（仅限 Node.js）
• 'http2'（仅限 Node.js）
• 'http'（仅限 Node.js）

performanceEntry.name#

• <string>

性能条目的名称。

performanceEntry.startTime#

• <number>

标记性能条目开始时间的高分辨率毫秒时间戳。

类：PerformanceMark#

• 扩展：<PerformanceEntry>

公开通过 Performance.mark() 方法创建的标记。

performanceMark.detail#

• <any>

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

类：PerformanceMeasure#

• 扩展：<PerformanceEntry>

公开通过 Performance.measure() 方法创建的度量。

此类的构造函数不会直接公开给用户。

performanceMeasure.detail#

• <any>

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

类：PerformanceNodeEntry#

• 扩展：<PerformanceEntry>

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

提供详细的 Node.js 定时数据。

此类的构造函数不会直接公开给用户。

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 属性将是一个 <Object>，包含 method、url、headers，res 属性将是一个 <Object>，包含 statusCode、statusMessage、headers。

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

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

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') 详细信息#

当 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#

• 扩展：<PerformanceEntry>

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

提供 Node.js 本身的计时详细信息。此类的构造函数对用户不可见。

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.v8Start#

• <number>

V8 平台初始化时的高分辨率毫秒时间戳。

类：PerformanceResourceTiming#

• 扩展：<PerformanceEntry>

提供有关应用程序资源加载的详细网络计时数据。

此类的构造函数不会直接公开给用户。

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>

表示从获取（HTTP 或缓存）中接收到的有效负载主体大小（以字节为单位），在删除任何应用的内容编码之前。

performanceResourceTiming.decodedBodySize#

• <number>

表示从获取（HTTP 或缓存）中接收到的消息主体大小（以字节为单位），在删除任何应用的内容编码之后。

performanceResourceTiming.toJSON()#

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

类：PerformanceObserver#

PerformanceObserver.supportedEntryTypes#

• <string[]>

获取支持的类型。

new PerformanceObserver(callback)#

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

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

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> 实例以接收新 <PerformanceEntry> 实例的通知，这些实例由 options.entryTypes 或 options.type 标识。

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

类：PerformanceObserverEntryList#

PerformanceObserverEntryList 类用于提供对传递给 PerformanceObserver 的 PerformanceEntry 实例的访问。此类的构造函数对用户不可见。

performanceObserverEntryList.getEntries()#

• 返回值: <PerformanceEntry[]>

返回一个 PerformanceEntry 对象列表，按 performanceEntry.startTime 的时间顺序排列。

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对象的列表，按performanceEntry.startTime的顺序排列，其performanceEntry.name等于name，并且可选地，其performanceEntry.entryType等于type。

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对象的列表，按performanceEntry.startTime的顺序排列，其performanceEntry.entryType等于type。

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

perf_hooks.createHistogram([options])#

• options <Object>
  • lowest <number> | <bigint> 最低可辨识值。必须是大于 0 的整数值。**默认值：**1。
  • highest <number> | <bigint> 最高可记录值。必须是等于或大于 lowest 两倍的整数值。**默认值：**Number.MAX_SAFE_INTEGER。
  • figures <number> 精度位数。必须是 1 到 5 之间的数字。**默认值：**3。
• 返回值：<RecordableHistogram>

返回一个 <RecordableHistogram>。

perf_hooks.monitorEventLoopDelay([options])#

• options <Object>
  • resolution <number> 采样率（毫秒）。必须大于零。**默认值：**10。
• 返回值：<IntervalHistogram>

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

创建一个IntervalHistogram对象，用于对事件循环延迟进行采样和报告。延迟将以纳秒为单位报告。

使用计时器来检测事件循环延迟的原因是，计时器的执行与 libuv 事件循环的生命周期直接相关。也就是说，循环中的延迟会导致计时器执行延迟，而这个 API 就是为了检测这些延迟。

const { monitorEventLoopDelay } = require('node:perf_hooks');
const h = monitorEventLoopDelay({ resolution: 20 });
h.enable();
// Do something.
h.disable();
console.log(h.min);
console.log(h.max);
console.log(h.mean);
console.log(h.stddev);
console.log(h.percentiles);
console.log(h.percentile(50));
console.log(h.percentile(99)); copy

类：Histogram#

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>

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

类: IntervalHistogram extends Histogram#

一个 Histogram，它会定期在给定的间隔更新。

histogram.disable()#

• 返回值: <boolean>

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

histogram.enable()#

• 返回值: <boolean>

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

克隆 IntervalHistogram#

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

类: RecordableHistogram 继承自 Histogram#

histogram.add(other)#

• other <RecordableHistogram>

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

histogram.record(val)#

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

histogram.recordDelta()#

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

示例#

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

以下示例使用 异步钩子 和性能 API 来测量超时操作的实际持续时间（包括执行回调所花费的时间）。

'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'], buffered: true });

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

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

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

'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'], buffered: true });

require('some-module'); copy

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

以下示例用于跟踪 HTTP 客户端 (OutgoingMessage) 和 HTTP 请求 (IncomingMessage) 所花费的时间。对于 HTTP 客户端，它表示从开始请求到收到响应的时间间隔，而对于 HTTP 请求，它表示从收到请求到发送响应的时间间隔。

'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）在连接成功时所需的时间#

'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 请求成功时所需的时间#

'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