Getting started with Vercel Speed Insights

This guide will help you get started with using Vercel Speed Insights on your project, showing you how to enable it, add the package to your project, deploy your app to Vercel, and view your data in the dashboard.

Select your framework to view instructions on using the Vercel Speed Insights in your project.

Prerequisites

A Vercel account. If you don’t have one, you can sign up for free.
A Vercel project. If you don’t have one, you can create a new project.
The Vercel CLI installed. If you don’t have it, you can install it using the following command:

# pnpm
pnpm i vercel

# yarn
yarn i vercel

# npm
npm i vercel

# bun
bun i vercel

Enable Speed Insights in Vercel

On the Vercel dashboard, select your Project followed by the Speed Insights tab. You can also select the button below to be taken there. Then, select Enable from the dialog.

💡 Note: Enabling Speed Insights will add new routes (scoped at /_vercel/speed-insights/*) after your next deployment.

Framework-specific instructions

Add `@vercel/speed-insights` to your project

For most frameworks (Next.js, SvelteKit, Remix, Create React App, Nuxt, Vue, Astro, and other frameworks), using the package manager of your choice, add the @vercel/speed-insights package to your project:

# pnpm
pnpm i @vercel/speed-insights

# yarn
yarn i @vercel/speed-insights

# npm
npm i @vercel/speed-insights

# bun
bun i @vercel/speed-insights

💡 Note: When using the HTML implementation, there is no need to install the @vercel/speed-insights package.

Supported frameworks

Vercel Speed Insights supports the following frameworks:

Next.js (both pages and app directories)
SvelteKit
Remix
Create React App
Nuxt
Vue
Astro
Plain HTML
Other frameworks

Next.js

Pages Directory

The SpeedInsights component is a wrapper around the tracking script, offering more seamless integration with Next.js.

If you are using the pages directory, add the following code to your main app file:

import type { AppProps } from 'next/app';
import { SpeedInsights } from '@vercel/speed-insights/next';

function MyApp({ Component, pageProps }: AppProps) {
  return (
    <>
      <Component {...pageProps} />
      <SpeedInsights />
    </>
  );
}

export default MyApp;

For versions of Next.js older than 13.5, import the <SpeedInsights> component from @vercel/speed-insights/react. Then pass it the pathname of the route, as shown below:

import { SpeedInsights } from "@vercel/speed-insights/react";
import { useRouter } from "next/router";

export default function Layout() {
  const router = useRouter();

  return <SpeedInsights route={router.pathname} />;
}

App Directory

The SpeedInsights component is a wrapper around the tracking script, offering more seamless integration with Next.js.

Add the following component to the root layout:

import { SpeedInsights } from "@vercel/speed-insights/next";

export default function RootLayout({
  children,
}: {
  children: React.ReactNode;
}) {
  return (
    <html lang="en">
      <head>
        <title>Next.js</title>
      </head>
      <body>
        {children}
        <SpeedInsights />
      </body>
    </html>
  );
}

For versions of Next.js older than 13.5, import the <SpeedInsights> component from @vercel/speed-insights/react.

Create a dedicated component to avoid opting out from SSR on the layout and pass the pathname of the route to the SpeedInsights component:

"use client";

import { SpeedInsights } from "@vercel/speed-insights/react";
import { usePathname } from "next/navigation";

export function Insights() {
  const pathname = usePathname();

  return <SpeedInsights route={pathname} />;
}

Then, import the Insights component in your layout:

import type { ReactNode } from "react";
import { Insights } from "./insights";

export default function RootLayout({ children }: { children: ReactNode }) {
  return (
    <html lang="en">
      <head>
        <title>Next.js</title>
      </head>
      <body>
        {children}
        <Insights />
      </body>
    </html>
  );
}

Remix

The SpeedInsights component is a wrapper around the tracking script, offering a seamless integration with Remix.

Add the following component to your root file:

import { SpeedInsights } from '@vercel/speed-insights/remix';

export default function App() {
  return (
    <html lang="en">
      <body>
        {/* ... */}
        <SpeedInsights />
      </body>
    </html>
  );
}

SvelteKit

Add the following component to your root file:

import { injectSpeedInsights } from "@vercel/speed-insights/sveltekit";

injectSpeedInsights();

Astro

Speed Insights is available for both static and SSR Astro apps.

To enable this feature, declare the <SpeedInsights /> component from @vercel/speed-insights/astro near the bottom of one of your layout components, such as BaseHead.astro:

---
import SpeedInsights from '@vercel/speed-insights/astro';
const { title, description } = Astro.props;
---
<title>{title}</title>
<meta name="title" content={title} />
<meta name="description" content={description} />

<SpeedInsights />

Optionally, you can remove sensitive information from the URL by adding a speedInsightsBeforeSend function to the global window object. The <SpeedInsights /> component will call this method before sending any data to Vercel:

---
import SpeedInsights from '@vercel/speed-insights/astro';
const { title, description } = Astro.props;
---
<title>{title}</title>
<meta name="title" content={title} />
<meta name="description" content={description} />

<script is:inline>
  function speedInsightsBeforeSend(data){
    console.log("Speed Insights before send", data)
    return data;
  }
</script>
<SpeedInsights />

Learn more about beforeSend.

Plain HTML

For plain HTML sites, add the following scripts before the closing tag of the <body>:

<script>
  window.si = window.si || function () { (window.siq = window.siq || []).push(arguments); };
</script>
<script defer src="/_vercel/speed-insights/script.js"></script>

Note: When using the HTML implementation, there is no need to install the @vercel/speed-insights package.

Vue

The SpeedInsights component is a wrapper around the tracking script, offering more seamless integration with Vue.

Add the following component to the main app template.

<script setup lang="ts">
import { SpeedInsights } from '@vercel/speed-insights/vue';
</script>

<template>
  <SpeedInsights />
</template>

Nuxt

The SpeedInsights component is a wrapper around the tracking script, offering more seamless integration with Nuxt.

Add the following component to the default layout.

<script setup lang="ts">
import { SpeedInsights } from '@vercel/speed-insights/vue';
</script>

<template>
  <SpeedInsights />
</template>

Create React App

The SpeedInsights component is a wrapper around the tracking script, offering more seamless integration with React.

Add the following component to the main app file.

import { SpeedInsights } from '@vercel/speed-insights/react';

export default function App() {
  return (
    <div>
      {/* ... */}
      <SpeedInsights />
    </div>
  );
}

Other frameworks

Import the injectSpeedInsights function from the package, which will add the tracking script to your app. This should only be called once in your app, and must run in the client.

Add the following code to your main app file:

import { injectSpeedInsights } from "@vercel/speed-insights";

injectSpeedInsights();

Deploy your app to Vercel

You can deploy your app to Vercel’s global CDN by running the following command from your terminal:

vercel deploy

Alternatively, you can connect your project’s git repository, which will enable Vercel to deploy your latest pushes and merges to main.

Once your app is deployed, it’s ready to begin tracking performance metrics.

💡 Note: If everything is set up correctly, you should be able to find the /_vercel/speed-insights/script.js script inside the body tag of your page.

View your data in the dashboard

Once your app is deployed, and users have visited your site, you can view the data in the dashboard.

To do so, go to your dashboard, select your project, and click the Speed Insights tab.

After a few days of visitors, you’ll be able to start exploring your metrics. For more information on how to use Speed Insights, see Using Speed Insights.

Learn more about how Vercel supports privacy and data compliance standards with Vercel Speed Insights.

Next steps

Now that you have Vercel Speed Insights set up, you can explore the following topics to learn more:

CHENG, Wan Kiu Winkey