Log — Como logar microserviços

Definindo um padrão e regras de logs da aplicação que possam ser validadas no code review.

Fala glr, blz… Eu novamente mais uma vez por aqui, depois de muito tempo hehehe, mas tamo de volta e vamos falar de Logs. Então bora lá que hoje vai ser rapidinho.

“Quanto melhor eu logo minha aplicação, mais ela me conta sobre ela.”

Essa frase acima é minha e eu realmente acredito nisso. Por isso, eu decidi escrever como eu padronizei os logs dos microserviços que escrevo e que me permitiu acompanhar e antecipar problemas usando por exemplo o cloudwatch(AWS).

“Toda ação deve ser monitorada em dois momentos.”

Assumindo essa premissa, eu estabeleci que todo método(ação) é logado no seu início e no final. Assim eu determinei o seguinte pattern:

Start-> Class.Method -> parameters {};

End -> Class.Method -> return {} / void-result;

Exception -> Class.Method -> ExceptionDetails {};

A escrita dos logs é um insumo para ferramentas de monitoramento, por tanto é importante entender o que deve ser logado, esses dados vão ser o seu norte quando você mais precisar.

A nível de Design de Código e eu me preocupo MUITO com isso, no artigo original de Uncle Bob sobre Design Pattern ele fala sobre viscosidade do projeto e aqui eu trago para código. Basicamente é quando fazer o “errado” é mais fácil que fazer o “certo”. Por isso é importante que logar a aplicação seja algo tão fluido e simples que não exista dúvida sobre como fazer. Afinal os logs como já disse são MUITO importantes, não espere precisar deles para começar a dar valor.

Existem muitas formas de logar sua aplicação, por isso eu enumerei as três principais diretrizes para escolher a forma de logar.

1 — Ser funcional.

A escolha da tecnologia e da forma de logar, deve atender o que se propõe com o log.

2 — Ser de fácil aplicação.

Logar sua aplicação não deve ser uma tarefa que requer complexidade. A viscosidade lá que eu já falei lembra ? rsrsrs

3 — Comprometer minimamente o design do código.

Essa é uma premissa básica que eu carrego comigo e que aplico para absolutamente tudo. Por que? Porquê escrevemos códigos para pessoas e não para máquinas. Quando mantemos o design do código, garantimos que outras pessoas consigam entender o que foi proposto ali e isso gera ganhos em manutenibilidade. Não se esqueça “Escrevemos o código uma vez, mas damos manutenção nele o resto de sua vida.”.

É isso, eu fico por aqui e até a px. Vlw, flw e tmj \m/