Instrument NestJS APIs.

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

npm install @apirelio/nestjs @apirelio/core

The global interceptor supports both NestJS HTTP platforms, preserves the original exception and records the final response outcome.

import { Module } from '@nestjs/common'
import { ApirelioModule } from '@apirelio/nestjs'

@Module({
  imports: [
    ApirelioModule.forRoot({
      apiKey: process.env.APIRELIO_API_KEY ?? '',
      service: 'billing-api',
      environment: 'production',
      includeRoutes: ['/api/**'],
      excludeRoutes: ['/api/health', '/api/internal/**'],
      resolveCustomer: request => request.user ? {
        id: String(request.user.companyId),
        name: request.user.companyName,
      } : null,
    }),
  ],
})
export class AppModule {}

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

ApirelioModule.forRootAsync({
  inject: [ConfigService],
  useFactory: (config: ConfigService) => ({
    apiKey: config.getOrThrow('APIRELIO_API_KEY'),
    service: 'billing-api',
  }),
})

Call app.enableShutdownHooks() so Nest lifecycle shutdown triggers the final queue flush.

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.