mirror of
https://github.com/AutoMaker-Org/automaker.git
synced 2026-02-03 21:03:08 +00:00
feat: introduce debug panel for performance monitoring
- Added a debug panel to monitor server performance, including memory and CPU metrics. - Implemented debug services for real-time tracking of processes and performance metrics. - Created API endpoints for metrics collection and process management. - Enhanced UI components for displaying metrics and process statuses. - Updated documentation to include new debug API details. This feature is intended for development use and can be toggled with the `ENABLE_DEBUG_PANEL` environment variable.
This commit is contained in:
41
CLAUDE.md
41
CLAUDE.md
@@ -170,3 +170,44 @@ Use `resolveModelString()` from `@automaker/model-resolver` to convert model ali
|
||||
- `DATA_DIR` - Data storage directory (default: ./data)
|
||||
- `ALLOWED_ROOT_DIRECTORY` - Restrict file operations to specific directory
|
||||
- `AUTOMAKER_MOCK_AGENT=true` - Enable mock agent mode for CI testing
|
||||
- `ENABLE_DEBUG_PANEL=true` - Enable debug panel in non-development builds
|
||||
|
||||
## Debug System (Development Only)
|
||||
|
||||
The debug system provides real-time monitoring of server performance. Toggle with `Cmd/Ctrl+Shift+D`.
|
||||
|
||||
### Debug Services (`apps/server/src/services/`)
|
||||
|
||||
- `PerformanceMonitorService` - Collects memory/CPU metrics, detects leaks via linear regression
|
||||
- `ProcessRegistryService` - Tracks spawned agents, terminals, CLIs with lifecycle events
|
||||
|
||||
### Debug API (`apps/server/src/routes/debug/`)
|
||||
|
||||
- `GET /api/debug/metrics` - Current metrics snapshot
|
||||
- `POST /api/debug/metrics/start` - Start collection with optional config
|
||||
- `POST /api/debug/metrics/stop` - Stop collection
|
||||
- `GET /api/debug/processes` - List tracked processes with filters
|
||||
|
||||
### Debug Types (`libs/types/src/debug.ts`)
|
||||
|
||||
All debug types are exported from `@automaker/types`:
|
||||
|
||||
```typescript
|
||||
import type {
|
||||
DebugMetricsSnapshot,
|
||||
TrackedProcess,
|
||||
MemoryTrend,
|
||||
ProcessSummary,
|
||||
} from '@automaker/types';
|
||||
import { formatBytes, formatDuration } from '@automaker/types';
|
||||
```
|
||||
|
||||
### UI Components (`apps/ui/src/components/debug/`)
|
||||
|
||||
- `DebugPanel` - Main draggable container with tabs
|
||||
- `MemoryMonitor` - Heap usage charts and leak indicators
|
||||
- `CPUMonitor` - CPU gauge and event loop lag display
|
||||
- `ProcessKanban` - Visual board of tracked processes
|
||||
- `RenderTracker` - React component render statistics
|
||||
|
||||
See `docs/server/debug-api.md` for full API documentation.
|
||||
|
||||
Reference in New Issue
Block a user