コンテンツをスキップ

アナリティクス

Next.jsには、パフォーマンス指標を測定およびレポートするための組み込みサポートがあります。レポートを自分で管理するには`useReportWebVitals`フックを使用するか、Vercelが自動的に指標を収集および可視化するためのマネージドサービスを提供しています。

クライアント側のインストゥルメンテーション

より高度なアナリティクスおよび監視ニーズに対応するため、Next.jsはアプリケーションのフロントエンドコードが実行を開始する前に実行される`instrumentation-client.js|ts`ファイルを提供します。これは、グローバルなアナリティクス、エラー追跡、パフォーマンス監視ツールを設定するのに理想的です。

使用するには、アプリケーションのルートディレクトリに`instrumentation-client.js`または`instrumentation-client.ts`ファイルを作成します。

instrumentation-client.js
// Initialize analytics before the app starts
console.log('Analytics initialized')
 
// Set up global error tracking
window.addEventListener('error', (event) => {
  // Send to your error tracking service
  reportError(event.error)
})

独自に構築

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`コンポーネントのみに限定されます。

詳細については、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
      }
      // ...
    }
  })
}

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

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

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への結果送信について詳しくはこちらをご覧ください。