Audit Trail
Audit Trail is an Enterprise module that provides comprehensive logging of all HTTP requests to your HomeDock OS instance. This feature is essential for compliance requirements, security audits, and troubleshooting.
Log Information
Section titled “Log Information”Each audit log entry captures:
| Field | Description |
|---|---|
| Timestamp | Exact date and time of the request |
| Method | HTTP method (GET, POST, PUT, DELETE, etc.) |
| Endpoint | The API endpoint accessed |
| Status | HTTP response status code |
| IP | Client IP address |
| User | Authenticated user (if applicable) |
Viewing Audit Logs
Section titled “Viewing Audit Logs”The Audit Trail interface displays logs in a virtualized table for efficient handling of large datasets. Features include:
- Real-time updates: Logs appear as requests are made
- Search/Filter: Find entries by endpoint, method, IP, or user
- Status highlighting: Visual indicators for errors (4xx, 5xx)
- Entry count: Total number of logged requests
Filtering Options
Section titled “Filtering Options”Text Search
Section titled “Text Search”Use the search box to filter logs by:
- Endpoint path
- HTTP method
- IP address
- Username
- Status code
Pattern Exclusion
Section titled “Pattern Exclusion”To focus on relevant logs, you can exclude common patterns:
| Pattern | Description |
|---|---|
/thread/* | System metrics polling (CPU, RAM, disk) |
/api/containers | Container status checks |
/api/system-logs/* | Log fetching endpoints |
/api/enterprise/* | Enterprise module endpoints |
Click the Filter button to access exclusion options. Active exclusions are indicated by an orange badge showing the count.
Status Code Colors
Section titled “Status Code Colors”Audit Trail uses color coding to highlight request outcomes:
- 2xx - Successful requests (green)
- 3xx - Redirects (blue)
- 4xx - Client errors (yellow background)
- 5xx - Server errors (red background)
Method Colors
Section titled “Method Colors”HTTP methods are also color-coded for quick identification:
- GET - Read operations
- POST - Create operations
- PUT/PATCH - Update operations
- DELETE - Delete operations
Audit logs are retained according to your system’s log retention policy. Consider exporting important logs using the System Report feature for long-term archival.
Compliance Use Cases
Section titled “Compliance Use Cases”Audit Trail supports various compliance requirements:
- Access logging: Track who accessed what and when
- Change tracking: Monitor configuration changes
- Security monitoring: Detect unusual access patterns
- Incident response: Investigate security events with detailed logs
Integration with System Report
Section titled “Integration with System Report”Audit Trail data can be included in PDF reports generated by the System Report module. This allows you to create comprehensive compliance documentation that includes:
- Audit log statistics
- Top endpoints accessed
- Request distribution by method
- IP address activity summary