Overview
CircleCI Cloud Customers can retrieve audit logs by submitting a support ticket or by using the Self-serve audit log feature via the CircleCI UI (Custom Performance and Scale plans only).
Self-serve Audit logs
Starting 11/01/2022 customers on a scale or custom performance plan can use the self-serve audit log feature to retrieve audit logs from within the UI. To retrieve audit logs please navigate to your organization settings page > "security" and scroll down to the "Audit logs" section. A user requesting audit logs in required to be an organization admin. If you are not an organization admin, you will not see this feature.
Additionally, self-serve audit log retrieval is limited by the following per plan type:
-
Scale - 3 requests per 30-day period
-
Performance - 1 request per 30-day period
-
Others - 0 requests per 30-day period
Note: Sometimes audit log requests may fail due to audit log files being too large. When requesting audit logs using the self-serve option, we recommend requesting 1 month at a time starting from the most recent month.
Requesting Audit logs
CircleCI Cloud Customers can request audit logs for free by submitting a support ticket. There are several requirements that must be met for the request to be processed. For an example of the audit logs events captured, please see our documentation located here: Audit Logs.
Note: CircleCI Server customers can access the audit log feature from the UI.
Requirements
The requester should be the organization admin or should have an org admin's approval. This is very important as we provide audit logs for the entire organization. Project-level audit logs are not possible.
Submitting Audit Log Request:
Submit the following in a support ticket.
- Your VCS Organization Name
- Date Range
To provide the logs without any delay, we need a date range in the format year-month-date. For example, if you want audit logs from May 1st, 2020 to May 31st, 2020, just let us know the start & end date like below:
Start date: 2020-05-01
End date: 2020-05-31
Per our Data Retention Policy, audit logs can be retrieved for up to 12 months.
Delivery
Audit logs will be supplied securely to the ticket submitter/organization admin via SendSafely.
Unsupported
- Recurring audit logs
- Project-level audit logs
Comments
Article is closed for comments.