useReportWebVitals

Хук useReportWebVitals позволяет отчитываться о Core Web Vitals и может использоваться в сочетании с вашим сервисом аналитики.

pages/_app.js

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

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

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

Объект metric, передаваемый в качестве аргумента хука, состоит из нескольких свойств:

id: Уникальный идентификатор метрики в контексте текущей загрузки страницы
name: Название метрики производительности. Возможные значения включают названия метрик Web Vitals (TTFB, FCP, LCP, FID, CLS), специфичных для веб-приложений.
delta: Разница между текущим и предыдущим значением метрики. Значение обычно указывается в миллисекундах и отражает изменение значения метрики с течением времени.
entries: Массив Performance Entries, связанных с метрикой. Эти записи предоставляют детальную информацию о событиях производительности, связанных с метрикой.
navigationType: Указывает тип навигации, который вызвал сбор метрики. Возможные значения: "navigate", "reload", "back_forward" и "prerender".
rating: Качественная оценка значения метрики, отражающая уровень производительности. Возможные значения: "good", "needs-improvement" и "poor". Оценка обычно определяется сравнением значения метрики с предопределёнными порогами, указывающими на приемлемую или неоптимальную производительность.
value: Фактическое значение или продолжительность записи производительности, обычно в миллисекундах. Значение предоставляет количественную меру аспекта производительности, отслеживаемого метрикой. Источник значения зависит от конкретной измеряемой метрики и может поступать из различных Performance API.

Web Vitals

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

Вы можете обрабатывать результаты всех этих метрик с помощью свойства 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} />
}

Пользовательские метрики

В дополнение к основным метрикам, перечисленным выше, существуют дополнительные пользовательские метрики, измеряющие время гидратации и рендеринга страницы:

Next.js-hydration: Время, необходимое для начала и завершения гидратации страницы (в мс)
Next.js-route-change-to-render: Время от изменения маршрута до начала рендеринга страницы (в мс)
Next.js-render: Время, необходимое для завершения рендеринга страницы после изменения маршрута (в мс)

Вы можете обрабатывать результаты этих метрик отдельно:

pages/_app.js

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

function MyApp({ Component, pageProps }) {
  useReportWebVitals((metric) => {
    switch (metric.name) {
      case 'Next.js-hydration':
        // обработка результатов гидратации
        break
      case 'Next.js-route-change-to-render':
        // обработка результатов route-change to render
        break
      case 'Next.js-render':
        // обработка результатов рендеринга
        break
      default:
        break
    }
  })

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

Эти метрики работают во всех браузерах, поддерживающих User Timing API.

Vercel Speed Insights автоматически настраиваются при развертывании на Vercel и не требуют использования useReportWebVitals. Этот хук полезен при локальной разработке или при использовании другого сервиса аналитики.

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

Вы можете отправлять результаты на любой эндпоинт для измерения и отслеживания производительности реальных пользователей на вашем сайте. Например:

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/pages/_app.js
  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.

useReportWebVitals