Estrutura para log

[pabrrs]

Problema

A implementação do boilerplate contém um wrapper da lib PinoJS criado em
src/client/logger-client.js, que já possúi toda configuração básica para se utilizar os métodos padrões de um logger (info, warn, error, etc).

Dessa forma, precisamos definir um padrão dos logs gerados pela API, descrever como será o JSON enviado ao terminal e quais campos devem estar presentes, para que seja possível indexar em um agregador e gerar estatísticas dessas informações.

Além disso, precisamos debater se iremos utilizar alguma plataforma (kibana, serviço em cloud, etc) para armazenar os logs, mantendo seu histórico ou apenas joga-los no terminal. Acredito que o @deniojunior poderá nos ajudar.

Sugestão

Acredito que possamos utilizar a seguinte chamada no código:

logger.method({
    action: 'service.method', // indica onde o log foi chamado no código
    message: 'foo bla',       // mensagem descritiva da operação
    meta: {                   // metadados da operação (opcional)      
       color: 'red',
       user: 'john'
   }
})

[rodrigondec]

Não tenho muito experiência com logs e monitoramento de aplicações.

Mas voto na alternativa de ter os serviços/plataformas especializadas para isso.