Skip to main content

Quick Start

Get NestLens running in 3 simple steps.

Step 1: Import the Module​

app.module.ts
import { Module } from '@nestjs/common';
import { NestLensModule } from 'nestlens';

@Module({
  imports: [
    NestLensModule.forRoot({
      enabled: process.env.NODE_ENV !== 'production',
    }),
  ],
})
export class AppModule {}

Step 2: (Optional) Use NestLens Logger​

To capture all application logs, use the NestLensLogger:

main.ts
import { NestFactory } from '@nestjs/core';
import { NestLensLogger } from 'nestlens';
import { AppModule } from './app.module';

async function bootstrap() {
  const app = await NestFactory.create(AppModule, {
    bufferLogs: true,
  });

  const logger = app.get(NestLensLogger);
  app.useLogger(logger);

  await app.listen(3000);
}
bootstrap();

Step 3: Access the Dashboard​

Start your NestJS application and open:

http://localhost:3000/nestlens

You should see the NestLens dashboard!

To mount it somewhere else, set path — the dashboard and its API move together:

NestLensModule.forRoot({ path: '/admin/monitoring' });
// Dashboard at http://localhost:3000/admin/monitoring

Getting a 403 instead?​

{ "message": "NestLens is not available in this environment", "statusCode": 403 }

NestLens only serves the dashboard in development, local and test by default, regardless of enabled. If your NODE_ENV is anything else — dev, staging, production — add it explicitly:

NestLensModule.forRoot({
  authorization: {
    allowedEnvironments: ['development', 'local', 'test', 'dev'],
  },
});

See Authorization for IP whitelisting and role-based access.

What's Tracked by Default​

With zero configuration, NestLens tracks:

  • All HTTP requests and responses
  • Database queries (TypeORM/Prisma auto-detected)
  • Unhandled exceptions
  • Application logs (once you wire NestLensLogger via app.useLogger() — see Step 2)

Next Steps​