Menu

instrumentation.js

instrumentation.js|tsファイルは、アプリケーションに可観測性ツールを統合するために使用されます。これにより、パフォーマンスと動作を追跡し、本番環境の問題をデバッグできます。

これを使用するには、アプリケーションのルート、またはsrcフォルダを使用する場合はそのフォルダ内にファイルを配置します。

エクスポート

register（オプション）

このファイルは、新しいNext.jsサーバーインスタンスが初期化されるときに一度だけ呼び出されるregister関数をエクスポートします。registerは非同期関数とすることができます。

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

onRequestError（オプション）

オプションでonRequestError関数をエクスポートして、サーバーエラーをカスタム可観測性プロバイダーに追跡できます。

  • onRequestErrorで非同期タスクを実行する場合は、必ずawaitしてください。Next.jsサーバーがエラーをキャッチすると、onRequestErrorがトリガーされます。
  • errorインスタンスは、スローされた元のエラーインスタンスではない可能性があります。Server Componentsのレンダリング中にReactで処理された場合はそうなります。この場合、エラーのdigestプロパティを使用して実際のエラータイプを識別できます。
instrumentation.ts
TypeScript
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',
    },
  })
}

パラメータ

この関数は3つのパラメータを受け取ります。error、request、contextです。

Types
export function onRequestError(
  error: { digest: string } & Error,
  request: {
    path: string // リソースパス、例：/blog?name=foo
    method: string // リクエストメソッド、例：GET、POST等
    headers: { [key: string]: string | string[] }
  },
  context: {
    routerKind: 'Pages Router' | 'App Router' // ルーターのタイプ
    routePath: string // ルートファイルパス、例：/app/blog/[dynamic]
    routeType: 'render' | 'route' | 'action' | 'proxy' // エラーが発生したコンテキスト
    renderSource:
      | 'react-server-components'
      | 'react-server-components-payload'
      | 'server-rendering'
    revalidateReason: 'on-demand' | 'stale' | undefined // undefineの場合は再検証なしの通常のリクエスト
    renderType: 'dynamic' | 'dynamic-resume' // PPRの場合は'dynamic-resume'
  }
): void | Promise<void>
  • error：キャッチされたエラー自体（タイプは常にError）と、エラーの一意のIDであるdigestプロパティ。
  • request：エラーに関連付けられた読み取り専用のリクエスト情報。
  • context：エラーが発生したコンテキスト。App Routerまたは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.4instrumentationのTurbopack対応
v13.2.0導入時期：instrumentationが実験的機能として導入