TracesMetricsApp LogsCustom LogsProfiling
✅✖️✖️✅✅

​
Overview

This guide walks you through setting up the Vercel APM integration.

These instructions can also be found on the Installation page in your Middleware Account. View demo code here.

Refer to our sample Vercel project to see the Middleware - Vercel Integration in action.

​
Prerequisites

  1. Next.js version 13.4 or newer installed. Check your Next.js version with the following command:
Shell
npx next --version
  1. @opentelemetry/api package installed. If not, run the following command:
Shell
npm install @opentelemetry/api”>=1.3.0 <1.5.0”
You can read detailed prerequisites and essential information about OpenTelemetry in Vercel’s documentation. This information will be helpful when integrating Middleware with Vercel.

​
Install

​
Step 1: Add Middleware Integration

  1. Add the Middleware integration from the Vercel marketplace:

  1. Select a Vercel Account to add the Integration to:

  1. Select the Project you want to track:

  1. Allow Permissions and Add Integration:
You must accept the below permissions in order to proceed with the rest of the integration

  1. Login to your Middleware Account:

  1. The below screen indicates you have successfully integrated Vercel and Middleware:

After three seconds you should be redirected back to the Vercel marketplace
  1. Enable traces in Vercel prior to deploying your project

​
Step 2: Install Next.js APM Package

Run the following command in your terminal:

Shell
npm install @middleware.io/agent-apm-nextjs

​
Step 3: Modify Config File

Add the following code to your next.config.js file:

Next.js
const nextConfig = {
    // ...
    // Your existing config

     experimental: {
         instrumentationHook: true
     }

    // ...
    // Your existing config
}
module.exports = nextConfig

​
Step 4: Create Instrumentation File

  1. Create a custom instrumentation.ts (or .js) file in your project root directory or inside the src folder
The instrumentation.ts file must be located at the root of your project unless you are using the src directory. If you are using the src directory, ensure the instrumentation.ts file is placed within the src directory, alongside the pages and app directories.
  1. Synchronize your instrumentation filename if you are using the pagesExtension config option to add suffixes
Example: If you use pagesExtension: [‘ts’], the instrumentation file should be named instrumentation.ts
  1. Add the below code snippet. The access token is your account key, which can be found on the Installation page:
Next.js
// @ts-ignore
import tracker from '@middleware.io/agent-apm-nextjs';

export function register() {
    tracker.track({
        projectName: "<PROJECT-NAME>",
        serviceName: "<SERVICE-NAME>",
        accessToken: "<xxxxxxxxxx>",
        target: "vercel"
    });
}
  1. Integrate your APIs or Serverless functions prior to deployment. Vercel will treat your app as a static website during deployment if you have not integrated any APIs or Serverless functions and the instrumentation.ts file will not be invoked, resulting in the absence of traces or logs in your Middleware account.

​
Step 5: Enable Logging

Ingest custom logs by using the following functions based on desired log severity levels:

Next.js
// @ts-ignore
import tracker from '@middleware.io/agent-apm-nextjs';

export default async function handler(req, res) {
    // ...
    // Your existing code

    tracker.info("Info Sample");
    tracker.warn("Warn Sample", {
        "tester": "Alex",
    });
    tracker.debug("Debug Sample");
    tracker.error("Error Sample");

    // ...
    // Your existing code
}

​
Step 6: Deploy on Vercel

If you’re looking to set up a sample Next.js project with API routes, you can use the following command in your terminal: npx create-next-app@latest --example api-routes

​
Troubleshooting

If you do not see any data appear on the Middleware dashboard, redeploy your project on Vercel. This should ensure that the traces and profiling data are properly generated and collected by Middleware.