Introduction¶
DeepSeek Harness (DSH) uses a plugin-based architecture. When developing governance suites, tracking the execution status of plugins is critical for troubleshooting. dsh-observability is designed to solve the problem of governance plugin logs being scattered and difficult to review in a unified way. It provides a shared diagnostic logging solution for the Claw suite and integrates a runtime diagnostics feature into the Web settings page, making it easier for developers to quickly identify execution flows.
Plugin Positioning¶
This plugin is maintained by xingyingyuzhui and belongs to the admin-security category. It does not directly run agents; instead, it serves as a set of infrastructure that other plugins can call to record operation final states.
Core Features¶
- Shared Diagnostic Logs: Plugins in the governance suite record logs through a unified interface.
- Visualized Diagnostics Page: Provides a “Runtime Diagnostics” page in the Web settings interface.
- Timeline Query: Supports viewing timeline views of events by error code or
traceId.
Installation and Activation¶
Run the following command to install the plugin:
dsh plugin --profile web add github:xingyingyuzhui/dsh-observability
After installation is complete, restart dsh web. After startup, go to the settings page; you can find the “Runtime Diagnostics” entry near “Audit.”
Typical Usage¶
- Write Logs: Other governance plugins write logs via
../dsh-observability/observe.mjsin the adjacent directory. - Build Client: After modifying the Client source code, run
npm run buildto generate the client files. - View Logs: Diagnostic logs are stored by default at
$DSH_HOME/agent-observe/diag.l. If writing fails, the system falls back to logging tostderr.
Applicable Scenarios and Caveats¶
- Logging Granularity: The plugin only records operation final states (
succeeded/rejected/failed/degraded) and does not record the detailed process of internal function calls. - Privacy Protection: Log fields use a whitelist mechanism and do not record sensitive information such as prompts, memory/identity content, tool parameters, or tokens.
- Permissions and Auditing: This plugin runs with the permissions of the current DSH process. Security audit functionality remains independently handled by
dsh-agent-gate; audit logs are written toagent-gate/audit.l, separate from diagnostic logs.
Summary¶
dsh-observability provides a standardized diagnostics entry point for the governance suite of DeepSeek Harness. With unified log recording and visualized timeline viewing, developers can track and locate issues more efficiently. The plugin is open source under the MIT license.