mirror of
https://github.com/Studio-Saelix/sencho.git
synced 2026-08-03 15:37:44 +00:00
Anso
c4e2595ded
* docs: remove security-sensitive implementation details from public documentation Generalize or remove internal architecture details that could aid targeted attacks — CVE tables, database schema, rate limit thresholds, proxy internals, encryption algorithm names, and WebSocket middleware bypass info. * test(metrics): fix flaky minute-bucket aggregation test Floor baseTime to the start of the current minute so baseTime + 5000 never crosses a minute boundary and produces 2 buckets instead of 1.
95 lines
4.0 KiB
Plaintext
95 lines
4.0 KiB
Plaintext
---
|
||
title: Audit Log
|
||
description: Track all mutating actions across your Sencho instance with a searchable, exportable audit trail for team accountability.
|
||
---
|
||
|
||
<Note>
|
||
The Audit Log requires a Sencho **Admiral** license. Skipper and Community Edition do not include this feature.
|
||
</Note>
|
||
|
||
Sencho Admiral records every mutating action (deploy, stop, delete, settings changes, user management) with full attribution. The audit log answers the question every team eventually asks: **"Who changed what, and when?"**
|
||
|
||
## What gets logged
|
||
|
||
Every `POST`, `PUT`, `DELETE`, and `PATCH` request to the Sencho API is automatically recorded with:
|
||
|
||
| Field | Description |
|
||
|-------|-------------|
|
||
| **Timestamp** | When the action occurred |
|
||
| **User** | The authenticated username that performed the action |
|
||
| **Method** | HTTP method (`POST`, `PUT`, `DELETE`, `PATCH`) |
|
||
| **Action** | Human-readable summary (e.g., "Deployed stack: nginx-proxy") |
|
||
| **Status** | HTTP response status code |
|
||
| **Node** | Which node the action targeted |
|
||
| **Request Path** | Full API path (visible in expanded detail view) |
|
||
| **IP Address** | Client IP address (visible in expanded detail view) |
|
||
|
||
### Example actions tracked
|
||
|
||
- Stack lifecycle: deploy, stop, start, restart, pull, delete
|
||
- Stack creation and file edits
|
||
- Node management: add, update, delete
|
||
- User management: create, delete, role changes
|
||
- Settings changes
|
||
- System prune operations
|
||
- License activation/deactivation
|
||
- Webhook and notification agent configuration
|
||
- Fleet backup creation, restoration, and deletion
|
||
- Scheduled task management
|
||
- Registry credential management
|
||
|
||
## Viewing the audit log
|
||
|
||
Navigate to the **Audit** tab in the sidebar. This tab is visible to users with the **Admin** or **Auditor** role on an Admiral license.
|
||
|
||
<Frame>
|
||
<img src="/images/audit-log/audit-log-overview.png" alt="Audit Log view showing a timeline of actions with search, filters, and export" />
|
||
</Frame>
|
||
|
||
Click any row to expand it and see full request details including the API path, IP address, node ID, and entry ID.
|
||
|
||
## Filtering & search
|
||
|
||
The audit log provides several ways to find specific entries:
|
||
|
||
- **Full-text search** — Search across action summaries, API paths, and usernames
|
||
- **Method filter** — Filter by HTTP method (POST, PUT, DELETE, PATCH)
|
||
- **Date range** — Set a start and/or end date to narrow results to a specific time window
|
||
|
||
All filters work together and are applied server-side with pagination.
|
||
|
||
## Export
|
||
|
||
Export the currently filtered audit log dataset as **CSV** or **JSON** using the **Export** dropdown in the header. The export respects all active filters — so you can narrow down to a date range or specific user before exporting.
|
||
|
||
Exports are capped at 10,000 entries per download.
|
||
|
||
## Auditor role
|
||
|
||
The **Auditor** role provides read-only access to the audit log without granting any administrative privileges. Auditors can:
|
||
|
||
- View the full audit log
|
||
- Search and filter entries
|
||
- Export audit data as CSV or JSON
|
||
- View stacks and nodes (read-only)
|
||
|
||
Auditors **cannot** modify settings, manage users, deploy stacks, or perform any other administrative actions. This role is ideal for compliance officers, security reviewers, or team leads who need visibility into system activity without operational access.
|
||
|
||
To create an Auditor user, go to **Settings → Users** and select the **Auditor** role when creating a new user.
|
||
|
||
## Configurable data retention
|
||
|
||
Audit log entries are automatically cleaned up based on your configured retention period. The default is **90 days**.
|
||
|
||
To change the retention period:
|
||
|
||
1. Go to **Settings → Developer → Data Retention**
|
||
2. Set the **Audit Log Retention** value (1–365 days)
|
||
3. Click **Save Developer Settings**
|
||
|
||
Cleanup runs automatically as part of Sencho's periodic maintenance cycle.
|
||
|
||
## Security at rest
|
||
|
||
Sensitive database values (such as remote node API tokens) are encrypted at rest. The encryption key is stored separately from the database, ensuring that database file exposure alone does not compromise secrets.
|