アナリティクスの設定方法

Next.jsにはパフォーマンスメトリクスの測定とレポート作成のための組み込みサポートがあります。useReportWebVitalsフックを使用して自分でレポート管理を行うか、またはVercelが提供するマネージドサービスを利用してメトリクスを自動的に収集・可視化できます。

クライアントインストルメンテーション

より高度なアナリティクスとモニタリングの必要性に対応するため、Next.jsはアプリケーションのフロントエンドコードが実行される前に実行されるinstrumentation-client.js|tsファイルを提供しています。これはグローバルなアナリティクス、エラートラッキング、またはパフォーマンスモニタリングツールをセットアップするのに理想的です。

使用するには、アプリケーションのルートディレクトリにinstrumentation-client.jsまたはinstrumentation-client.tsファイルを作成します：

instrumentation-client.js

// アプリ開始前にアナリティクスを初期化
console.log('Analytics initialized')

// グローバルエラートラッキングを設定
window.addEventListener('error', (event) => {
  // エラートラッキングサービスに送信
  reportError(event.error)
})

独自の実装

pages/_app.js

import { useReportWebVitals } from 'next/web-vitals'

function MyApp({ Component, pageProps }) {
  useReportWebVitals((metric) => {
    console.log(metric)
  })

  return <Component {...pageProps} />
}

詳細についてはAPIリファレンスを参照してください。

Web Vitals

Web Vitalsはウェブページのユーザー体験を把握するための有用なメトリクスセットです。以下のWeb Vitalsがすべて含まれています：

これらのメトリクスの結果はすべてnameプロパティを使用して処理できます。

pages/_app.js

import { useReportWebVitals } from 'next/web-vitals'

function MyApp({ Component, pageProps }) {
  useReportWebVitals((metric) => {
    switch (metric.name) {
      case 'FCP': {
        // FCP結果を処理
      }
      case 'LCP': {
        // LCP結果を処理
      }
      // ...
    }
  })

  return <Component {...pageProps} />
}

カスタムメトリクス

上記のコアメトリクスに加えて、ページのハイドレーションとレンダリングにかかる時間を測定する追加のカスタムメトリクスがあります：

Next.js-hydration: ページのハイドレーション開始から完了までの時間（ミリ秒）
Next.js-route-change-to-render: ルート変更後のページレンダリング開始までの時間（ミリ秒）
Next.js-render: ルート変更後のページレンダリング完了までの時間（ミリ秒）

これらのメトリクスの結果は個別に処理できます：

export function reportWebVitals(metric) {
  switch (metric.name) {
    case 'Next.js-hydration':
      // ハイドレーション結果を処理
      break
    case 'Next.js-route-change-to-render':
      // ルート変更からレンダリングまでの結果を処理
      break
    case 'Next.js-render':
      // レンダリング結果を処理
      break
    default:
      break
  }
}

これらのメトリクスはUser Timing APIをサポートするすべてのブラウザで動作します。

外部システムへの結果送信

結果を任意のエンドポイントに送信して、サイト上の実際のユーザーパフォーマンスを測定・追跡できます。例：

useReportWebVitals((metric) => {
  const body = JSON.stringify(metric)
  const url = 'https://example.com/analytics'

  // 利用可能な場合は`navigator.sendBeacon()`を使用し、フォールバックとして`fetch()`を使用
  if (navigator.sendBeacon) {
    navigator.sendBeacon(url, body)
  } else {
    fetch(url, { body, method: 'POST', keepalive: true })
  }
})

知っておくと良い: Googleアナリティクスを使用する場合、 id値を使用すると手動でメトリクス分布を構築できます（パーセンタイル計算など）

useReportWebVitals((metric) => {
  // この例のようにGoogleアナリティクスを初期化した場合は`window.gtag`を使用：
  // https://github.com/vercel/next.js/blob/canary/examples/with-google-analytics
  window.gtag('event', metric.name, {
    value: Math.round(
      metric.name === 'CLS' ? metric.value * 1000 : metric.value
    ), // 値は整数でなければなりません
    event_label: metric.id, // 現在のページロードに固有のID
    non_interaction: true, // バウンス率に影響を与えません
  })
})

Googleアナリティクスへの結果送信について詳しく読む。