Instrument Express APIs.

The framework adapter uses @apirelio/core for the common event contract and bounded asynchronous transport.

npm install @apirelio/express @apirelio/core

The middleware records the final status and resolved route template on the response finish event. Register it after authentication and before observed routes.

import express from 'express'
import { apirelio } from '@apirelio/express'

const app = express()
const analytics = apirelio({
  apiKey: process.env.APIRELIO_API_KEY ?? '',
  service: 'billing-api',
  environment: 'production',
  includeRoutes: ['/api/**'],
  excludeRoutes: ['/api/health', '/api/internal/**'],
  release: process.env.APP_RELEASE,
  resolveCustomer: request => request.user ? {
    id: String(request.user.companyId),
    name: request.user.companyName,
    plan: request.user.companyPlan,
  } : null,
})

app.use(analytics)

Use stable external IDs from your authentication model. Customer names and plans can evolve without breaking analytics history.

resolveCustomer: request => ({
  id: String(request.user.companyId),
  name: request.user.companyName,
  plan: request.user.companyPlan,
})

Call await analytics.shutdown() from the application graceful-shutdown path.

includeRoutes accepts exact paths or prefixes ending in /**. Explicit excludeRoutes always take precedence, keeping health checks, internal endpoints and presentation routes out of API analytics.

Request and response bodies, authorization values, cookies, query values, email addresses and client IP addresses are not captured. Custom scalar metadata must be explicitly allow-listed.