useReportWebVitals

useReportWebVitals フックを使用すると、Core Web Vitals をレポートでき、アナリティクスサービスと組み合わせて使用できます。

useReportWebVitals に渡された新しい関数は、その時点で利用可能なメトリクスと共に呼び出されます。重複したデータのレポートを防ぐため、コールバック関数の参照が変更されないようにしてください（以下のコード例を参照）。

app/_components/web-vitals.js

'use client'

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

const logWebVitals = (metric) => {
  console.log(metric)
}

export function WebVitals() {
  useReportWebVitals(logWebVitals)

  return null
}

app/layout.js

import { WebVitals } from './_components/web-vitals'

export default function Layout({ children }) {
  return (
    <html>
      <body>
        <WebVitals />
        {children}
      </body>
    </html>
  )
}

useReportWebVitals フックには 'use client' ディレクティブが必要なため、最もパフォーマンスの良いアプローチは、ルートレイアウトがインポートする別個のコンポーネントを作成することです。これにより、クライアント境界を WebVitals コンポーネントのみに限定できます。

フックの引数として渡される metric オブジェクトは、以下のプロパティで構成されています：

id: 現在のページロードコンテキストにおけるメトリクスの一意な識別子
name: パフォーマンスメトリクスの名前。Web Vitals メトリクス（TTFB、FCP、LCP、FID、CLS）の名前など、ウェブアプリケーション固有の値が含まれます。
delta: メトリクスの現在値と前回値の差。値は通常ミリ秒単位で、時間経過に伴うメトリクス値の変化を表します。
entries: メトリクスに関連する Performance Entries の配列。これらのエントリは、メトリクスに関連するパフォーマンスイベントの詳細情報を提供します。
navigationType: メトリクス収集をトリガーしたナビゲーションの種類を示します。"navigate"、"reload"、"back_forward"、"prerender" などの値が可能です。
rating: メトリクス値の定性的評価で、パフォーマンスの評価を提供します。"good"、"needs-improvement"、"poor" などの値が可能です。評価は通常、許容可能または最適ではないパフォーマンスを示す事前定義された閾値とメトリクス値を比較して決定されます。
value: パフォーマンスエントリの実際の値または持続時間で、通常はミリ秒単位です。この値は、メトリクスが追跡するパフォーマンス側面の定量的尺度を提供します。値のソースは測定対象の特定のメトリクスに依存し、様々な Performance API から取得できます。

Web Vitals

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

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

'use client'

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

type ReportWebVitalsCallback = Parameters<typeof useReportWebVitals>[0]

const handleWebVitals: ReportWebVitalsCallback = (metric) => {
  switch (metric.name) {
    case 'FCP': {
      // FCP の結果を処理
    }
    case 'LCP': {
      // LCP の結果を処理
    }
    // ...
  }
}

export function WebVitals() {
  useReportWebVitals(handleWebVitals)
}

'use client'

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

const handleWebVitals = (metric) => {
  switch (metric.name) {
    case 'FCP': {
      // FCP の結果を処理
    }
    case 'LCP': {
      // LCP の結果を処理
    }
    // ...
  }
}

export function WebVitals() {
  useReportWebVitals(handleWebVitals)
}

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

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

function postWebVitals(metrics) {
  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 })
  }
}

useReportWebVitals(postWebVitals)

豆知識: 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 への結果送信について詳しく読む。

useReportWebVitals