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

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)の名前を含むことができます。
delta: メトリックの現在値と以前の値の差。値は通常ミリ秒単位で、時間の経過に伴うメトリック値の変化を表します。
entries: メトリックに関連付けられたパフォーマンスエントリの配列。これらのエントリは、メトリックに関連するパフォーマンスイベントに関する詳細情報を提供します。
navigationType: メトリック収集をトリガーしたナビゲーションのタイプを示します。考えられる値は、"navigate"、"reload"、"back_forward"、および"prerender"です。
rating: メトリック値の定性的な評価であり、パフォーマンスの評価を提供します。考えられる値は、"good"、"needs-improvement"、および"poor"です。評価は通常、メトリック値を許容可能なパフォーマンスまたは準最適なパフォーマンスを示す事前定義されたしきい値と比較することによって決定されます。
value: パフォーマンスエントリの実際の値または期間。通常はミリ秒単位です。値は、メトリックによって追跡されているパフォーマンス側面の定量的尺度を提供します。値のソースは、測定されている特定のメトリックによって異なり、さまざまなパフォーマンス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 アナリティクスを使用している場合、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 アナリティクスに結果を送信する方法の詳細をご覧ください。