instrumentation.js
instrumentation.js|tsファイルは、アプリケーションにオブザーバビリティツールを統合するために使用され、パフォーマンスや動作を追跡し、本番環境での問題をデバッグできるようにします。
使用するには、ファイルをアプリケーションのルートに配置するか、使用している場合はsrcフォルダ内に配置します。
エクスポート
register(オプション)
ファイルは、新しいNext.jsサーバーインスタンスが起動されたときに一度呼び出されるregister関数をエクスポートします。registerは非同期関数にすることもできます。
instrumentation.ts
import { registerOTel } from '@vercel/otel'
export function register() {
registerOTel('next-app')
}onRequestError(オプション)
カスタムオブザーバビリティプロバイダーにサーバーエラーを追跡するために、オプションでonRequestError関数をエクスポートできます。
onRequestErrorで非同期タスクを実行している場合は、それらがawaitされていることを確認してください。onRequestErrorは、Next.jsサーバーがエラーをキャプチャしたときにトリガーされます。errorインスタンスは、Server Componentsのレンダリング中に発生した場合、Reactによって処理されている可能性があるため、スローされた元のエラーインスタンスではない場合があります。この場合、エラーのdigestプロパティを使用して実際のエラータイプを特定できます。
instrumentation.ts
import { type Instrumentation } from 'next'
export const onRequestError: Instrumentation.onRequestError = async (
err,
request,
context
) => {
await fetch('https://.../report-error', {
method: 'POST',
body: JSON.stringify({
message: err.message,
request,
context,
}),
headers: {
'Content-Type': 'application/json',
},
})
}Parameters
この関数は、error、request、contextの3つのパラメータを受け取ります。
型
export function onRequestError(
error: { digest: string } & Error,
request: {
path: string // resource path, e.g. /blog?name=foo
method: string // request method. e.g. GET, POST, etc
headers: { [key: string]: string | string[] }
},
context: {
routerKind: 'Pages Router' | 'App Router' // the router type
routePath: string // the route file path, e.g. /app/blog/[dynamic]
routeType: 'render' | 'route' | 'action' | 'proxy' // the context in which the error occurred
renderSource:
| 'react-server-components'
| 'react-server-components-payload'
| 'server-rendering'
revalidateReason: 'on-demand' | 'stale' | undefined // undefined is a normal request without revalidation
renderType: 'dynamic' | 'dynamic-resume' // 'dynamic-resume' for PPR
}
): void | Promise<void>error:キャッチされたエラー自体(型は常にError)と、エラーの一意のIDであるdigestプロパティ。request:エラーに関連付けられた読み取り専用のリクエスト情報。context:エラーが発生したコンテキスト。ルーターのタイプ(AppまたはPages Router)、および/または(Server Components('render')、Route Handlers('route')、Server Actions('action')、またはProxy('proxy'))のいずれかになります。
ランタイムの指定
instrumentation.jsファイルはNode.jsとEdgeランタイムの両方で機能しますが、process.env.NEXT_RUNTIMEを使用して特定のランタイムをターゲットにすることができます。
instrumentation.js
export function register() {
if (process.env.NEXT_RUNTIME === 'edge') {
return require('./register.edge')
} else {
return require('./register.node')
}
}
export function onRequestError() {
if (process.env.NEXT_RUNTIME === 'edge') {
return require('./on-request-error.edge')
} else {
return require('./on-request-error.node')
}
}バージョン履歴
| バージョン | 変更履歴 |
|---|---|
v15.0.0 | onRequestErrorが導入され、instrumentationが安定しました |
v14.0.4 | instrumentationのTurbopackサポート |
v13.2.0 | instrumentationが実験的機能として導入されました |
Instrumentationについてさらに学ぶ
役に立ちましたか?