consumer 命令

目录

  1. 简介
  2. 命令格式
  3. 子命令
  4. create 参数
  5. drain 参数
  6. 示例
  7. 版本历史
  8. 相关命令

简介

consumer 命令用于管理结果消费者:为 jobprobetarget 建立有界缓冲区,让 CLI、TUI、MCP 或 API 客户端按需读取诊断事件流。

通过 createdrainstatusclose 等子命令可以解耦观测产生侧与读取侧:观测命令把事件写入消费者缓冲,客户端按节奏拉取并处理,避免阻塞 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 命令组

相关命令

  • client - 管理客户端会话
  • job - 管理命令任务
  • probe - 管理探针运行

回到顶部

Copyright © 2026 Peeka contributors. Distributed under the Apache License 2.0.

This site uses Just the Docs, a documentation theme for Jekyll.