跳到主要內容

對 Blocklet 進行偵錯

blocklet debug 命令是一個開發者工具,用於在執行中的 Blocklet 上設定環境變數,主要目的是啟用詳細的日誌記錄和其他偵錯功能,而無需重新建置或重新部署。

此命令直接與 Blocklet Server 互動,以動態修改 Blocklet 的設定。

命令用法

該命令的基本語法如下:

基本語法

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

先決條件

在使用此命令之前,請確保您的 Blocklet Server 正在執行中。如果伺服器未啟用,該命令將會失敗。您可以使用以下命令啟動伺服器:

啟動伺服器

bash
blocklet server start

參數與選項

  • value string (required) — 要為 DEBUG 環境變數設定的值。它也可以是一個特殊命令或用於進階操作的 URL。
  • --appId string (required) — 您希望偵錯的特定 Blocklet 的去中心化識別碼 (DID)。

運作原理

此命令的主要功能是為指定的 Blocklet 設定一個鍵為 DEBUG 的設定項目。許多 Node.js 函式庫,尤其是 debug 套件,會使用 DEBUG 環境變數來控制哪些日誌訊息被傳送到主控台。透過設定此值,您可以啟用來自您的 Blocklet 及其相依套件的詳細輸出。

範例

1. 啟用所有偵錯日誌

要查看來自 Blocklet 及其相依套件的所有偵錯訊息,請使用萬用字元 *

啟用所有偵錯日誌

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

執行此命令後,您可以查看 Blocklet 的日誌以檢視詳細輸出。

2. 啟用特定偵錯日誌

要針對應用程式特定部分的日誌,您可以提供一個更具體的命名空間。

啟用 API 路由的日誌

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

3. 停用偵錯日誌

要關閉偵錯日誌,只需提供一個空字串作為值即可。

停用所有偵錯日誌

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

進階操作

value 參數也接受特殊命令來對 Blocklet 執行特定操作,這在偵錯過程中可能很有用。

停止 Blocklet

要暫時停止正在執行的 Blocklet,請使用 `$stopBlocklet` 值。如果您需要附加偵錯器或進行需要重新啟動的變更,這會很有用。

設定自訂商店 URL

如果您需要 Blocklet 從不同的 Blocklet 商店(例如,本地開發商店)解析元件,您可以提供一個 URL 作為值。

停止 Blocklet 範例

停止正在執行的 Blocklet

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

設定自訂商店範例

將 Blocklet 指向本地商店

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

設定自訂商店後,Blocklet 將從該 URL 取得元件,讓您可以測試與未發布或開發階段元件的互動。

設定好偵錯後,您可能希望在 Blocklet 的上下文中執行特定腳本。要了解如何操作,請繼續閱讀 執行腳本 文件。