Analytics

Next.jsは、パフォーマンスのメトリクスを測定し、報告するための組み込みサポートを提供しています。useReportWebVitalsフックを使用して自分で報告を管理するか、代わりにVercelの管理サービスを利用して自動的にメトリクスを収集および可視化することができます。

自分で構築する

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

詳細についてはAPIリファレンスをご覧ください。

Web Vitals

Web Vitalsは、ウェブページのユーザーエクスペリエンスを把握するための有用なメトリクスのセットです。以下の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の結果を処理する
      }
      // ...
    }
  })
}

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

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

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への結果の送信についての詳細を読む。

自分で構築する​

Web Vitals​

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

自分で構築する

Web Vitals

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