メインコンテンツへスキップ

Blockletのデバッグ

blocklet debugコマンドは、開発者が実行中の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のコンテキスト内で特定のスクリプトを実行したい場合があります。その方法については、スクリプトの実行のドキュメントに進んでください。