|
1 | 1 | --- |
2 | | -title:"Audit" |
3 | | -description:"" |
| 2 | +title:"Audit logs" |
| 3 | +description:"Get a list of all actions in Codefresh" |
4 | 4 | group:administration |
| 5 | +redirect_from: |
| 6 | + -/docs/enterprise/audit-logs/ |
5 | 7 | toc:true |
6 | 8 | --- |
7 | 9 |
|
8 | | -Most entities in Codefresh are GitOps-compliant, and fully controlled via the GitOps approach. |
| 10 | +Codefresh keeps a log of all actions that happen at all times, based on API calls that reach Codefresh. |
| 11 | +The audit log includes: |
| 12 | +* GUI actions from users |
| 13 | +*[CLI](https://codefresh-io.github.io/cli/) invocations |
| 14 | +* Any[external integrations]({{site.baseurl}}/docs/integrations/codefresh-api/) used with Codefresh |
9 | 15 |
|
10 | | -For information on which entities and how they are controlled, review[access control]({{site.baseurl}}/docs/administration/access-control/). |
| 16 | +The time frames by audit logs depends on the pricing tier of your Codefresh account. |
11 | 17 |
|
12 | | -Audit logs are available for GitOps-compliant entities. |
| 18 | +You can: |
| 19 | +* View, filter, and search for audited events |
| 20 | +* View API payload for an event |
| 21 | +* Download the audit log file in CSV |
13 | 22 |
|
14 | | -View audit logs: |
| 23 | +##View audit logs |
| 24 | +The Audit Log is divided into actions audited (All Audit), and tiggers and webhooks processed by Codefresh (Triggers). |
15 | 25 |
|
16 | | -* Of Git Sources, in the**Notifications** panel |
17 | | -* Of pipeline entities, in the**Update History** tab |
18 | | -* In your Git repository |
19 | 26 |
|
20 | | -###Git Source changes in Notifications |
21 | | -The**Notifications** panel is a pull-down panel, always available in the Codefresh toolbar. The panel shows a recent view of changes to entities such as Git Sources. |
| 27 | +1. In the Codefresh UI, on the toolbar, click the**Settings** icon and then select**Account Settings**. |
| 28 | +1. From the sidebar, from Access & Collaboration, select[**Audit**](https://g.codefresh.io/account-admin/audit/audit-all){:target="\_blank"}. |
| 29 | +1. To focus on a specific time frame, select the date range from the toolbar. |
| 30 | + The All Audit tab includes all Codefresh events in your account, sorted by the most recent events. |
| 31 | + Each event shows the following details: |
| 32 | +*`Entity ID/Name`: The entity that was affected. |
| 33 | +*`Entity type`: The type of entity on which the action was action, such as user, team, build, pipeline, project, etc. |
| 34 | +*`Action`: The action that was taken on the entity. |
| 35 | +*`Status`: The result of the API call. |
| 36 | +*`User`: The name of the user who performed the action. |
| 37 | +*`Last Request`: The time of the event. |
22 | 38 |
|
23 | 39 |
|
24 | | -{% include |
25 | | -image.html |
| 40 | +{% include image.html |
26 | 41 | lightbox="true" |
27 | | -file="/images/administration/audit/notifications.png" |
28 | | -url="/images/administration/audit/notifications.png" |
29 | | -alt="Git Sources change log in Notifications" |
30 | | -caption="Git Sources change log in Notifications" |
31 | | -max-width="30%" |
| 42 | +file="/images/administration/audit/audit-logs.png" |
| 43 | +url="/images/administration/audit/audit-logs.png" |
| 44 | +alt="Audit Logs view" |
| 45 | +caption="Audit Logs view" |
| 46 | +max-width="70%" |
| 47 | +%} |
| 48 | + |
| 49 | + |
| 50 | +The Triggers tab includes all the triggers/webhooks that were processed by Codefresh, with the same information as the Audit tab. |
| 51 | + |
| 52 | +{% include image.html |
| 53 | +lightbox="true" |
| 54 | +file="/images/administration/audit/audit-triggers.png" |
| 55 | +url="/images/administration/audit/audit-triggers.png" |
| 56 | +alt="Audit Triggers view" |
| 57 | +caption="Audit Triggers view" |
| 58 | +max-width="70%" |
32 | 59 | %} |
33 | 60 |
|
34 | | -###Pipeline entity changesinUpdate History |
35 | | -When you drill down into a pipeline, the**Update History** tab shows the list of changes to all its underlying entities. |
| 61 | +Both lists have built-inpaging and filtering. |
| 62 | + |
36 | 63 |
|
37 | | -{% include |
38 | | -image.html |
| 64 | + |
| 65 | + |
| 66 | +###Filter audited events |
| 67 | + |
| 68 | +Filter audited events to focus on a specific entity or user. |
| 69 | + |
| 70 | +{% include image.html |
39 | 71 | lightbox="true" |
40 | | -file="/images/administration/audit/update-history.png" |
41 | | -url="/images/administration/audit/update-history.png" |
42 | | -alt="Pipeline entity change log in Update History" |
43 | | -caption="Pipeline entity change log in Update History" |
44 | | -max-width="30%" |
| 72 | +file="/images/administration/audit/audit-filter.png" |
| 73 | +url="/images/administration/audit/audit-filter.png" |
| 74 | +alt="Filtering audit actions" |
| 75 | +caption="Filtering audit actions" |
| 76 | +max-width="40%" |
45 | 77 | %} |
46 | 78 |
|
47 | 79 |
|
48 | | -###Git repo change log |
| 80 | +###Get more details for audited events |
| 81 | + |
| 82 | +You can get the exact API payload for each event as it was sent to Codefresh. You can get the URL and other call parameters used for the selected event. |
| 83 | + |
| 84 | +* At the right of the row with the event, click the**More Details** (book) icon. |
| 85 | + |
| 86 | + |
| 87 | +{% include image.html |
| 88 | +lightbox="true" |
| 89 | +file="/images/administration/audit/api-call-details.png" |
| 90 | +url="/images/administration/audit/api-call-details.png" |
| 91 | +alt="API call details for audited event" |
| 92 | +caption="API call details for audited event" |
| 93 | +max-width="40%" |
| 94 | +%} |
| 95 | + |
| 96 | + |
| 97 | + |
| 98 | +##Export audit logs |
| 99 | + |
| 100 | +Export all log events, both Audits and Triggers, to a`CSV` file, for offline processing with your own tools or for viewing in external applications such as Microsoft Excel. |
49 | 101 |
|
50 | | -A change to a GitOps-controlled resource in Codefresh is made by Codefresh impersonating and pushing commits to your Git Sources. |
51 | | -TheGit repository linkedto theGit Source shows all the commits. |
| 102 | +* On the top right of the toolbar, click**Download Audit**. |
| 103 | +Thedownloaded file includes in additionto theevents themselves, the API call information (payload and parameters) for each event. |
52 | 104 |
|
53 | 105 |
|
54 | | -###(Future) Centralized audit log in account settings |
55 | | -We plan to create a centralized location from which to view all API operations. |
56 | 106 |
|
| 107 | +##What to read next |
| 108 | +[Codefresh installation options]({{site.baseurl}}/docs/administration/installation-security/) |
| 109 | +[Access Control]({{site.baseurl}}/docs/administration/access-control/) |
| 110 | +[Codefresh API]({{site.baseurl}}/docs/integrations/codefresh-api/) |