跳到主要内容

调试 Blocklet

blocklet debug 命令是一个供开发者使用的实用工具，用于在正在运行的 blocklet 上设置环境变量，主要用于启用详细日志记录和其他调试功能，而无需重新构建或重新部署。

该命令直接与 Blocklet Server 交互，以动态修改 blocklet 的配置。

命令用法

该命令的基本语法如下：

Basic Syntax

bash
blocklet debug <value> --appId <did>

先决条件

在使用此命令之前，请确保您的 Blocklet Server 正在运行。如果服务器未激活，该命令将失败。您可以使用以下命令启动服务器：

Start Server

bash
blocklet server start

参数和选项

  • value string (required) — 要为 DEBUG 环境变量设置的值。它也可以是用于高级操作的特殊命令或 URL。
  • --appId string (required) — 您希望调试的特定 blocklet 的去中心化标识符 (DID)。

工作原理

该命令的主要功能是为指定的 blocklet 设置一个键为 DEBUG 的配置项。许多 Node.js 库，尤其是 debug 包，使用 DEBUG 环境变量来控制哪些日志消息发送到控制台。通过设置此值，您可以启用来自 blocklet 及其依赖项的详细输出。

示例

1. 启用所有调试日志

要查看来自 blocklet 及其依赖项的所有调试消息，请使用通配符 *。

Enable all debug logs

bash
blocklet debug '*' --appId z2qa...w3k

运行此命令后，您可以查看 blocklet 的日志以查看详细输出。

2. 启用特定调试日志

要定位应用程序特定部分的日志，您可以提供更具体的命名空间。

Enable logs for API routes

bash
blocklet debug 'api:*' --appId z2qa...w3k

3. 禁用调试日志

要关闭调试日志，只需提供一个空字符串作为值即可。

Disable all debug logs

bash
blocklet debug '' --appId z2qa...w3k

高级操作

value 参数也接受特殊命令来对 blocklet 执行特定操作，这在调试会话期间可能很有用。

停止 Blocklet

要临时停止正在运行的 blocklet，请使用 `$stopBlocklet` 值。如果您需要附加调试器或进行需要重新启动的更改，这将非常有用。

设置自定义存储 URL

如果您需要 blocklet 从不同的 blocklet 存储（例如，本地开发存储）解析组件，您可以提供一个 URL 作为值。

停止 Blocklet 示例

Stop a running blocklet

bash
blocklet debug '$stopBlocklet' --appId z2qa...w3k

设置自定义存储示例

Point blocklet to a local store

bash
blocklet debug http://localhost:3030 --appId z2qa...w3k

设置自定义存储后，blocklet 将从该 URL 获取组件，使您能够测试与未发布或开发阶段组件的交互。

配置好调试后，您可能希望在 blocklet 的上下文中执行特定脚本。要了解如何操作，请继续阅读执行脚本文档。