TestRail’s audit logging system helps administrators track changes across the various entities within their TestRail instance. With audit logging enabled and the audit level set to high, administrators will be able to track every entity that’s created, updated or deleted in their installation.
Audit Logging is a TestRail Enterprise feature. Please contact us to upgrade your license to the Enterprise product tier to access this functionality.
Enabling and configuring auditing
The Auditing configuration is available via the administration console. You can navigate to it via Administration > Site Settings > Auditing.
Setting the audit level to Low, Medium or High will enable the auditing on your TestRail instance or server.
The number of rows displayed on the Log page can be controlled using the Number of Rows slider on the Auditing > Configuration tab, along with the Maximum Number of Audit Records Stored, and the Maximum Number of Days to store your audit records.
The background task should be enabled with TestRail Server to ensure data is purged within the defined retention policy.
Server administrators get an additional option, enabling them to write logs to an external location and read the logs using their preferred log reader:
Some additional configuration is required if you’re upgrading your TestRail installation (no need for additional config if you’re installing it fresh). You need to create an audit folder for your TestRail installation (with the appropriate permissions for it to be written to by the application, and provide the path to the folder in your config.php file by adding the following line:
define('AUDIT_PATH', '<filepath>');Using the audit log
Once auditing is switched on, you can monitor CrUD changes (Create, Update, Delete) across the entities in your TestRail instance, by navigating to the Auditing > Logs tab.
On the Logs tab, depending on your auditing level, you’ll see the following changes are recorded to the log:
| Auditing level | Changes recorded |
|---|---|
| High | Updates, deletions, creations |
| Medium | Updates, deletions |
| Low | Deletions only |
You can configure the level of logging depending on the requirements of your team. Each row of the log contains the following information:
| Column level | Column description |
|---|---|
| Date | Date and time which changes were made |
| Entity Type | The TestRail entity that was changed |
| Entity ID | The ID of the entitiy that was changed |
| Entity name | The defined name of the entity that was changed |
| Action | The type of change – Change, Delete, or Create |
| Author | The username of the user who made the change |
| Mode | The mechanism which the change was made – UI or API |
With logging activated and with some audit logs generated, you can filter for specific events using the Log filter. And if you wish to export the log for more detailed analysis, you can do so using the Export button.
The Forget User functionality will also obfuscate the user details in the audit log within TestRail.