Skip to main content

Workspace Activity Logs

What it is​

View activity logs for workspace actions

Who it's for​

Workspace Owner

Access & Scope​

PropertyValue
Moduleworkspace-activity-logs
Personasworkspace-owner
ScopeWorkspace-level
UI LocationDashboard > Settings > Activity Logs

| Status | active |

UI Location​

Dashboard > Settings > Activity Logs

How it works​

The Workspace Activity Logs feature provides a comprehensive audit trail of all actions performed in your workspace. Here's how it works:

  1. Activity Tracking:

    • All workspace actions are automatically logged
    • Logs include: who performed the action, what action was taken, when it occurred, and what was affected
    • Logs are immutable (cannot be edited or deleted)

  2. Activity Display:

    • View logs in a paginated list
    • Each log entry shows:
      • Actor (who performed the action)
      • Action type (what was done)
      • Target (what was affected)
      • Timestamp (when it occurred)
      • Changes (what changed, if applicable)

  3. Filtering:

    • Filter by actor type (workspace owner, staff member, system)
    • Filter by action (create, update, delete, etc.)
    • Filter by target type (client, session, product, etc.)
    • Multiple filters can be applied simultaneously

  4. Change Tracking:

    • For update actions, see what changed
    • Before/after values are displayed
    • Changes are formatted for readability

  5. Pagination:

    • Navigate through log pages
    • Configurable page size
    • View total number of logs

Settings​

The Workspace Activity Logs feature includes the following configuration options:

  1. Display Settings:

    • Page size (default: 10 logs per page)
    • Sort order (newest first by default)

  2. Filter Settings:

    • Actor type filter (workspace owner, staff, system, or all)
    • Action filter (text search)
    • Target type filter (client, session, product, order, etc.)

  3. View Settings:

    • Expand/collapse change details
    • View full change information
    • Format timestamps based on locale

Permissions​

Access to Workspace Activity Logs requires:

  • Workspace Owner: Has full access to view all activity logs
  • Staff: Access may be restricted. Typically, only workspace owners can view activity logs.

Note: Activity logs contain sensitive information about workspace operations. Access is typically restricted to workspace owners for security and privacy.

Use Cases​

  1. Audit Trail:

    • Track all workspace activities
    • Maintain compliance records
    • Review historical changes

  2. Security Monitoring:

    • Monitor unauthorized access attempts
    • Track suspicious activities
    • Identify security issues

  3. Change Tracking:

    • See what changed and when
    • Identify who made changes
    • Review change history

  4. Troubleshooting:

    • Investigate issues by reviewing logs
    • Identify when problems occurred
    • Track down root causes

  5. Accountability:

    • Know who performed which actions
    • Maintain accountability records
    • Review staff activities

  6. Data Recovery:

    • Review deleted items
    • Identify when data was removed
    • Understand data changes

Notes / Limits​

  1. Log Retention:

    • Logs are retained indefinitely (check current policy)
    • Logs cannot be deleted or edited
    • Large numbers of logs may impact performance

  2. Log Details:

    • Change details show before/after values
    • Complex objects are displayed as JSON
    • Some changes may not show detailed diffs

  3. Filtering:

    • Filters use AND logic (all filters must match)
    • Action filter is text search (partial matching)
    • Target type filter is exact match

  4. Performance:

    • Large numbers of logs may load slowly
    • Pagination helps manage performance
    • Filters reduce the number of displayed logs

  5. Actor Information:

    • Actor name and email are displayed when available
    • System actions are marked as such
    • Staff actions show staff member information

  6. Timestamp Format:

    • Timestamps are formatted based on workspace locale
    • Includes both date and time
    • Timezone is based on workspace settings

  7. Change Display:

    • Simple changes show before/after values
    • Complex changes may show JSON format
    • Some changes may not have detailed information

  8. Pagination: Logs are paginated for performance. Use filters to narrow results if needed.

Changelog​

Mon Jan 15 2024 02:00:00 GMT+0200 (Eastern European Standard Time)​

  • Initial documentation