¶ 1. Overview.
Within T6, we store system logs in the database. To reduce the allocated space and make them easier to review, we use the Log Retention parameter, which allows us to select how many months of logs will be stored in the REP_LOG_SECURITY_TRAIL table in the database. The logs stored in this table include login, logout, permission changes, system changes, and the creation, update, and deletion of explorer objects.
¶ 1.1. Prerequisites.
As a prerequisite to change the log retention period, the user must have the administrator feature Manage system parameters and configurations enabled.
¶ 2. Usage.
To use Log Retention, follow these steps:
- Go to the platform's main menu, open Settings, and select Parameters;
- A side panel will open, where you should click
; - Locate the Log Retention field;
- Fill in the field with the retention period in months for which the system will store logs in the database;
By default, the Log Retention parameter is blank, which means all generated records are stored in the database. After filling in this field, all stored logs outside the informed period will be permanently deleted.
- To apply the change, you must call the API;
- The API call can be made in two ways:
- Directly in the browser using the endpoint:
- Cloud environment example:
qablue.tech6cloud.com/api/log/DeleteLogRetention; (in this case, qablue is your domain name.) - Local environment example:
(IIS server)/(application name in IIS)/api/log/DeleteLogRetention
- Cloud environment example:
The URL before the API depends on your cloud domain or, in a local environment, on the settings configured in IIS (Internet Information Services).
- Making the call externally, using Swagger for example. (For more information on how to use it, access our Help Center: Swagger)
¶ 3. Q&A
Frequently Asked Questions
1. What is log retention in T6?
It is a parameter that allows you to define for how many months system logs will remain stored in the database. This helps reduce allocated space and makes visualization easier.
2. What types of logs are stored?
The stored log types include:
- login;
- logout;
- permission changes;
- system changes;
- creation;
- update;
- deletion of explorer objects.
3. Who can change the log retention period?
To change the log retention period, the user must have the administrator feature Manage system parameters and configurations enabled.
4. How can I change the log retention period?
To change the log retention period, follow these steps:
- In the T6 main menu, open Settings;
- Select Parameters;
- In the side panel, click System;
- Locate the Log Retention field and define the period in months;
- To apply the change, it is necessary to call the
api/log/DeleteLogRetentionAPI.
5. What happens if I leave the Log Retention parameter blank?
If you leave the Log Retention parameter blank, by default all generated records will be stored indefinitely in the database.
6. What happens to old logs when I define a retention period?
If old logs exist, after setting a retention period, all logs outside the informed period will be permanently deleted.
7. What are the ways to call the API for log retention?
The API can be called in two ways:
Directly in the browser: domain.tech6cloud.com/api/log/DeleteLogRetention
Through external tools, such as Swagger.
8. Can I recover deleted logs?
No, deletion is permanent when the log retention period is applied.