Analytics

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

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

より高度な分析と監視のニーズに対応するために、Next.jsはinstrumentation-client.js|tsファイルを提供しています。このファイルは、アプリケーションのフロントエンドコードが実行される前に実行されます。これは、グローバルな分析、エラートラッキング、またはパフォーマンス監視ツールを設定するのに理想的です。

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

instrumentation-client.js
// アプリが開始する前に分析を初期化
console.log('Analytics initialized')

// グローバルエラートラッキングを設定
window.addEventListener('error', (event) => {
  // エラートラッキングサービスに送信
  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"ディレクティブを必要とするため、最もパフォーマンスの高いアプローチは、root レイアウトがインポートする別のコンポーネントを作成することです。これにより、クライアントの境界が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 })
  }
})

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への結果の送信について詳しく読む.

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

自分で構築する​

Web Vitals​

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

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

自分で構築する

Web Vitals

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