The Foxhole Inspector is a diagnostic tool that provides detailed information about your deployment's state, including database statistics, Redis status, MinIO storage, and filesystem information.
- Docker and Docker Compose must be running
- The Foxhole application must be deployed and running
- You must run the script from the project root directory
./inspect.sh [options]
--format <format>
: Output format (default: json)json
: Output in JSON formattext
: Output in human-readable text format
--user-secret <secret>
: Filter inspection by specific user secret--hours <n>
: Show recent activity for the last n hours (default: 24)--output <file>
: Write output to a file instead of stdout
- View help and available options:
./inspect.sh --help
- Basic inspection in text format:
./inspect.sh --format text
- Inspect specific user's data:
./inspect.sh --user-secret "user-secret-here" --format text
- Custom time range inspection:
./inspect.sh --hours 48 --format text
- Save inspection results to file:
./inspect.sh --format json --output inspection_results.json
The inspector provides information about:
- Database file size
- Table schemas
- Entity counts (users, tasks, topics, people, notes)
- Recent activity
- Connection status
- Memory usage
- Total keys
- Sample of stored keys
- Connection status
- Bucket information
- Recent objects
- Data directory size
- Directory contents
- Path information
If you encounter any issues:
- Ensure the application containers are running:
docker-compose ps
- Check container logs:
docker-compose logs app
- Verify database path:
./inspect.sh --format text | grep "database"
- The inspection is non-intrusive and read-only
- Large datasets might take longer to process
- Memory usage might spike temporarily during inspection
- All timestamps are in ISO format
- File sizes are in bytes unless otherwise specified