ALM auditing
This section describes how ALM auditing works.
Enable or disable ALM auditing
Use the ENABLE_AUDIT site parameter to enable or disable ALM auditing.
For details about configuring site parameters, see see Set configuration parameters.
What to log and where logs are stored
The following table describes which actions are logged by ALM and where they are logged.
Action | Where the log is stored | Notes |
---|---|---|
User operations that include:
|
In the AUDIT_LOG file |
|
Who cleared history and when | In the AUDIT_LOG database table | |
Changes to test steps (both design steps and run steps) | In the AUDIT_PROPERTIES and AUDIT_LOG database tables |
To enable the auditing for test steps:
Caution: We recommend that you do not enable the auditing for test steps unless it is necessary, as it generates a large amount of auditing data, especially for run steps. |
Both old and new groups for a user when its membership is changed | In the AUDIT_LOG file | |
Add fields to store the current user, the current project session ID, and the current user session ID | In the AUDIT_LOG file | |
IP addresses for all users connected to ALM | In the AUDIT_LOG file | |
Changes to workflow scripts | In the AUDIT_LOG file | |
Entity relations | In the AUDIT_PROPERTIES and AUDIT_LOG database tables | |
Changes to site parameter values (Available in 17.0.1 and later) |
In the AUDIT_LOG file |
Configure auditing
You can configure the following for ALM auditing:
Keep audit log for specified categories | You can use the AUDIT_LOG_FILTER parameter to keep audit log only for specified categories. |
Store last login and logout time | ALM stores user's last login and logout time if the ENABLE_AUDIT_LOGIN_LOGOUT_TIME parameter is set to Y. |
For details, see Set configuration parameters.
AUDIT_LOG file location
By default, the AUDIT_LOG file is stored in the {ALM_deployment_folder}\log directory.
You can use the AUDIT_LOG_PATH parameter to specify a different location for the log file. In the new location, the log file is renamed AUDIT_LOG_<machine_name>.
For details about setting site parameter, see Set configuration parameters.