Owl CLI 工具清单¶

本文档介绍当前 Owl CLI 可直接执行的业务工具能力，包含工具范围、权限类型、CLI 使用约定、工具总览以及按分类整理的工具说明。

工具的可见范围和执行结果取决于当前 OWL_TOKEN 对应 API Key 的权限。如果 API Key 不具备相应资源或操作权限，对应工具可能执行失败或返回空结果。

工具范围¶

Owl CLI 暴露的工具会随着平台能力持续更新。实际可见工具以本地完成 owl sync 后，通过 owl list 返回的工具目录为准。

当前文档覆盖以下业务分类：

权限类型¶

CLI 使用约定¶

常用 CLI 命令示例：

owl sync
owl list
owl list -c data
owl show owl.data.query
owl exec owl.metric.list --mode source
owl exec owl.event.list --start_time 1712505600000 --end_time 1712592000000 --limit 20

工具总览¶

Catalog¶

用于统一资源目录的实体类型发现、实体查询、实体详情获取和拓扑关系查询。

Dashboard¶

用于仪表板的创建、替换和详情获取。

Data¶

用于完整数据查询与查询辅助，覆盖日志、指标、RUM、APM、Network、Profile、Billing 等数据域。

Errors¶

用于错误中心的问题列表查询，以及评论的新增、查询和更新。

Event¶

用于事件中心列表查询和事件详情获取。

Incident¶

用于故障列表、故障评论、操作记录和值班排班查询。

Infrastructure¶

用于基础设施对象列表和详情查询，覆盖主机、容器、进程等资源对象。

LLM¶

用于 LLM 可观测应用列表查询。

Member¶

用于空间成员列表查询和按姓名、邮箱关键字检索。

Monitor¶

用于监控器列表查询、详情获取、创建或更新，以及外部事件接收。

Pipeline¶

用于 Pipeline 列表查询和样例验证。

CLI 使用路径¶

数据查询类问题¶

适用于“查询指标、日志、RUM、APM、Network、Profile、Billing 数据”等问题。

1. 先执行 owl.data.show_dql_namespace 确认目标 namespace；

2. 按数据域调用发现类工具：

   • 指标：owl.metric.list
   • RUM：owl.rum.list
   • APM：owl.apm.list
   • Network：owl.network.list
   • Profile：owl.profile.list
   • Logging：owl.logging.list
   • Billing：owl.billing.list
   • 日志索引：owl.log_index.list
   • 字段目录：owl.field_schema.get

3. 需要确认 DQL 语法时，先调用 owl.data.search_dql_docs 查文档。；

4. 手写完整 DQL 后，先调用 owl.data.check_dql 做本地校验；
5. 最后调用 owl.data.query 执行正式查询。

Profiling 分析类问题¶

适用于“已拿到 profile_id，希望查看摘要或解析详细栈信息”等问题。

1. 先通过 owl.data.query 在 Profiling 数据域中定位目标 profile_id；
2. 调用 owl.profiling.get_summary 获取摘要信息；
3. 复用摘要结果中的 language、type、profile_start、profile_end，再调用 owl.profiling.parse 解析详细内容。

故障排查类问题¶

适用于“查询故障单、追踪处理过程、补充评论”等问题。

1. 先调用 owl.incident.list 查询故障单；

2. 基于 incident_uuid 继续调用：

   • owl.incident_comment.list 查看评论
   • owl.incident_operation.list 查看操作记录
   • 需要补充处理进展时，调用 owl.incident_comment.add。

仪表板管理类问题¶

适用于“创建仪表板、替换仪表板内容、查看已有仪表板配置”等问题。

1. 创建新仪表板时调用 owl.dashboard.create；
2. 替换已有仪表板时调用 owl.dashboard.replace；
3. 需要查看当前配置时调用 owl.dashboard.get。

监控器管理类问题¶

适用于“查看监控器、创建监控器、更新监控器、发送测试事件”等问题。

1. 先调用 owl.monitor.list 浏览目标监控器；
2. 需要详情时调用 owl.monitor.get；
3. 创建或更新时调用 owl.monitor.upsert；
4. 需要发送外部事件验证接收链路时调用 owl.monitor.receive。