AgentMonitor NodeSDK

Node.js integration for server-side traffic data ingestion.

Installation

npm install @agentmonitor/sdk

Usage

First, initialize the AgentMonitor client with your access token. It's best to create a single instance and reuse it throughout your application.

import { AgentMonitor } from "@agentmonitor/sdk"

const agentMonitor = new AgentMonitor("access-token")

[!CAUTION] Always use environment variables to store your access token. Avoid hardcoding secrets in your source code.

You can then use this client to track any Node.js request object. The following example shows a basic integration using Node's built-in HTTP server.

import http from 'http';
import { AgentMonitor } from "@agentmonitor/sdk";

const agentMonitor = new AgentMonitor("access-token")

const server = http.createServer((req, res) => {
    agentMonitor.track(req);
    
    res.writeHead(200, { 'Content-Type': 'application/json' });
    res.end(JSON.stringify({ message: 'ok' }));
});

server.listen(3000);

That's it! We handle all the complex traffic analysis and attribution on our end.

For easier integration, see the framework-specific examples below.

Sails.js

The easiest way to integrate with Sails.js is to define a middleware function directly in config/http.js.

// config/http.js

module.exports.http = { 
    middleware: {
        order: [
            'cookieParser',
            'session',
            'bodyParser',
            'compress',
            'poweredBy',
            'agentMonitor', // Add your middleware to the order
            'router',
            'www',
            'favicon',
        ],
      
        // Define the middleware directly
        agentMonitor: (function() {
            const { AgentMonitor } = require('@agentmonitor/sdk');
            const agentMonitor = new AgentMonitor('access-token')

            return function (req, res, next) {
                agentMonitor.track(req);
                return next();
            }
        })(),
    }
}

Next.js

The recommended way to integrate with Next.js is by using Middleware (middleware.ts). Because Next.js Middleware uses a NextRequest object instead of a raw Node.js request, you need to manually build the payload from the request properties.

// middleware.ts

import { NextResponse, NextRequest } from 'next/server'
import { AgentMonitor } from '@agentmonitor/sdk';

const agentMonitor = new AgentMonitor('access-token')

export function middleware (request: NextRequest) {
    // ...
	
    agentMonitor.track({
        path: request.nextUrl.pathname,
        query: request.nextUrl.search,
        method: request.method,
        headers: Object.fromEntries(request.headers),
    });
	 
    // ...
	
    return NextResponse.next();
}

Express

The easiest way to integrate with Express is to use a middleware function. This will automatically capture every incoming request.

app.use((req, res, next) => {
    agentMonitor.track(req)
    next()
})

Fastify

For Fastify, you can use the onRequest hook to capture all incoming traffic.

server.addHook('onRequest', async (request, reply) => {
    agentMonitor.track(request.raw);
});

Support

Reach out to us via email at [email protected]. We'll do our best to assist you as soon as possible.