useReportWebVitals

useReportWebVitalsフックを使用すると、Core Web Vitalsを報告でき、分析サービスと組み合わせて使用することができます。

app/_components/web-vitals.js
'use client'

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

export function WebVitals() {
  useReportWebVitals((metric) => {
    console.log(metric)
  })

  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"ディレクティブを必要とするため、最もパフォーマンスの高いアプローチは、root レイアウトがインポートする別のコンポーネントを作成することです。これにより、クライアントの境界がWebVitalsコンポーネントに限定されます。

useReportWebVitals

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

id: 現在のページロードのコンテキストでのメトリックの一意の識別子
name: パフォーマンスメトリックの名前。可能な値には、Webアプリケーションに特有の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ページのユーザーエクスペリエンスをキャプチャすることを目的とした一連の有用なメトリックです。以下のWeb Vitalsがすべて含まれています：

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

TypeScript
JavaScript

app/components/web-vitals.tsx
'use client'

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

export function WebVitals() {
  useReportWebVitals((metric) => {
    switch (metric.name) {
      case 'FCP': {
        // FCPの結果を処理
      }
      case 'LCP': {
        // LCPの結果を処理
      }
      // ...
    }
  })
}

app/components/web-vitals.js
'use client'

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

export function WebVitals() {
  useReportWebVitals((metric) => {
    switch (metric.name) {
      case 'FCP': {
        // FCPの結果を処理
      }
      case 'LCP': {
        // LCPの結果を処理
      }
      // ...
    }
  })
}

Vercelでの使用

Vercel Speed InsightsはuseReportWebVitalsを使用せず、代わりに@vercel/speed-insightsパッケージを使用します。 useReportWebVitalsフックは、ローカル開発中や、Web Vitalsを収集するために別のサービスを使用している場合に便利です。

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

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

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 })
  }
})

Good to know: 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​

Web Vitals​

Vercelでの使用​

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

useReportWebVitals

Web Vitals

Vercelでの使用

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