分析工具

Next.js Speed Insights 讓您能透過不同指標分析與測量頁面效能。

您可以在 Vercel 部署上零配置開始收集真實體驗分數 (Real Experience Score)。

本文檔其餘部分描述了 Next.js Speed Insights 使用的內建轉發器。

自建分析

首先，您需要建立一個自訂 App 元件並定義 reportWebVitals 函式：

pages/_app.js

export function reportWebVitals(metric) {
  console.log(metric)
}

function MyApp({ Component, pageProps }) {
  return <Component {...pageProps} />
}

export default MyApp

當頁面上任何指標的最終值計算完成時，此函式會被觸發。您可以用它將結果記錄到控制台或發送到特定端點。

傳遞給此函式的 metric 物件包含以下屬性：

id：當前頁面載入情境下指標的唯一識別碼
name：指標名稱
startTime：效能條目的首次記錄時間戳（單位為毫秒）（如適用）
value：效能條目的值或持續時間（單位為毫秒）
label：指標類型 (web-vital 或 custom)

追蹤的指標有兩種類型：

Web 核心指標 (Web Vitals)
自訂指標

Web 核心指標

Web 核心指標 (Web Vitals) 是一組實用的指標，旨在捕捉網頁的使用者體驗。包含以下所有核心指標：

您可以使用 web-vital 標籤處理所有這些指標的結果：

export function reportWebVitals(metric) {
  if (metric.label === 'web-vital') {
    console.log(metric) // 將指標物件 ({ id, name, startTime, value, label }) 記錄到控制台
  }
}

也可以選擇分別處理每個指標：

export function reportWebVitals(metric) {
  switch (metric.name) {
    case 'FCP':
      // 處理 FCP 結果
      break
    case 'LCP':
      // 處理 LCP 結果
      break
    case 'CLS':
      // 處理 CLS 結果
      break
    case 'FID':
      // 處理 FID 結果
      break
    case 'TTFB':
      // 處理 TTFB 結果
      break
    case 'INP':
      // 處理 INP 結果（注意：INP 仍為實驗性指標）
      break
    default:
      break
  }
}

測量這些指標使用了第三方函式庫 web-vitals。瀏覽器相容性取決於特定指標，請參考瀏覽器支援章節了解支援的瀏覽器。

自訂指標

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

Next.js-hydration：頁面開始到完成水合所花費的時間（單位：毫秒）
Next.js-route-change-to-render：路由變更後頁面開始渲染所花費的時間（單位：毫秒）
Next.js-render：路由變更後頁面完成渲染所花費的時間（單位：毫秒）

您可以使用 custom 標籤處理所有這些指標的結果：

export function reportWebVitals(metric) {
  if (metric.label === 'custom') {
    console.log(metric) // 將指標物件 ({ id, name, startTime, value, label }) 記錄到控制台
  }
}

也可以選擇分別處理每個指標：

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

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

將結果發送到外部系統

透過轉發函式，您可以將結果發送到任何端點以測量和追蹤網站上的真實使用者效能。例如：

export function reportWebVitals(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 值可以手動建構指標分佈（以計算百分位數等）

export function reportWebVitals({ id, name, label, value }) {
  // 若您已初始化 Google Analytics 如本例所示，請使用 `window.gtag`：
  // https://github.com/vercel/next.js/blob/canary/examples/with-google-analytics/pages/_app.js
  window.gtag('event', name, {
    event_category:
      label === 'web-vital' ? 'Web Vitals' : 'Next.js custom metric',
    value: Math.round(name === 'CLS' ? value * 1000 : value), // 值必須為整數
    event_label: id, // 當前頁面載入的唯一識別碼
    non_interaction: true, // 避免影響跳出率
  })
}

了解更多關於將結果發送到 Google Analytics。

TypeScript

如果您使用 TypeScript，可以使用內建類型 NextWebVitalsMetric：

import type { AppProps, NextWebVitalsMetric } from 'next/app'

function MyApp({ Component, pageProps }: AppProps) {
  return <Component {...pageProps} />
}

export function reportWebVitals(metric: NextWebVitalsMetric) {
  console.log(metric)
}

export default MyApp

function MyApp({ Component, pageProps }) {
  return <Component {...pageProps} />
}

export function reportWebVitals(metric) {
  console.log(metric)
}

export default MyApp

自建分析

Web 核心指標

自訂指標

將結果發送到外部系統

TypeScript

On this page