分析

Next.js 內建支援測量與回報效能指標。您可以使用 useReportWebVitals 鉤子自行管理回報,或者 Vercel 提供 託管服務 來自動收集並視覺化指標。

自行建置

pages/_app.js
import { useReportWebVitals } from 'next/web-vitals'

function MyApp({ Component, pageProps }) {
  useReportWebVitals((metric) => {
    console.log(metric)
  })

  return <Component {...pageProps} />
}

查看 API 參考文件 以取得更多資訊。

Web 核心指標

Web 核心指標 是一組實用的指標,旨在捕捉網頁的使用者體驗。以下指標均包含在內:

您可以使用 name 屬性來處理這些指標的所有結果。

pages/_app.js
import { useReportWebVitals } from 'next/web-vitals'

function MyApp({ Component, pageProps }) {
  useReportWebVitals((metric) => {
    switch (metric.name) {
      case 'FCP': {
        // 處理 FCP 結果
      }
      case 'LCP': {
        // 處理 LCP 結果
      }
      // ...
    }
  })

  return <Component {...pageProps} />
}

自訂指標

除了上述核心指標外,還有一些額外的自訂指標用於測量頁面水合 (hydrate) 和渲染所花費的時間:

  • Next.js-hydration: 頁面開始並完成水合所花費的時間 (單位:毫秒)
  • Next.js-route-change-to-render: 路由變更後頁面開始渲染所花費的時間 (單位:毫秒)
  • Next.js-render: 路由變更後頁面完成渲染所花費的時間 (單位:毫秒)

您可以分別處理這些指標的結果:

export function reportWebVitals(metric) {
  switch (metric.name) {
    case 'Next.js-hydration':
      // 處理水合結果
      break
    case 'Next.js-route-change-to-render':
      // 處理路由變更至渲染的結果
      break
    case 'Next.js-render':
      // 處理渲染結果
      break
    default:
      break
  }
}

這些指標在所有支援 User Timing API 的瀏覽器中均可使用。

將結果傳送至外部系統

您可以將結果傳送至任何端點,以測量與追蹤網站上的真實使用者效能。例如:

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/pages/_app.js
  window.gtag('event', metric.name, {
    value: Math.round(
      metric.name === 'CLS' ? metric.value * 1000 : metric.value
    ), // 值必須為整數
    event_label: metric.id, // 當前頁面載入的唯一識別碼
    non_interaction: true, // 避免影響跳出率
  })
})

閱讀更多關於 將結果傳送至 Google Analytics 的資訊。

On this page