...
Zephyr provides the audit logs to the administrators admiral-kept to keep track of and view the changes that have been made to your Zephyr instance. This is extremely useful as it allows you the flexibility and support to troubleshoot a problem. Keeping a well-kept audit log of the events happening in your Zephyr instance is key as it allows you to record all the important events happening. Utilizing your audit logs can also be beneficial when troubleshooting issues that arise as it lets you see what events are happening and when they occur.
...
Requirements
Test case management
Admin and configuration setting changes
Re-indexing attempts and results
Customization changes
Updating the estimated time and execution status creation
User setup events
Creation, role updates, exporting functionality, and any user update action
Group setup events
Adding, Editing, Deleting, Syncing and Importing Groups
...
Administrators can view the individual log meta-data by clicking on the ShowData button for the individual event in the list of the logs.
This will display a pop-up with the meta-data for the event that occurred.
...
All individual logs will contain a log ID, time the action was performed, entity (general category of the action), operation/action (the type of action performed), and the user that performed the operationoperated.
...
Search Audit Logs using Filters
Audit logs can contain hundreds or even thousands of events tracked daily, especially if you have multiple teams/users working within the Zephyr application. We understand that this can be frustrating when you want to look for something specific in regards regard to a tracked event. With this in mind, we’ve created a way for you to search through and narrow your audit logs to look for exactly what’s needed. By using filters, we can narrow our search of tracked events in the audit log.
...
Entities: Category of the action being performed (testcase, requirement, etc.).
Operation: The type of action that is performed by the user (test case creation, re-index, etc.).
User: The user that performed the operation/action.
From and To: The date range for the tracked events that you want to view within that timeframe. “From” is the start date of the timeframe and “To” is the end date of the timeframe.
...
Note: The Operation filter uses a text field and to search by Operation, the user needs to enter the EXACT text for the operation to match. For example, if a user wants to search for the operation “Test case Deletion”, the user cannot enter “Test case” and get the expected results. The user must enter the EXACT name and enter in “Test case Deletion” in the field to retrieve the expected results when searching.
...
Truncating your audit logs is essentially permanently deleting all of the events within a specific timeframe. When truncating, the truncated logs cannot be retrieved again and this is a permanent removal. We recommend you to make sure all logs within the timeframe are ready to be truncated before proceeding. If you’re ready to truncate your audit log, you may want to export the logs to have a CSV file so that you have an extra copy of the logs before truncating.
...
This will display a pop-up where you must select the date where which you want to truncate from.
...
Zephyr will truncate and permanently delete all the log entries on the date selected as well as all the log entries prior to before the date. So essentially, it will permanently delete all logged events on this date and all events before the given date. Every log entry after the date will remain in the audit log.
...
3. You will then be prompted with a warning about truncating your audit log. This is here to confirm you are ready to truncate your logs and remove all log entries on the date selected and everything prior to before the date selected as well. Click the Yes, Truncate Audit Log button to confirm and proceed to truncating your audit log. This will remove the audit log entries for the selected timeframe and will display the audit log table after truncating is complete.
...
You can opt-in to share your usage data with SmartBear. This allows us to get a better insight on into what our customers are up to and what sort of features are being used the most throughout Zephyr. With this information, we can see where our users are running into problems and it helps us gather information for troubleshooting. By providing us with this usage information, we have insight in into how we can improve our product to increase the efficiency for our users. We do not collect any personally identifiable information regarding our users or the actions done within your Zephyr system.
...
3. When the pop-up display appears, make sure the Share anonymous usage data with the SmartBear option is selected.
...
Zephyr log files can be accessed in the Zephyr folder after you download the application. These Zephyr logs are now capped. The log files are now tracked on a daily basis by breaking the log file up.
The log files are broken up at midnight and will append the date for the previous day to the recorded log file.
Log files essentially record up to 24 hours allowing users to navigate to the specific log file rather than parsing one enormous log file.
FAQ
We store all the Audit logs from the beginning, right?
Right. The audit logs are stored since the beginning of the application when it is installed. Once you install the build and login as telognager, test. lead, or tester .one, you can find the “audit log” section in the “About Zephyr” page. Just provide or select the event that u wants to see, and you can see the details.
Does our app remove audit logs automatically after some entries or count exceeds? Do we have any limitation on showing the total count/number of audit logs?
We do not have any limitations to date, so no limit count is there.
Automatically the log entries will not be removed as the data is saved in the database. They will be removed only when the user hits the “Truncate Log” button and re-confirms it.
Also, upon uninstalling the application, the cleaning process is done, then only the data will be removed automatically.
There is no other means to remove or delete the log entries.
Till the user manually truncate the records we will show ALL the audit log entries. Correct?
Correct. All the log entries are retained, until the user truncates them up to the provided date. We can select up to the current date, future dates are not selectable.
By using truncate option users can dispose of the audit log record based on the time frame and when they want.
Right.
We can select the date from the drop-down provided and all the log entries on and before that date will be deleted. As of now, no option is available for selecting the time on a given date.
If you select the current date, then all the logs are deleted, and fresh audit log entries begin afterward.