Menu

instrumentation.js

instrumentation.js|ts 文件用于将监控和日志工具集成到你的应用中。这使你能够跟踪应用的性能和行为,并在生产环境中调试问题。

要使用它,请将文件放在应用的根目录下,或者如果使用 src 文件夹,则放在其中。

配置选项

Instrumentation 目前是一个实验性功能,要使用 instrumentation 文件,你必须在 next.config.js 中明确选择加入,方法是定义 experimental.instrumentationHook = true;

next.config.js
module.exports = {
  experimental: {
    instrumentationHook: true,
  },
};

导出

register (必需)

该文件导出一个 register 函数,当新的 Next.js 服务器实例初始化时,这个函数会被调用一次register 可以是一个异步函数。

instrumentation.ts
import { registerOTel } from "@vercel/otel";
 
export function register() {
  registerOTel("next-app");
}
instrumentation.js
import { registerOTel } from "@vercel/otel";
 
export function register() {
  registerOTel("next-app");
}

版本历史

版本变更
v14.0.4Turbopack 支持 instrumentation
v13.2.0instrumentation 作为实验性功能引入