¶ 1. Visão Geral.
Dentro do T6 temos o armazenamento dos logs do sistema salvos no banco de dados. Para diminuir o espaço alocado para eles e facilitar a visualização temos o parâmetro Retenção de Registros, que nos permite selecionar a quantidade (em meses) de logs que teremos armazenados na tabela REP_LOG_SECURITY_TRAIL do banco de dados. Os logs armazenados na tabela são referentes à login, logout, alterações em permissões, alterações no sistema, criação, alteração e exclusão de objetos do explorer.
¶ 1.1. Pré Requisitos.
Temos como pré requisito para alteração do período de retenção de registros, um usuário com a feature de administrador Gerenciar parâmetros e configurações do sistema habilitada.
¶ 2. Utilização.
Para utilizarmos a Retenção de Registros iremos seguir os seguintes passos:
- Iremos no menu principal da plataforma em Configurações e selecionar a opção Parâmetros;
- Será aberto um panel na lateral no qual iremos clicar em
; - Localize o campo Retenção de Registros;
- Preencha o campo com o período em meses em que o sistema irá armazenar os logs no banco de dados;
Por padrão o parâmetro Retenção de Registros estará em branco, fazendo o armazenamento no banco de dados de todos os registros gerados. Ao preencher o campo do parâmetro, todos os logs armazenados que não estejam dentro do período informado serão excluídos permanentemente.
-
Para que a alteração entre em vigor, precisaremos chamar a API para tal;
-
A chamada da API pode ser feita de duas formas:
- Diretamente através do browser utilizando o endpoint:
- Exemplo de ambiente cloud:
qablue.tech6cloud.com/api/log/DeleteLogRetention; (neste caso, qablue é o nome do seu domínio.) - Exemplo de ambiente local:
(servidor do IIS)/(nome da aplicação no IIS)/api/log/DeleteLogRetention
- Exemplo de ambiente cloud:
- Diretamente através do browser utilizando o endpoint:
A URL informada antes da API vai depender do seu domínio na cloud, ou, em caso de ambiente local, das configurações informadas no seu IIS (Internet Information Services).
- Fazendo a chamada de forma externa, utilizando, por exemplo, o Swagger. (Para mais informações sobre como utilizar acesse nossa Central de Ajuda: Swagger)
¶ 3. Q&A
Perguntas Frequentes
1. O que é retenção de logs no T6?
É um parâmetro que permite definir por quantos meses os logs do sistema ficarão armazenados no banco de dados. Isso ajuda a diminuir o espaço alocado e facilita a visualização.
2. Quais tipos de logs são armazenados?
Os tipos de logs armazenados incluem:
- login;
- logout;
- alterações em permissões;
- alterações no sistema;
- criação;
- alteração;
- exclusão de objetos do explorer.
3. Quem pode alterar o período de retenção de logs?
Para alterar o período de retenção de logs, é necessário que o usuário tenha a funcionalidade de administrador Gerenciar parâmetros e configurações do sistema habilitada.
4. Como alterar o período de retenção de logs?
Para alterar o período de retenção de logs, siga estes passos:
- No menu principal do T6, acesse Configurações;
- Selecione Parâmetros;
- No painel lateral, clique em Sistema;
- Localize o campo Retenção de Registros e defina o período em meses;
- Para que a alteração entre em vigor, é necessário chamar a API
api/log/DeleteLogRetention.
5. O que acontece se eu deixar o parâmetro Retenção de Registros em branco?
Caso deixe o parâmetro Retenção de Registros em branco, por padrão, todos os registros gerados serão armazenados indefinidamente no banco de dados.
6. O que acontece com logs antigos quando defino um período de retenção?
Caso existam logs antigos, após definir um período de retenção, todos os logs que não estejam dentro do período informado serão excluídos permanentemente.
7. Quais são as formas de chamar a API para retenção de logs?
A chamada da API pode ser feita de duas formas:
Diretamente pelo browser: dominio.tech6cloud.com/api/log/DeleteLogRetention
Através de ferramentas externas como Swagger por exemplo.
8. Posso recuperar logs excluídos?
Não, a exclusão é permanente quando o período de retenção de logs é aplicado.