nestjs-runtime-metrics

Lightweight runtime metrics collector for NestJS applications. Collects CPU, memory, heap usage, and event loop metrics with optional reporting to a central endpoint.

Installation

npm install nestjs-runtime-metrics

Usage

import { RuntimeMetricsModule } from 'nestjs-runtime-metrics';

@Module({
  imports: [
    RuntimeMetricsModule.forRoot({
      interval: 30000,       // collect every 30s (default)
      prefix: 'my-app',     // metrics prefix
      verbose: true,         // log metrics to console
      endpoint: 'https://metrics.example.com/collect', // optional reporting endpoint
    }),
  ],
})
export class AppModule {}

Get Metrics Programmatically

import { RuntimeMetricsService } from 'nestjs-runtime-metrics';

@Injectable()
export class HealthController {
  constructor(private readonly metrics: RuntimeMetricsService) {}

  @Get('/health')
  getHealth() {
    return this.metrics.getMetrics();
  }
}

Collected Metrics

• hostname - Server hostname
• uptime - Application uptime in seconds
• osUptime - OS uptime in seconds
• cpuCount - Number of CPU cores
• loadAvg1m / loadAvg5m - CPU load averages
• memoryTotal / memoryFree / memoryUsed - System memory
• memoryUsagePercent - Memory usage percentage
• heapUsed / heapTotal - V8 heap memory
• rss - Resident Set Size
• pid - Process ID
• nodeVersion - Node.js version

License

MIT