コンテンツにスキップ
APIリファレンス関数useReportWebVitals

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

useReportWebVitals

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

  • id: 現在のページ読み込みのコンテキストにおけるメトリックの一意の識別子
  • name: パフォーマンスメトリックの名前。Web Vitals メトリック (TTFB, FCP, LCP, FID, CLS) の名前など、Webアプリケーションに固有のものが含まれます。
  • 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 プロパティを使用して処理できます。

app/components/web-vitals.tsx
'use client'
 
import { useReportWebVitals } from 'next/web-vitals'
 
export function WebVitals() {
  useReportWebVitals((metric) => {
    switch (metric.name) {
      case 'FCP': {
        // handle FCP results
      }
      case 'LCP': {
        // handle LCP results
      }
      // ...
    }
  })
}

Vercelでの使用

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

結果を外部システムに送信する

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

useReportWebVitals((metric) => {
  const body = JSON.stringify(metric)
  const url = 'https://example.com/analytics'
 
  // Use `navigator.sendBeacon()` if available, falling back to `fetch()`.
  if (navigator.sendBeacon) {
    navigator.sendBeacon(url, body)
  } else {
    fetch(url, { body, method: 'POST', keepalive: true })
  }
})

注意点: Google Analytics を使用している場合、id 値を使用すると、手動でメトリック分布を構築できます (パーセンタイルなどを計算するため)。

useReportWebVitals(metric => {
  // Use `window.gtag` if you initialized Google Analytics as this example:
  // 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), // values must be integers
    event_label: metric.id, // id unique to current page load
    non_interaction: true, // avoids affecting bounce rate.
  });
}

Google Analytics への結果送信 の詳細はこちらをご覧ください。