@angelitosystems/nest-devtools

Debugging y observabilidad en tiempo real para aplicaciones NestJS.

Anade instrumentacion para peticiones HTTP, logs, errores, rendimiento, grafo de la aplicacion y, de forma opcional, WebSockets y base de datos. El SDK no debe detener ni romper la aplicacion si el servidor DevTools no esta disponible.

Requisitos

• Node.js 18 o superior, o Bun 1.1 o superior.
• NestJS 9, 10, 11 o 12.
• reflect-metadata y rxjs, normalmente ya presentes en una aplicacion NestJS.

Instalacion

npm install @angelitosystems/nest-devtools

bun add @angelitosystems/nest-devtools

El servidor WebSocket y el dashboard se inician automaticamente dentro del proceso de NestJS.

Uso

Anade una linea despues de crear la aplicacion y antes de listen():

import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
import { NestDevTools } from '@angelitosystems/nest-devtools';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  NestDevTools.init(app);
  await app.listen(3000);
}

bootstrap();

Abre http://localhost:4317 despues de arrancar tu aplicacion. No necesitas ejecutar nest-devtools start en otra terminal.

Configuracion

NestDevTools.init(app, {
  project: 'catalog-api',
  environment: 'development',
  server: 'ws://localhost:4318',
  capture: {
    requests: true,
    logs: true,
    errors: true,
    performance: true,
    database: true,
    websockets: true,
  },
  redact: ['customerSecret'],
  allow: ['publicToken'],
});

Para conectar con un servidor DevTools que ya se esta ejecutando, desactiva el modo embebido con embedded: false.

Opciones y variables de entorno principales:

| Opcion | Variable | Valor predeterminado | |---|---|---| | enabled | NEST_DEVTOOLS_ENABLED | Activo fuera de production | | server | NEST_DEVTOOLS_URL | ws://localhost:4318 | | project | NEST_DEVTOOLS_PROJECT | Nombre del proyecto | | token | NEST_DEVTOOLS_TOKEN | Sin token | | sampling | NEST_DEVTOOLS_SAMPLING | 1 |

En produccion el SDK se desactiva por defecto. Activalo explicitamente solo si necesitas capturar datos alli y has revisado la configuracion de redaccion.

API adicional

import {
  NestDevTools,
  captureError,
  requestContext,
} from '@angelitosystems/nest-devtools';

captureError(new Error('Database unavailable'));
const requestId = requestContext().requestId();

NestDevTools.init() devuelve un InitResult con enabled, projectId, projectName, server y, cuando corresponde, la razon de una desactivacion.

Desarrollo

bun run --cwd packages/nestjs build
bun test packages/nestjs

Licencia

MIT. Consulta la guia completa en docs/quick-start.md y docs/configuration.md.