Menu

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

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バイタル

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

これらのメトリクスの結果はすべて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 Analyticsを使用している場合、id値を使用すると、メトリック分布を手動で構築することができます（パーセンタイルなどを計算するため）。

useReportWebVitals((metric) => {
  // この例のようにGoogle Analyticsを初期化した場合は`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 Analyticsに結果を送信するの詳細をご覧ください。