TracesMetricsApp LogsCustom LogsProfiling
✅✖️✖️✅✅

​
Overview

This guide walks you through setting up Application Performance Monitoring (APM) on a Next.js application.

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

​
Prerequisites

  1. Middleware Agent (MW Agent) is installed
Although the Middleware Agent is not required for the Next.js APM, we recommend installing it for improved performance.
  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 version >= 1.3.0 and < 1.5.0:
Shell
npm install @opentelemetry/api”>=1.3.0 <1.5.0”

​
Install

​
Step 1: Install Next.js APM Package

Run the following command in your terminal:

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

​
Step 2: 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 3: Container Variables

If your application is not running in a container or Kubernetes cluster, move to Step 4

Add the following environment variable to your application deployment YAML file:

Shell
MW_AGENT_SERVICE=mw-service.mw-agent-ns.svc.cluster.local

For Docker containers, add the following environment variable to your application:

Shell
MW_AGENT_SERVICE=<DOCKER_BRIDGE_GATEWAY_ADDRESS>

Docker bridge gateway address is the IP address of the gateway between the Docker host and the bridge network, which is 172.17.0.1 by default. Refer more about Docker bridge networking here
For Kubernetes clusters, add the following environment variable to your application:

Shell
kubectl get service --all-namespaces | grep mw-service

​
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 depending on your current setup:

  • MW Agent Installed

  • MW Agent NOT Installed

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>"
        });
    }

​
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 your Project

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
Need assistance or want to learn more about Middleware? Contact us at support[at]middleware.io.

Was this page helpful?

.NETNode.js