Core Web Vitalsをweb-vitalsで確かめる方法

​​Core Web Vitals​Chrome,JavaScript,TypeScript,web-vitals

web-vitals ライブラリの onLCP・onCLS・onINP に、値を console.log で出す関数を渡すと、自分のページで測った Core Web Vitals の値をブラウザのコンソールで確かめられます。開発中に、手元のページの LCP(表示の速さ)、CLS(レイアウトのずれ)、INP(操作への反応の速さ)を確かめたいときに使える方法です。

ただし、ページを開いただけでは何も出ません。検証したページでは、読み込みから3秒待っても何も出ず、クリックすると LCP が、別のタブに切り替えると CLS と INP が出ました。ここでは、その出るタイミングと、開発中に便利な reportAllChanges を付けたときの違いを、実際の出力のまま載せます。

補足

検証環境は Ubuntu 24.04、Node.js 22、web-vitals 6.2.3、TypeScript 5.9、esbuild 0.28 です。ブラウザは、Playwright 1.63.0 に入っている Chrome for Testing 153 を、ヘッドレスで直接起動して使いました。ページは検証環境で動かしたサーバー(localhost:8080)から配り、幅 412px・高さ 823px の画面で開いています。クリックとタブの切り替えは、Chrome DevTools Protocol で自動で行いました。DevTools のコンソールの画面そのもの、Firefox と Safari、CDN からの読み込み、測った値をサーバーに送る方法は試していません。

LCP・CLS・INPをコンソールに出すコード

web-vitals は npm で入れます。

console
$ npm i web-vitals@6.2.3

指標ごとに onLCP・onCLS・onINP という関数があり、どれも「値が出せる状態になったら呼ばれる関数」を受け取ります。web-vitals の README にある基本の形は、onLCP(console.log) のように console.log をそのまま渡すものです。そのままでも値は出ますが、検証では、名前・値・評価を1行にまとめて読みやすくしました。

ts
// src/vitals.ts
import { onCLS, onINP, onLCP, type Metric } from 'web-vitals';

// 受け取った値を、名前・値・評価の1行と、オブジェクト全体に分けて出す
function log(metric: Metric): void {
  const value =
    metric.name === 'CLS' ? metric.value.toFixed(4) : `${Math.round(metric.value)} ms`;
  console.log(`[web-vitals] ${metric.name}: ${value} (${metric.rating})`, metric);
}

onLCP(log);
onCLS(log);
onINP(log);

受け取る metric の型は、web-vitals が Metric として用意しています。LCP と INP の value はミリ秒、CLS の value は単位のないスコアです。rating には、値から決まった評価が 'good'・'needs-improvement'・'poor' のどれかで入ります。

このファイルを esbuild で1つの JavaScript にまとめ、ページの <head> で読み込みました。tsc での型チェックも通っています。

console
$ npx tsc -p . && echo typecheck-ok
typecheck-ok
$ npx esbuild src/vitals.ts --bundle --format=esm --outfile=build/vitals.js
  build/vitals.js  11.8kb
⚡ Done in 5ms
html
<script type="module" src="/vitals.js"></script>

README によると、web-vitals は PerformanceObserver の buffered フラグを使うので、ライブラリを読み込む前に記録された計測データ(performance entry)も受け取れます。早い時点で読み込む必要はありません。

3つの指標が動くように作った検証用のページ

値が実際に動くように、検証用のページには次の3つを入れました。

  • LCP:大きな画像(1200×675)を置き、サーバーが画像だけ 800 ミリ秒待ってから返す
  • CLS:読み込みから1秒後に、画像の上へお知らせの帯を差し込み、画像を押し下げる
  • INP:「保存」ボタンは押すと 200 ミリ秒、「まとめて保存」ボタンは 400 ミリ秒、処理を続けてから表示を変える

実際の重い処理の代わりに、決めた時間だけメインスレッドを使い続けるループを入れています。

js
// 押すと、決めた時間だけメインスレッドを使い続けてから表示を変える
const busy = (ms) => { const end = performance.now() + ms; while (performance.now() < end) {} };
document.getElementById('save').addEventListener('click', () => {
  busy(200);
  document.getElementById('status').textContent = '保存しました。';
});

このページを開き、3秒待ってから「保存」を2回クリックし、別のタブに切り替えて戻り、「まとめて保存」をクリックしてから、もう一度別のタブに切り替えました。コンソールに出た内容は、時刻を付けて記録するスクリプト(cdp-run.mjs)で集めています。

ページを開いただけでは何も出ない

次が、その記録です。左の時刻は、ページを開き始めてからの経過時間です。---- の行が行った操作、console.log: の行がページのコンソールに出た内容です。| より後ろは、console.log に渡した metric のオブジェクトから、記録用のスクリプトが取り出した値です(id と entries は省きました)。

console
$ node cdp-run.mjs page interact
    0ms  ---- /page.html を開く
  838ms  ---- load
 3845ms  ---- load から3秒待った visibilityState=visible
 3847ms  ---- 「保存」をクリック(1回目の操作)
 4856ms  console.log: [web-vitals] LCP: 848 ms (good) | delta=848 navigationType=navigate
 5560ms  ---- 「保存」をクリック(2回目の操作)
 7266ms  ---- 別のタブを開いて前に出す
 7283ms  console.log: [web-vitals] INP: 208 ms (needs-improvement) | delta=208 navigationType=navigate
 7283ms  console.log: [web-vitals] CLS: 0.0442 (good) | delta=0.04415332888018582 navigationType=navigate
 8300ms  ----   (1秒後)visibilityState=hidden
 8300ms  ---- 別のタブを閉じて元のタブに戻る
 9319ms  ----   (1秒後)visibilityState=visible
 9320ms  ---- 「まとめて保存」をクリック(3回目の操作)
11226ms  ---- 別のタブを開いて前に出す
11242ms  console.log: [web-vitals] INP: 400 ms (needs-improvement) | delta=192 navigationType=navigate
12251ms  ----   (1秒後)visibilityState=hidden
12251ms  ---- 終了

画像は 0.8 秒ほどで表示され、お知らせの帯も1秒ほどで入っていますが、load から3秒たっても、コンソールには何も出ていません。2回測ったところ、出た順番と LCP 以外の値は同じでした(LCP は 848 ms と 876 ms)。

それぞれの値が出たのは、次のときです。

  • LCP:1回目のクリックの約1秒後。クリックで LCP の値が決まる
  • CLS と INP:別のタブに切り替えて、ページが見えなくなった(visibilityState が hidden になった)とき

README には、指標の中には、ページを操作したり、タブを切り替えたり、ページを離れ始めたりするまで値を出さないものがあると書かれています。コンソールに何も出ないときは、ページをクリックするか、別のタブに切り替えてから戻ってください。

LCP がクリックの直後に出なかったのは、web-vitals 6.2.3 の onLCP のソースコードで、クリックやキー入力を受けたときの処理を requestIdleCallback に回しているためです。待つのは最長で1秒で、ページが見えなくなったときはすぐに出します。検証では、ほぼその上限の約1秒後に出ました。

見えなくなるたびに出るが、値が変わらなければ出ない

CLS と INP は、ページが見えなくなるたびに値を出し直します。ただし、検証では2回目に別のタブに切り替えたとき、出たのは INP だけでした。

INP は、2回目の切り替えの前に 400 ミリ秒の「まとめて保存」を押したので、208 ms から 400 ms に増えていました。このときの delta は 192 で、前回出した値から増えた分です。CLS は、1回目に出した後にレイアウトのずれが起きておらず、値が変わっていないので出ませんでした。

web-vitals 6.2.3 の値を出す部分のソースコードでも、一度出した後は、前回からの差(delta)が 0 なら呼ばれないようになっています(最初の1回は、値が 0 でも呼ばれます)。同じ指標を出し直したときの id は、1回目と同じでした(検証の記録では、INP の2回とも v6-1794656809341-6830973628190)。README には、値をサーバーに送る場合は、この id で同じ指標をまとめられると書かれています。

一度も操作しないと、INPは出ない

ページを開いて3秒待ち、一度もクリックしないまま別のタブに切り替えると、CLS と LCP だけが出ました。

console
$ node cdp-run.mjs page no-input
    0ms  ---- /page.html を開く
  851ms  ---- load
 3857ms  ---- load から3秒待った visibilityState=visible
 3858ms  ---- 別のタブを開いて前に出す
 3871ms  console.log: [web-vitals] CLS: 0.0442 (good) | delta=0.04415332888018582 navigationType=navigate
 3872ms  console.log: [web-vitals] LCP: 860 ms (good) | delta=860 navigationType=navigate
 4888ms  ----   (1秒後)visibilityState=hidden
 4888ms  ---- 終了

INP は操作への反応の速さなので、操作がなければ値がありません。README にも、ページが一度も操作されなければ INP は出ないと書かれています。このときの LCP は、クリックのときと違い、タブを切り替えてからすぐに出ました。

reportAllChangesを付けると、値が変わるたびに出る

開発中に値の動きを追いたいときは、2つ目の引数に { reportAllChanges: true } を渡します。値が変わるたびに呼ばれるようになります。

ts
// src/vitals-all.ts
import { onCLS, onINP, onLCP, type Metric } from 'web-vitals';

function log(metric: Metric): void {
  const value =
    metric.name === 'CLS' ? metric.value.toFixed(4) : `${Math.round(metric.value)} ms`;
  const delta =
    metric.name === 'CLS' ? metric.delta.toFixed(4) : `${Math.round(metric.delta)} ms`;
  console.log(`[web-vitals] ${metric.name}: ${value} (${metric.rating}) delta=${delta}`, metric);
}

// 値が変わるたびに呼ばれるようにする(開発中の確認用)
onLCP(log, { reportAllChanges: true });
onCLS(log, { reportAllChanges: true });
onINP(log, { reportAllChanges: true });

同じページで同じ操作をした記録です(2回目の実行)。delta はページが出した1行の中に入っているので、ここでは | より後ろを省きました。

console
$ node cdp-run.mjs page-all interact
    0ms  ---- /page-all.html を開く
   72ms  console.log: [web-vitals] LCP: 60 ms (good) delta=60 ms
   73ms  console.log: [web-vitals] CLS: 0.0000 (good) delta=0.0000
  844ms  ---- load
  870ms  console.log: [web-vitals] LCP: 856 ms (good) delta=796 ms
 1035ms  console.log: [web-vitals] CLS: 0.0442 (good) delta=0.0442
 3849ms  ---- load から3秒待った visibilityState=visible
 3851ms  ---- 「保存」をクリック(1回目の操作)
 5071ms  console.log: [web-vitals] INP: 208 ms (needs-improvement) delta=208 ms
 5560ms  ---- 「保存」をクリック(2回目の操作)
 7266ms  ---- 別のタブを開いて前に出す
 8289ms  ----   (1秒後)visibilityState=hidden
 8290ms  ---- 別のタブを閉じて元のタブに戻る
 9307ms  ----   (1秒後)visibilityState=visible
 9309ms  ---- 「まとめて保存」をクリック(3回目の操作)
10720ms  console.log: [web-vitals] INP: 400 ms (needs-improvement) delta=192 ms
11214ms  ---- 別のタブを開いて前に出す
12246ms  ----   (1秒後)visibilityState=hidden
12246ms  ---- 終了

オプションなしのときとは、次の点が違いました。

  • LCP は、見出しの文字が表示された 60 ms と、画像が表示された 856 ms の2回出ました。記録用のスクリプトで見ると、1回目の LCP の要素は h1、2回目は img でした。
  • CLS は、ずれが起きる前に一度 0.0000 で出て、お知らせの帯が入った直後に 0.0442 で出ました。
  • INP は、クリックの後、タブを切り替えなくても出ました。
  • タブを切り替えたときには、何も出ませんでした。値はすでに出ていて、変わっていないからです。

1回目の実行では、INP が 208 ms の直前に、もう1回 INP: 8 ms (good) と出ていました。記録用のスクリプトで見ると、この値の元になった計測データは first-input だけでした。2回目の実行では出ていません。

時刻と操作を縦に並べ、オプションなしとreportAllChanges: trueのそれぞれで、どの値がいつ出たかを示した図。オプションなしでは、クリックでLCP 848 ms、別のタブへの切り替えでINP 208 msとCLS 0.0442、2回目の切り替えでINP 400 msが出る。reportAllChangesでは、開いた直後にLCP 60 msとCLS 0.0000、画像の表示でLCP 856 ms、帯が入ってCLS 0.0442、クリックでINP 208 ms、まとめて保存でINP 400 msが出る
コンソールに値が出たタイミング(オプションなしは1回目、reportAllChanges は2回目の実行。値は、出るきっかけになった操作の行に置いた)

README には、reportAllChanges を付けても付けなくても、最終的に出る値は同じだと書かれています。検証でも、最後に出た CLS(0.0442)と INP(400 ms)は、オプションの有無で同じでした。一方で、README では、reportAllChanges はデバッグには役立つが、本番の計測では通常は必要ない(勧めない)とされています。

ポイント

開発中に値の動きを見るなら、reportAllChanges: true を付けると、値が変わったときにタブを切り替えなくても出ます。値が変わらない操作では、付けても何も出ません。

​Posted by 86