コンテンツへスキップ

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で非同期タスクを実行している場合は、それらが待機されていることを確認してください。onRequestErrorは、Next.jsサーバーがエラーを捕捉したときにトリガーされます。
  • errorインスタンスは、サーバーコンポーネントのレンダリング中に発生した場合、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',
    },
  })
}

パラメーター

この関数は、errorrequestcontextの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 }
  },
  context: {
    routerKind: 'Pages Router' | 'App Router' // the router type
    routePath: string // the route file path, e.g. /app/blog/[dynamic]
    routeType: 'render' | 'route' | 'action' | 'middleware' // 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)、および/または(サーバーコンポーネント('render')、ルートハンドラー('route')、サーバーアクション('action')、またはミドルウェア('middleware'))です。

ランタイムの指定

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.0onRequestErrorが導入され、instrumentationが安定版になりました
v14.0.4instrumentationのTurbopackサポート
v13.2.0instrumentationが実験的機能として導入されました