Audit Trail
Overview
Control Plane exposes a tamper-proof audit trail service for both Control Plane and custom workload actions. A UI is available to search, filter, and view the actions.
Each action that occurs on the Control Plane UI console or CLI is reliably captured, securely stored, and indexed using the audit trail. When using the Control Plane UI console, most resources have an audit trail link that will redirect to the audit trail page with the resource ID prefilled. Additional filters can be added to drill-down to specific events.
Your custom workloads can leverage this robust audit trail service without having to build your own. Please refer to custom workloads for additional details.
Audit Trail UI
The audit trail UI displays the details of each action that has been captured.
Each action contains:
- Timestamp
- Name of resource
- Kind of resource
- Version
- Results
- Message
- Subject (the user that acted)
- Link to display the raw JSON of the events
The actions displayed can be filtered by:
- Kind of resource
- Audit Context (the
cplnaudit context will only display Control Plane actions) - Resource name or ID
- Subject Name
- Start and optional end date
Sample Audit Trail UI
Below is a sample of the audit trail UI after executing a query showing all actions that occurred:
Custom Workloads
The architecture of the audit trail is generic and allows any workload to capture any action securely and reliably.
For your workload to use the audit trail, it must first create an audit context. Refer to the audit context reference page for additional details.
COMING SOON: Detailed instructions on how your workload can use the audit trail service.
View Custom Audit Trail
To view the actions that have been captured by your workload, you can use:
- The Control Plane Audit Trail UI:
- Within the UI, you can select the audit context and only view those actions.
- The Control Plane audit API:
- Leveraging the API, you can create a custom UI to display the audit data.
- View the OpenAPI documentation here to review the audit schema and available methods.
CLI
To view the CLI documentation for the Audit Trail, click here.