logify-nest

Logger contextual para NestJS com suporte a correlation_id, user_id, access_token e integração com Pino.

Instalação

npm install logify-nest

Configuração Básica

import { LogifyNestJsModule } from 'logify-nest';

@Module({
  imports: [
    LogifyNestJsModule.forRoot({
      serviceName: 'meu-servico',
      // ignoredPaths: ['/health', '/metrics'], // opcional
    }),
  ],
})
export class AppModule {}

O módulo já registra o Interceptor global e o Middleware para contexto.

Principais Features

• Correlation ID automático (propagado entre serviços)
• User ID extraído do header ou JWT (access_token)
• Interceptor global para logs de request/response
• Middleware para propagação de contexto
• Propagação automática de headers (X-Correlation-Id, X-User-Id)
• Compatível com Pino
• Stack trace detalhado em erros

Uso dos Métodos de Log

// Injetando o serviço
constructor(private readonly logify: LogifyNestJsService) {}

// Log de negócio
this.logify.log('Mensagem informativa', { extraKey: 'valor' });

// Log de erro com stack trace
try {
  // ...
} catch (error) {
  this.logify.error('Erro ao processar', error);
  // ou
  this.logify.error('Erro ao processar', { stack_trace: error.stack, err: error });
}

// Log de warning/debug
this.logify.warn('Atenção!');
this.logify.debug('Debugando...', { contexto: 'detalhe' });

Propagação de Headers

Para propagar o contexto entre micro-serviços (ex: HTTP, filas, workers):

const headers = this.logify.getPropagationHeaders();
// headers: { 'X-Correlation-Id': '...', 'X-User-Id': '...' }

Propagação Manual de Contexto (ex: Worker, Fila)

Quando processar uma mensagem recebida (ex: RabbitMQ), injete o contexto antes de logar:

const correlationId = amqpMsg?.properties?.headers?.['x-correlation-id'];
const userId = amqpMsg?.properties?.headers?.['x-user-id'];
this.logify.setLoggingContext({ corr_id: correlationId, user_id: userId });
// Agora todos os logs usam esse contexto
this.logify.log('Processando mensagem...');

Se o user_id não for passado, será extraído automaticamente do access_token (se presente).

Como funciona a extração de contexto

• O correlation_id é extraído dos headers (X-Correlation-Id) ou gerado automaticamente.
• O user_id é extraído dos headers (X-User-Id) ou decodificado do JWT (access_token).
• O access_token pode ser passado nos headers ou diretamente.

Stack Trace em Erros

Ao logar erros, o campo stack_trace é preenchido automaticamente se você passar o objeto Error ou o stack:

this.logify.error('Erro fatal', error); // stack e err extraídos
// ou
this.logify.error('Erro fatal', { stack_trace: error.stack, err: error });

Integração automática

O Interceptor e Middleware já garantem contexto e logs de request/response:

• Logs de início e fim de request
• Propagação automática de correlation_id e user_id
• Ignora paths de healthcheck por padrão

Exemplo Completo

import { Controller, Get } from '@nestjs/common';
import { LogifyNestJsService } from 'logify-nest';

@Controller()
export class AppController {
  constructor(private readonly logify: LogifyNestJsService) {}

  @Get('hello')
  getHello() {
    this.logify.log('Recebi um pedido no /hello', { rota: '/hello' });
    return { message: 'Hello World!' };
  }

  @Get('error')
  getError() {
    try {
      throw new Error('Falha simulada');
    } catch (error) {
      this.logify.error('Erro na rota /error', error);
    }
    return { message: 'Erro tratado!' };
  }
}

Licença

MIT