Menu

分析

Next.jsはパフォーマンスメトリクスの測定とレポート作成に組み込みのサポートを提供します。useReportWebVitalsフックを使用して自分でレポーティングを管理するか、あるいは、Vercelがマネージドサービスを提供し、メトリクスを自動的に収集および視覚化します。

独自に構築する

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ページのユーザーエクスペリエンスをキャプチャすることを目的とした有用なメトリクスのセットです。以下の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
  }
}

これらのメトリクスは、ユーザータイミング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に結果を送信についての詳細をお読みください。