Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat/mmrfc5 log standard events #8

Open
wants to merge 15 commits into
base: production
Choose a base branch
from

Conversation

rorteg
Copy link

@rorteg rorteg commented Sep 3, 2024

Tipo de Mudança

  • Bugfix (correções de código que NÃO MUDAM regras de negócio).
  • Nova Feature (adições ao código que NÃO MUDAM regras de negócio).
  • Melhoria de código (mudanças de código que NÃO MUDAM regras de negócio).
  • Correções ou novas features que MUDAM regras de negócio.

Mudança Proposta/Descrição

Este PR introduz suporte para eventos de log padrão conforme a MMRFC 5, incluindo a implementação de um LogStandardEventFormatterDecorator que valida e formata logs de acordo com os eventos standard definidos. Adicionalmente, novos tipos e enums foram adicionados para garantir a conformidade e facilitar a integração.

Comportamento atual

Atualmente, a biblioteca de logs não possui suporte padronizado para eventos de log conforme a MMRFC 5. Os desenvolvedores precisam definir manualmente os campos e os níveis de log, o que pode levar a inconsistências e dificuldades de manutenção.

Novo comportamento

Este PR introduz as seguintes mudanças:

  • Adiciona o LogStandardEventFormatterDecorator, que automaticamente valida e formata logs conforme os eventos standard da MMRFC 5.
  • Introduz o enum LogStandardGlobalEventNameEnum para definir eventos de log padrão, facilitando a utilização correta.
  • Adiciona tipos específicos para campos obrigatórios de cada evento, garantindo que todos os campos necessários sejam fornecidos.
  • Implementa mensagens de recomendação e notas no contexto do log quando os campos obrigatórios estão ausentes ou quando o nível de log utilizado não é o recomendado.
  • Atualiza o src/index.ts para exportar os novos componentes e funcionalidades, permitindo que sejam utilizados externamente.

Esta é uma Breaking Change? (Sim/Não):

Não. Este PR adiciona novas funcionalidades de maneira não disruptiva, mantendo a compatibilidade com implementações existentes.

Informação Adicional

Nenhuma dependência adicional foi introduzida. A documentação e os exemplos foram atualizados para refletir as novas funcionalidades. Esta mudança melhora a padronização e a clareza dos logs gerados, facilitando a manutenção e a análise de eventos críticos.

Mudanças Propostas

Descreva suas mudanças de maneira breve e objetiva:

  • Implementação do LogStandardEventFormatterDecorator para suporte a eventos standard.
  • Adição de tipos e enums para validação e definição de eventos standard.
  • Atualização de exemplos e documentação para refletir o novo suporte a eventos standard.

Checklist

  • Você escreveu testes para suas mudanças?
  • Você executou testes bem sucedidos com suas alterações localmente?
  • Você rodou o lint em seu código localmente antes do envio?
  • Você atualizou a documentação do componente com as alterações?

Copy link
Contributor

@lucasvillatore lucasvillatore left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

boa!!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants