Audit Logs

The Audit Logs tab in SnapAssign provides administrators with a detailed history of actions taken within the application. This tab is essential for tracking changes, monitoring user activity, and ensuring accountability.

Understanding the Audit Logs

The Audit Logs tab displays a chronological list of actions, including information about who performed the action, when it was performed, and details about the objects affected.

Columns in the Audit Logs:
  1. Date:

    • Displays the timestamp for when the action occurred. The logs are organized chronologically, with the most recent actions appearing at the top.

  2. User:

    • Shows the username of the individual who performed the action. This helps in identifying who made specific changes.

  3. Object Type:

    • Indicates the type of object that was affected by the action (e.g., Calendar, Assignment Rule, Parameter).

  4. Object Name:

    • Provides the specific name of the object that was altered. This could be the name of a calendar, assignment rule, or any other object within the application.

  5. Action:

    • Describes the type of action that was performed, such as Create, Update, or Delete.

  6. Details:

    • The Show Details link provides additional information about the action, including the specific changes made. Clicking this link opens a more detailed view of the log entry.

      image-20240928-094022.png
      Audit log table

     

Filtering Audit Logs

The Audit Logs can be filtered to help administrators find specific actions or review activities within a particular timeframe.

  • Start Date and End Date:

    • Filter the logs by a specific date range to view actions within that period.

  • Select User:

    • Filter the logs by a specific user to see actions performed by that individual.

  • Select Action:

    • Filter the logs by action type (e.g., Create, Update, Delete) to focus on particular changes.

  • Reset Filters:

    • The Reset button clears all filters, displaying the full audit log again.

      image-20240928-093801.png
      Filtering audit logs

Navigating the Logs

  • Pagination:

    • The logs are displayed in pages, with navigation buttons at the bottom allowing you to move through the pages. This is especially useful when there are a large number of log entries.

  • Details View:

    • Clicking on Show Details in any log entry opens a detailed view, providing in-depth information about what was changed, including before-and-after values where applicable.

Retention Policy

  • Log Retention:

    • Audit logs are stored for a maximum of three months. After this period, logs are automatically deleted. This limitation is due to the constraints and restrictions of the Atlassian Forge platform.

    • Best Practice: It is recommended that administrators regularly export audit logs if longer retention is necessary for compliance or record-keeping purposes.