Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(builtin-audit-trails): added built-in section for audit trail #644

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/screenshots/audit-trail-logs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/screenshots/audit-trail-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/screenshots/setup-audit-trail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 24 additions & 1 deletion docs/integrations/audit-trail.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,32 @@

Spacelift optionally supports auditing all operations that change Spacelift resources. This is handled by asynchronously sending webhooks to a user-supplied endpoint.
truszkowski marked this conversation as resolved.
Show resolved Hide resolved

## Built-in logs

As an admin, you can view Audit trail logs by navigating to the Audit trail section of your account settings and choosing the _logs_ tab:

![](<../assets/screenshots/audit-trail-logs.png>)

Now, you can look for specific events using filters (on the left side) and date picker (in the top-right corner).
truszkowski marked this conversation as resolved.
Show resolved Hide resolved

![](<../assets/screenshots/audit-trail-logs-filters.png>)

You can see the details:

![](<../assets/screenshots/audit-trail-logs-details-button.png>)
![](<../assets/screenshots/audit-trail-logs-details.png>)

Also, go to the affected resource or apply another filter:
truszkowski marked this conversation as resolved.
Show resolved Hide resolved

![](<../assets/screenshots/audit-trail-logs-dropdown.png>)

### Retention

Logs are kept for 30 days.

## Setup
truszkowski marked this conversation as resolved.
Show resolved Hide resolved

In order to set up the audit trail, navigate to the Audit trail section of your account settings and click the _Set up_ button:
In order to set up the audit trail, navigate to the Audit trail section of your account settings and choosing the _configuration_ tab, and click the _Set up_ button:

![](<../assets/screenshots/audit-trail-page.png>)

Expand Down
Loading