Winston NodeJS Logger

O que são logs de uma aplicação?

Basicamente são registros detalhados e estruturados dos eventos ocorridos em sua execução. Eles incluem informações sobre erros, operações bem-sucedidas, mensagens de depuração, dados de entrada e saída, e etc. Além disso os logs são uma ferramenta valiosa para os desenvolvedores na solução de problemas, na identificação de padrões de uso e no monitoramento do desempenho da aplicação. Eles também são úteis para a equipe de suporte, que pode usar os logs para investigar problemas relatados pelos usuários.

A importância de uma biblioteca de Logs para sua aplicação

1. Debugging: A biblioteca de log permite que você registre informações sobre o comportamento do seu aplicativo, o que pode ser útil ao depurar problemas. É possível adicionar informações específicas aos logs para ajudar a identificar rapidamente o problema.
2. Monitoramento em tempo real: Os logs podem fornecer informações sobre o estado atual do seu aplicativo e sobre como ele está sendo utilizado. Isso é útil para monitorar a saúde do aplicativo e tomar medidas preventivas antes que os problemas se tornem graves.
3. Análise de dados: Os logs podem ser usados para coletar dados sobre o uso do aplicativo e para entender como os usuários interagem com ele. Isso pode ser valioso para aprimorar o design do aplicativo e melhorar a experiência do usuário.
4. Auditoria: As informações registradas nos logs podem ser usadas para auditar o aplicativo e garantir que ele esteja cumprindo os requisitos de segurança e conformidade.
5. Resolução de problemas: Em caso de problemas no sistema, a biblioteca de log pode fornecer informações valiosas para ajudar a identificar a causa raiz e solucionar o problema rapidamente.

Biblioteca Winston NodeJS Logger

Diante do que é log, é aí que entra a famosa biblioteca Winston! sendo ela um dos NodeJS Logger mais populares. Ela fornece uma solução completa e personalizável para registrar mensagens de log em aplicativos Node.js. A biblioteca suporta vários formatos de saída de log, como console, arquivo, stream e muito mais. Além disso, permite configurar diferentes níveis de log (como erro, alerta, informação, etc.), bem como adicionar informações adicionais aos logs, como hora, data e metadados. Isso permite que os desenvolvedores rastreiem e solucionem facilmente problemas em seus aplicativos, além de fornecer informações valiosas para auditorias e análises de log.

Além disso a biblioteca Winston NodeJS Logger oferece várias vantagens, incluindo:

1. Flexibilidade: Winston permite que você configure diferentes níveis de log, formatos de saída e opções de transporte, o que significa que você pode adaptar sua solução de log para atender às suas necessidades específicas.
2. Personalização: Winston permite que você adicione informações adicionais aos logs, como hora, data, metadados e informações de contexto. Isso permite que você obtenha uma visão mais completa do que está acontecendo em seu aplicativo.
3. Suporte a múltiplos formatos de saída: Winston permite que você escreva logs em múltiplos formatos, incluindo console, arquivo, stream e outros. Isso significa que você pode escolher o formato que melhor atenda às suas necessidades.
4. Performance: Winston é uma biblioteca leve e otimizada para desempenho, o que significa que não afetará significativamente o desempenho de seu aplicativo.
5. Comunidade ativa: Winston é uma biblioteca amplamente utilizada e tem uma comunidade ativa de desenvolvedores e contribuidores que a mantêm atualizada e corrigem erros rapidamente.
6. Documentação completa: Winston tem uma documentação completa e clara que fornece informações sobre como configurar e usar a biblioteca de maneira eficiente.

Tipos de  Logs que a biblioteca Winston possui

Logs de erro: Esses logs registram informações sobre erros e exceções que ocorrem em seu aplicativo. Eles são geralmente registrados com um nível de gravidade elevado, como “erro” ou “critico”, para indicar que algo deu errado e precisa ser corrigido rapidamente.

import { createLogger, transports, format } from "winston";

const logger = createLogger({
  transports: [
    new transports.Console({
      level: "error",
      format: format.combine(
        format.colorize(),
        format.simple()
      )
    }),
    new transports.File({ filename: "error.log", level: "error" })
  ]
});

logger.error("An error occurred", { error: new Error("Error message") });

Logs de aviso: Esses logs registram informações sobre condições que não são erros, mas que precisam ser monitoradas de perto, como ações de usuários inesperadas ou erros em tempo de execução. Eles são geralmente registrados com um nível de gravidade moderado, como “aviso” ou “alerta”.

import { createLogger, transports, format } from "winston";

const logger = createLogger({
  transports: [
    new transports.Console({
      level: "warn",
      format: format.combine(
        format.colorize(),
        format.simple()
      )
    }),
    new transports.File({ filename: "warn.log", level: "warn" })
  ]
});

logger.warn("A warning was triggered", { warning: "Warning message" });

Logs de informação: Esses logs registram informações gerais sobre o funcionamento do seu aplicativo, como a hora de início do aplicativo, informações de configuração e ações do usuário. Eles são geralmente registrados com um nível de gravidade baixo, como “informação” ou “debug”.

import { createLogger, transports, format } from "winston";

const logger = createLogger({
  transports: [
    new transports.Console({
      level: "info",
      format: format.combine(
        format.colorize(),
        format.simple()
      )
    }),
    new transports.File({ filename: "info.log", level: "info" })
  ]
});

logger.info("An informational message", { info: "Informational message" });

Logs de depuração: Esses logs registram informações detalhadas sobre o funcionamento interno do seu aplicativo, incluindo variáveis, estruturas de dados e processos de execução. Eles são geralmente registrados com um nível de gravidade muito baixo, como “depuração” ou “silly”.

import { createLogger, transports, format } from "winston";

const logger = createLogger({
  transports: [
    new transports.Console({
      level: "debug",
      format: format.combine(
        format.colorize(),
        format.simple()
      )
    }),
    new transports.File({ filename: "debug.log", level: "debug" })
  ]
});

logger.debug("A debug message", { debug: "Debug message" });

Os níveis de Logs disponibilizados pelo Winston

Os níveis de log fornecem uma forma de categorizar os logs baseados na sua importância ou severidade. A biblioteca Winston NodeJS Logger, assim como outras bibliotecas de log, suporta os seguintes níveis de log padrão:

1. error: representa um erro grave que precisa ser corrigido imediatamente.
2. warn: representa uma situação que precisa ser monitorada, mas não é necessariamente um erro.
3. info: representa uma mensagem informativa geral sobre o estado da aplicação.
4. debug: representa uma mensagem de depuração para ajudar a identificar problemas.
5. silly: representa uma mensagem de log de baixa importância.

Quando você configura sua biblioteca de log, pode especificar o nível de log mínimo que deseja registrar. Por exemplo, se você especificar o nível de log como “warn”, apenas os logs com níveis “warn”, “error” e “debug” serão registrados. Isso permite que você filtre e concentre-se nos logs mais importantes sem ser inundado com informações desnecessárias.

Exemplo simples do uso do Winston

import { createLogger, format, transports } from "winston";

const logger = createLogger({
  level: "info",
  format: format.combine(
    format.timestamp({
      format: "YYYY-MM-DD HH:mm:ss"
    }),
    format.errors({ stack: true }),
    format.splat(),
    format.json()
  ),
  defaultMeta: { service: "your-service-name" },
  transports: [
    new transports.File({
      filename: "error.log",
      level: "error"
    }),
    new transports.File({
      filename: "combined.log"
    })
  ]
});

if (process.env.NODE_ENV !== "production") {
  logger.add(
    new transports.Console({
      format: format.combine(
        format.colorize(),
        format.simple()
      )
    })
  );
}

export default logger;

Nesse exemplo, estamos criando um objeto logger usando o método createLogger da biblioteca Winston. Em seguida, estamos configurando o formato dos logs para serem registrados no formato JSON com uma data/hora de timestamp e informações sobre os erros (se houver). Além disso, estamos especificando o nome do serviço como metadados padrão para cada log.

Em seguida, estamos configurando dois transportes: um para registrar apenas logs de erro em um arquivo separado e outro para registrar todos os logs em outro arquivo. Se a variável de ambiente NODE_ENV não for igual a “production”, estamos adicionando um transporte adicional para a console que exibe logs coloridos e simplificados.

Por fim, estamos exportando o objeto logger como o objeto padrão da nossa biblioteca de log. Você pode importar esse objeto em outros módulos da sua aplicação e usá-lo para registrar logs.

No contexto da biblioteca Winston, format, transports e defaultMeta são propriedades de configuração que permitem personalizar o comportamento dos logs na sua aplicação. Aqui está uma explicação detalhada de cada propriedade:

1. format: a propriedade format permite especificar o formato dos logs que serão registrados. Você pode usar formatadores pré-definidos fornecidos pela biblioteca Winston ou criar seus próprios formatadores personalizados. Por exemplo, você pode usar o formato JSON para registrar logs em um formato estruturado que pode ser facilmente analisado por outras ferramentas.
2. transports: a propriedade transports permite especificar os meios pelos quais os logs serão armazenados ou exibidos. Winston fornece vários transportes pré-definidos, como arquivos, console, e-mail, etc. Você pode usar mais de um transporte para registrar logs em diferentes locais ou com diferentes níveis de detalhamento.
3. defaultMeta: a propriedade defaultMeta permite fornecer metadados adicionais que serão incluídos com cada log registrado. Por exemplo, você pode incluir informações sobre a aplicação, o usuário atual ou outros dados relevantes. Os metadados fornecidos na propriedade defaultMeta serão incluídos com cada log registrado, a menos que sejam substituídos por metadados específicos de log.

Principais concorrentes da biblioteca Winston

Acaso ainda esteja em dúvida se deve usar o Winston ou não, pesquise mais sobre seus  concorrentes, com certeza algum pode se encaixar com o seu projeto:

1. Morgan: uma biblioteca de log simples e popular para aplicações Node.js.
2. Bunyan: uma biblioteca de log poderosa com recursos avançados, como suporte a vários transportes e filtragem baseada em níveis de log.
3. Pino: uma biblioteca de log rápida e eficiente que prioriza a performance sobre as funcionalidades avançadas.
4. Log4js: uma biblioteca de log altamente configurável com suporte a vários transportes e formatos de log.
5. Debug: uma biblioteca de log simples e fácil de usar para aplicações Node.js.

Cada uma dessas bibliotecas tem suas próprias vantagens e desvantagens, e a escolha da biblioteca ideal para seu projeto dependerá das suas necessidades específicas em termos de funcionalidades, performance e facilidade de uso. É importante avaliar cuidadosamente as opções antes de tomar uma decisão.