consumer コマンド
目次
- 概要
- 構文
- サブコマンド
- create オプション
- drain オプション
- 例
- バージョン履歴
- 関連コマンド
概要
consumer コマンドは 結果コンシューマを管理 します：job、probe、target 向けに有界バッファを用意し、CLI、TUI、MCP、API クライアントが自分のペースで診断イベントストリームを取り出せるようにします。
create、drain、status、close などのサブコマンドを使うことで、生産側（バッファに書き込む観測コマンド）と消費側（自分のペースで読み出すクライアント）を分離でき、target をブロックすることなく、未消費のイベントを失うこともありません。
構文
peeka-cli consumer <subcommand> [options]
サブコマンド
| サブコマンド |
説明 |
create |
結果コンシューマを作成 |
list |
結果コンシューマを一覧表示 |
status --consumer <id> |
コンシューマ状態を表示 |
drain --consumer <id> |
バッファ済みレコードを読み取る |
close --consumer <id> |
コンシューマを閉じる |
cleanup |
closed または failed コンシューマを削除 |
create オプション
| オプション |
説明 |
--target <id> |
所有 target |
--source cli/tui/mcp/api/internal |
リクエスト元 |
--scope-type job/probe/target |
読み取るスコープ種別 |
--scope-id <id> |
job、probe、target ID |
--client <id> |
任意の所有クライアント |
--max-buffer-size <n> |
最大バッファレコード数。デフォルトは 1000 |
--backpressure-policy drop_oldest/drop_newest/fail |
バッファ満杯時のポリシー。デフォルトは drop_oldest |
drain オプション
| オプション |
説明 |
--limit <n> |
返す最大レコード数。デフォルトは 100 |
--after-sequence <n> |
この sequence より大きいレコードだけ返す |
--timeout-ms <n> |
新しいレコードを待つ最大ミリ秒。デフォルトは 0 |
すべてのサブコマンドは --format table または --format json をサポートします。
例
peeka-cli consumer create \
--target target_abcd1234 \
--source cli \
--scope-type probe \
--scope-id probe_123 \
--format json
peeka-cli consumer drain --consumer consumer_123 --limit 50 --format json
peeka-cli consumer close --consumer consumer_123
peeka-cli consumer cleanup --target target_abcd1234
バージョン履歴
| バージョン |
リリース日 |
変更 |
| 0.1.16 |
2026-06-07 |
consumer コマンドグループを追加 |
関連コマンド