如何设置分析

Next.js 内置支持测量和报告性能指标。你可以使用 useReportWebVitals 钩子自行管理报告，或者 Vercel 提供了一项托管服务，可以自动为你收集和可视化指标。

客户端测量

对于更高级的分析和监控需求，Next.js 提供了一个 `instrumentation-client.js|ts` 文件，该文件在应用程序前端代码开始执行之前运行。这非常适合设置全局分析、错误跟踪或性能监控工具。

要使用它，请在应用程序的根目录中创建一个 `instrumentation-client.js` 或 `instrumentation-client.ts` 文件。

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

自行构建

import { useReportWebVitals } from 'next/web-vitals'
 
function MyApp({ Component, pageProps }) {
  useReportWebVitals((metric) => {
    console.log(metric)
  })
 
  return <Component {...pageProps} />
}

更多信息请查阅 API 参考。

Web Vitals

Web Vitals 是一组有用的指标，旨在捕捉网页的用户体验。包括以下所有 Web Vitals：

您可以使用 name 属性处理所有这些指标的结果。

import { useReportWebVitals } from 'next/web-vitals'
 
function MyApp({ Component, pageProps }) {
  useReportWebVitals((metric) => {
    switch (metric.name) {
      case 'FCP': {
        // handle FCP results
      }
      case 'LCP': {
        // handle LCP results
      }
      // ...
    }
  })
 
  return <Component {...pageProps} />
}

自定义指标

除了上面列出的核心指标，还有一些额外的自定义指标，用于衡量页面水合和渲染所需的时间。

Next.js-hydration：页面开始和完成水合的时间长度（毫秒）
Next.js-route-change-to-render：路由更改后页面开始渲染的时间长度（毫秒）
Next.js-render：路由更改后页面完成渲染的时间长度（毫秒）

你可以单独处理这些指标的所有结果。

export function reportWebVitals(metric) {
  switch (metric.name) {
    case 'Next.js-hydration':
      // handle hydration results
      break
    case 'Next.js-route-change-to-render':
      // handle route-change to render results
      break
    case 'Next.js-render':
      // handle render results
      break
    default:
      break
  }
}

这些指标适用于所有支持 User Timing API 的浏览器。

将结果发送到外部系统

您可以将结果发送到任何端点，以衡量和跟踪您网站上的真实用户性能。例如：

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的信息。