Estudo do sistema de Logs no sistema Consignação

1. Objetivo

O presente estudo visa analisar como está sendo criado os logs do sistema Consignação. Dessa forma, utilizá-lo para adequar as necessidades de auditoria.

1.1 JUSTIFICATIVA

Atualmente existe um sistema de logs no Consignação, porém a equipe Vingadores não tem conhecimento de como esse log é feito, por isso este estudo está sendo realizado.

1.2 RESULTADOS ESPERADOS

Espera-se que, após este estudo, seja possível levantar quais são os esforços necessários para adequar o modo que o log está sendo realizado no sistema Consignação para adequá-lo às necessidades de auditoria.

2. Introdução

O sistema Consignação necessita de mais informações no sistema de logs.

3. Desenvolvimento

3.1 CENÁRIO ATUAL

Para o início do estudo, foi identificada uma base de dados contendo os logs do sistema consignação.

Essa base possui somente uma tabela no qual foi verificado que os seguintes campos estão presentes:

1. COD_LOG: Código numérico auto incrementado, identificador do registro na tabela.
2. DAT_LOG: Data de registro do log.
3. DES_OPERACAO: Tipo de operação realizada na entidade.
4. DES_TABELA: Nome da tabela que está sofrendo a operação.
5. DES_LOG: Log em json gerado que mostra os dados do registro que estão sendo modificados.
6. GID_APLICACAO: Código único do sistema pertencente àquele log.

_{Tabela 1. Tabela de logs com dados anonimizados}

Método Salvar na classe TipoDeVerbaServico

Para identificar o funcionamento do log foi utilizado o método Salvar da classe TipoDeVerbaServico. Nessa classe, foi possível identificar o salvamento do log, através da utilização do método registrar, da classe LogServico na penúltima linha do código abaixo:

_{Imagem 2. Exemplo de criação de logs no salvamento do Tipo de Verba}

Classe LogServico

A classe LogServico trata das regras de negócio dos logs do sistema. Ela é responsável por registrar logs de operações realizadas em entidades do sistema, através da persistência de objetos do tipo LogJson.

O serviço é composto por dois métodos:

1. O método registrar, que recebe como parâmetros uma entidade (que pode ser qualquer objeto do sistema), um funcionário, uma enumeração LogJsonOperacaoEnum, que representa a operação realizada (CREATE, UPDATE ou DELETE) e um guid da aplicação (nesse caso, do sistema consignação). Este método é responsável por recuperar o nome da tabela que representa a entidade passada como parâmetro e chamar um método para realizar o registro do log.
2. O método recuperarEntidadeNome, que recebe como parâmetro uma entidade e é responsável por recuperar o nome da tabela que representa a entidade, a partir do uso da anotação @Table na classe da entidade.

Além disso, a classe LogServico possui uma classe interna chamada LogRegistrador, que implementa a interface Runnable. Essa classe é responsável por construir o objeto LogJson com as informações necessárias para ser persistido no banco de dados.

Classe LogRegistrador

A classe LogRegistrador implementa a interface Runnable e é responsável por registrar operações de log em uma entidade, ou objeto, em um banco de dados.

_{Imagem 3. Campos da classe LogRegistrador}

O construtor da classe recebe uma instância de ILogJsonRepositorio que é uma interface para acesso ao banco de dados onde serão salvos os logs, um objeto que representa a entidade que sofrerá o log, um valor do tipo LogJsonOperacaoEnum que representa a operação que está sendo realizada (como criar, atualizar ou excluir a entidade), o nome da tabela em que a entidade está armazenada, o GID (identificador global) da aplicação que está realizando a operação, e o nome do funcionário responsável pela operação.

A classe também possui um método run() que é chamado quando a classe é executada em uma thread. Esse método realiza a validação dos campos obrigatórios da entidade e, caso todos os campos estejam preenchidos, cria uma string JSON que representa a entidade usando a biblioteca ObjectMapper, do Jackson, e a salva no banco de dados através da instância de ILogJsonRepositorio. Caso algum erro ocorra durante a execução, uma mensagem de erro é exibida no log da aplicação.

A classe LogServico possui também quatro classes internas que implementam as interfaces JsonSerializer e JsonDeserializer. Essas classes são utilizadas pelo ObjectMapper para serializar e deserializar os objetos do tipo LocalDateTime e LocalDate. Isso é necessário para que os valores desses campos sejam corretamente armazenados e recuperados no banco de dados.

Interface LogJsonRepositorio

A interface LogRepositorio é utilizada na persistência das informações no banco de dados. Ela é decorada com @Repository a qual permite a utilização dos métodos padrões de CRUD (save, saveAll, exists, findAll, findById, deleteById, deleteAll, count, etc.)

_{Imagem 4. Interface ILogJsonRepositorio}

3.2 SOLUÇÃO

Considerando a análise realizada sobre o funcionamento do registro no sistema de consignação, conseguimos encontrar uma solução viável para a inclusão das informações requisitadas no registro de logs do banco de dados.

 

3.2.1 Campos adicionais

De acordo com a solicitação as seguintes informações são necessárias:

IP
DATA e HORA
DESCRICÃO MAIS CLARA DA AÇÃO DO USUÁRIO
CPF do Servidor/CNPJ do funcionário

De acordo com o estudo anterior a respeito dos logs, essas informações podem ser obtidas conforme mencionado no documento.

Para que esses dados sejam persistidos, são necessárias as seguintes ações:

1. Criar os campos: IP, CPF/CNPJ na tabela LogRegistrador.
2. Adicionar esses campos no construtor da classe LogRegistrador.
3. Verificar uma forma genérica de obter esses dados e passar para o construtor. Sugestão: Utilizar a classe AbstractServico e criar os métodos para obter o IP e o CPF/CNPJ, conforme o exemplo abaixo:

public String getIpDoUsuario(){
        HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.currentRequestAttributes()).getRequest();
        String ip = request.getRemoteAddr();
        return ip;
    }

Na chamada

String ip = super.getIp();

3.2.2 - Verificação do log das rotinas mais críticas

A tabela abaixo apresenta quatro rotinas relacionadas ao sistema Consignação e sua situação atual em relação à gravação de logs. As ações necessárias para melhorar a situação incluem incluir a gravação de log nas rotinas que atualmente não estão gravando, fornecer uma descrição mais clara das ações do usuário na rotina que já está gravando, e incluir a gravação de log de quem fez a importação de arquivos.

Rotinas	Situação atual	Ação necessária
Consulta de gestão de averbação	Não está gravando o log na consulta	Incluir gravação de log
Registro de quem fez a baixa e quitação de averbações manuais	Está gravando o log	Descrição mais clara a ação do usuário, no caso da averbação, qual tipo que ele está realizando a ação
Acesso ao sistema (ao logar)	Não está gravando o log	Incluir gravação de log, nesse caso, ao invés de passar a entidade, passa as informações de login.
Importação de arquivos	O sistema não está gravando o log de quem fez a importação dos arquivos	Incluir gravação de log, utilizar a tabela IMPORTACAO.

3.2.3 Considerações e Pontos de atenção

1. Ao contrário do estudo anterior, essa forma de armazenamento de logs está funcionando perfeitamente. Foram realizados testes em que podemos ver os logs sendo gravados em ambiente teste.
2. Esta será a primeira alteração do banco de dados feita pelo time em projetos JAVA.
3. Os novos campos dos registros passados ficarão em branco ou nulos.

3.2 IMPLEMENTAÇÃO E HISTÓRIAS DE USUÁRIOS

O que?	Pontos	Regras/Observações	Produto
Inclusão 3 campos IP CPF/CNPJ Detalhes da ação	5	Incluir os campos na entidade e migrar para o banco de dados	Consignação
Adicionar os campos no construtor da classe LogRegistrador e incluí-los em cada chamada	13	No código foi possível identificar 55 chamadas para esse código	Consignação
Incluir gravação de log na consulta de gestão de averbação	5	Gravar o log de quem acessa essa tela (Averbação -> Gestão -> Pesquisa o servidor -> tela que mostra todas as averbações do servidor)	Consignação
Detalhar qual ação está sendo realizada na tela de gestão de averbação (REDUZIR JUDICIAL, SUSPENDER, BAIXAR PARCELAS, QUITAR)	5	Já está sendo gravado o log do INSERT de cada ação. Gravar uma descrição mais clara da ação do usuário e qual o tipo da averbação	Consignação
Detalhar qual tipo de averbação foi cadastrada	5	Já está sendo gravado o log do INSERT. Gravar uma descrição mais clara de qual o tipo de averbação foi cadastrada	Consignação
Acesso ao sistema	8	Incluir gravação de log	Consignação
Importação de arquivos	8	Incluir gravação de log. Detalhar qual tipo de importação está sendo realizada (ex: servidor, cargo, verba, etc.).	Consignação

4. Conclusão

Após uma análise cuidadosa sobre o funcionamento do registro no sistema de consignação, conseguimos encontrar uma solução prática e viável para incluir as informações necessárias no registro de logs do banco de dados. A criação dos campos IP e CPF/CNPJ na tabela LogRegistrador e a utilização da classe AbstractServico para obter esses dados de forma genérica são algumas das ações necessárias para garantir a persistência das informações. É importante lembrar que essa será a primeira alteração no banco de dados pelo time em projetos JAVA, e que os registros anteriores ficarão em branco ou nulos nos novos campos criados.