Audit History

Auditing

The Auditing Feature is a tracking mechanism that records key actions performed on system resources. It gives Tenant Admins visibility into changes, ensuring transparency, security, and accountability. By maintaining a detailed history of modifications, this feature helps in troubleshooting incidents and enforcing governance policies.

Current Version Coverage

Currently, the auditing feature tracks the following actions that are performed on the resources.

ResourceType Actions

Instance

Created, Updated, Deleted

Cluster

Created, Updated, Deleted

Application

Created, Updated, Deleted, Authentication Configured, Authentication Unconfigured, Application Configured, Application Unconfigured, Application Access Requested, Application Access Cancelled, Application Access Approved, Application Access Denied, Application Access Revoked, Application Started, Application Stopped, Application Restarted, Application Reset

Topic

Created, Updated, Deleted, Topic Configured, Topic Unconfigured, Topic Browsed, Application Access Requested, Application Access Cancelled, Application Access Approved, Application Access Denied, Application Access Revoked, Browse Permission Granted, Browse Permission Revoked

Environment

Created, Updated, Deleted, Authentication Configured, Authentication Unconfigured, Application Configured, Application Unconfigured, Application Access Requested, Application Access Cancelled, Application Access Approved, Application Access Denied, Application Access Revoked, Application Started, Application Stopped, Application Restarted, Application Reset, Topic Configured, Topic Unconfigured, Topic Browsed, Browse Permission Granted, Browse Permission Revoked
Access to the audit history is restricted to Tenant Admins.

Enable Auditing

To enable the Auditing feature to track the performed actions, the Operator must first activate the Auditing Feature in the values.yaml for the Platform-Manager as shown below:

platform-manager:
  config:
    axual:
      # Auditing Feature
      audit:
        enabled: true

To make the stored events visible for the Tenant Admins, the Operator must activate the Auditing Feature in the values.yaml for the Platform-UI as shown below:

platform-ui:
  config:
    # Auditing Feature
    auditHistoryEnabled: true

View Audit History

After enabling the Auditing feature, the performed actions on the resources are stored and only Tenant Admins can view the audit history.

To view the audit history, navigate to the Audit History tab of the Tenant page. You will see a list of all the audit entries, which include the timestamp, resource type, actor, and action.

Large numbers (typically those with more than 15 digits) are represented as strings to prevent loss of precision during parsing or serialization.
Audit History tab view

View Audit History with Filters

You can filter the audit history based on the resource type, actor, action, and time range.

Filter by Resource Type

You can filter the audit history by resource type, which allows you to view the audit history for a specific resource type.

Audit History tab filtered by Resource Type

Filter by Resource Name

When you select the resource type, the resource name gets visible, and you can filter the audit history by resource name.

If you want to see the audit history for an existing resource, select the resource name from the loaded list in the dropdown.

If the desired resource is deleted, and you want to see the full audit history of that resource, write down the name and select it and perform the search.

Audit History tab filtered by Resource Type and Resource Name

Filter by Actor

You can filter the audit history by actor, which allows you to view the audit history for a specific actor.

If you want to see the audit history for an existing user, select the user email address from the loaded list in the dropdown. If the desired user is deleted, and you want to see performed actions by that user, write down the valid email address and select it and perform the search.

Audit History tab filtered by Actor Name

Filter by Action

You can filter the audit history by action, which allows you to view the audit history for a specific action. Select an action from the dropdown to filter the audit history and perform the search. The currently supported filterable actions are: Created, Updated, and Deleted.

Audit History tab filtered by Action

Filter by Time Range

You can filter the audit history by time range, which allows you to view the audit history for an absolute or relative time.

Audit History tab filtered by Time range

Filter by multiple criteria

You can filter the audit history by multiple criteria to narrow down the results and get a more specific view of the audit history.

For instance, you can filter the result to see all the Updated actions performed by a specific user on a specific Application within the last 24 hours.

Audit History tab filtered by multiple criteria