Как добавить аналитику в ваше Next.js приложение

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

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

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

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

instrumentation-client.js

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

// Настройка глобального отслеживания ошибок
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', наиболее производительный подход — создать отдельный компонент, который импортируется в корневой макет. Это ограничивает клиентскую границу исключительно компонентом WebVitals.

Подробнее см. в справочнике API.

Web Vitals

Web Vitals — это набор полезных метрик, которые позволяют оценить пользовательский опыт взаимодействия с веб-страницей. Включает следующие метрики:

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

'use client'

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

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

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

Полезно знать: Если вы используете 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.

Как добавить аналитику в ваше Next.js приложение

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

Собственная реализация

Web Vitals

Отправка результатов во внешние системы

On this page