Настройка аналитики

Next.js имеет встроенную поддержку измерения и отчетности по метрикам производительности. Вы можете использовать хук useReportWebVitals для самостоятельного управления отчетностью или воспользоваться управляемым сервисом от Vercel для автоматического сбора и визуализации метрик.

Клиентская инструментация

Для более сложных задач аналитики и мониторинга Next.js предоставляет файл instrumentation-client.js|ts, который выполняется перед запуском фронтенд-кода вашего приложения. Это идеально подходит для настройки глобальных инструментов аналитики, отслеживания ошибок или мониторинга производительности.

Чтобы использовать его, создайте файл instrumentation-client.js или instrumentation-client.ts в корневой директории вашего приложения:

// Инициализация аналитики перед запуском приложения
console.log('Аналитика инициализирована')

// Настройка глобального отслеживания ошибок
window.addEventListener('error', (event) => {
  // Отправка в сервис отслеживания ошибок
  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 — это набор полезных метрик, которые позволяют оценить пользовательский опыт взаимодействия с веб-страницей. Включает следующие метрики:

• Time to First Byte (TTFB)
• First Contentful Paint (FCP)
• Largest Contentful Paint (LCP)
• First Input Delay (FID)
• Cumulative Layout Shift (CLS)
• Interaction to Next Paint (INP)

Вы можете обрабатывать результаты всех этих метрик с помощью свойства name.

import { useReportWebVitals } from 'next/web-vitals'

function MyApp({ Component, pageProps }) {
  useReportWebVitals((metric) => {
    switch (metric.name) {
      case 'FCP': {
        // обработка результатов FCP
      }
      case 'LCP': {
        // обработка результатов LCP
      }
      // ...
    }
  })

  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':
      // обработка результатов гидратации
      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) => {
  // Используйте `window.gtag`, если вы инициализировали Google Analytics, как в этом примере:
  // 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.