Preface¶
DeepSeek Harness (DSH) is the infrastructure for agent development and execution. When the host machine experiences out-of-memory conditions, high CPU usage, or abnormal process behavior, direct troubleshooting is often inefficient. The dsh-status-plugin plugin provides runtime health monitoring at the host level. Through HTTP endpoints and bidirectional feedback in the Web UI, it helps developers quickly locate failures.
Plugin Overview¶
The plugin is maintained by developer woshi-Tom and uses the MIT License. It is a standalone client plugin that provides both a Host Plane (server-side monitoring) and a Client Plane (frontend display). It aims to reduce DSH runtime troubleshooting costs through standardized data interfaces and visualized interfaces.
Core Features¶
The core capabilities of the plugin are divided into three parts: monitoring collection, data display, and real-time feedback:
-
Host Plane (Monitoring Collection Layer)
Exposes the host runtime state as JSON through HTTP endpoints. The monitored metrics include process status, listener status, API Key configuration status, memory usage, uptime, and the currently loaded plugin list. -
Client Plane (Data Display Layer)
Provides a Header badge in the Web UI, which can be clicked to expand a details panel. The panel displays uptime and triggers a Toast alert when the host reports overload or memory pressure. Additionally, the plugin provides a settings page that allows dynamically adjusting alert thresholds at runtime. -
Real-Time Feedback (Server-Sent Events)
Supports the Server-Sent Events (SSE) protocol and pushes real-time alerts and status snapshots to open browser streams, ensuring the timeliness of monitoring data.
Installation and Activation¶
The installation process is handled automatically by the CLI, with no manual configuration of bundles or overlays required.
- Execute the installation command:
dsh plugin --profile web add dsh-status-plugin
- Stop the currently running process and restart Harness to load the plugin:
dsh web
- Verify that the plugin is loaded correctly:
dsh --profile web --dump-config
Typical Usage¶
After installation and startup, you can access the Web UI through a browser or directly call the host API endpoints.
-
Access a status snapshot
Retrieve the current host status JSON snapshot viaGET /api/status. -
View monitoring metrics
The response data includes fields such ashost(host information),webServer(server-side listening configuration),apiKey(key configuration status), andplugins(plugin list). -
Configure network exposure
By default, thelanAddressesfield is an empty array. To include LAN IPv4 addresses in the snapshot, setexposeLanAddresses: truein the configuration. -
Dynamic settings
In version 0.4.0 and later, the plugin registers thedsh-statussettings namespace. In the Web UI settings panel, fields under thedsh-statusnamespace can be edited directly, and changes take effect without restarting Harness.
Notes¶
- API Key Security: The plugin only checks whether an API Key is configured and its source; it never leaks the Key’s value in the response.
- Automatic Coordination: The CLI automatically coordinates bundles, so users do not need to write bundle or overlay configuration files manually.
- Privacy Protection: For security reasons,
lanAddressesis disabled by default. Enable it only when needed. - Use Cases: Suitable for scenarios requiring real-time health checks, fault alerts, or resource monitoring for DSH hosts.
Conclusion¶
By decoupling monitoring collection from display, dsh-status-plugin provides a lightweight operational view for DSH. When encountering performance bottlenecks or failures, developers can quickly obtain a full picture of the system through standardized JSON interfaces. For more configuration options and source code, refer to the plugin directory or the GitHub repository.