useReportWebVitals

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

Новые функции, передаваемые в useReportWebVitals, вызываются с доступными на тот момент метриками. Чтобы избежать дублирования отчетов, убедитесь, что ссылка на функцию обратного вызова не изменяется (как показано в примерах кода ниже).

pages/_app.js

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

const logWebVitals = (metric) => {
  console.log(metric)
}

function MyApp({ Component, pageProps }) {
  useReportWebVitals(logWebVitals)

  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'

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

function MyApp({ Component, pageProps }) {
  useReportWebVitals(handleWebVitals)

  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 handleCustomMetrics(metrics) {
  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
  }
}

function MyApp({ Component, pageProps }) {
  useReportWebVitals(handleCustomMetrics)

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

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

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

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

function postWebVitals(metrics) {
  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 })
  }
}

useReportWebVitals(postWebVitals)

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

useReportWebVitals