关于 cx-cases
cx-cases 是用于检查和管理 Coralogix case 的命令行技能,涵盖调查记录、分配、优先级、通知及受控的生命周期变更。
主要功能
- 01查看 case 及事件时间线
- 02分配、确认、解决和关闭 case
- 03添加评论并更新 case 信息
- 04管理优先级并查看通知
适用场景
- 01分诊归并到 case 的告警事件
- 02为团队记录调查发现
- 03检查 case 状态变更和通知
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ coralogix/ cx-cli --skill cx-cases安装后在 Claude Code 中输入/cx-cases确认已加载。
附带文件references/case-analytics.mdreferences/single-case.md
详细介绍
案例管理技能
案例 会将相关告警事件归为一个调查单元,并包含状态、优先级、类别和负责人。使用此技能检查案例,并推动案例完成其生命周期(active → acknowledged → resolved → closed)。
CLI 命令
| 命令 | 用途 |
|---|---|
cx cases get <id> | 按 ID 获取单个案例 |
cx cases update <id> [--title] [--resolution-reason] | 更新可修改字段 |
cx cases comment <id> --text <text> | 在案例时间线上添加评论 |
cx cases assign <id> --user <email> | 分配案例(邮箱或原始用户 ID) |
cx cases unassign <id> | 移除负责人 |
cx cases acknowledge <id> | 确认案例(表示你正在处理;停止再次通知) |
cx cases unacknowledge <id> | 撤销确认 |
cx cases resolve <id> --reason <text> | 解决案例(不可逆——见下文) |
cx cases close <id> | 关闭案例(终态) |
cx cases set-priority <id> --priority <P1..P5> | 覆盖计算得出的优先级 |
cx cases clear-priority <id> | 移除优先级覆盖 |
cx cases events list <case-id> | 查看事件时间线(状态变更、评论、分配) |
cx cases events get <event-id> | 查看单个事件——深入查看,例如展开评论串 |
cx cases notifications <case-id> [<case-id> ...] | 查看通知送达记录(连接器、状态、时间) |
案例生命周期
PENDING_ACTIVATION ──► ACTIVE ◄────────► ACKNOWLEDGED
│ ╲ │ ╲
│ ╲ │ ╲
▼ ╲ ▼ ╲
CLOSED ╲──► RESOLVED ◄─── (from ACK)
│
▼
CLOSED (terminal)
| 起始状态 | 允许的转换 | 备注 |
|---|---|---|
PENDING_ACTIVATION | → ACTIVE | 由系统驱动激活;用户无法控制 |
ACTIVE | → ACKNOWLEDGED、RESOLVED、CLOSED | 确认是可选的;对于误报,可直接 close(跳过 resolve) |
ACKNOWLEDGED | → ACTIVE、RESOLVED、CLOSED | 唯一的“回退”转换:unacknowledge 会将其恢复为 ACTIVE |
RESOLVED | 只能 → CLOSED | 不可逆——无法重新打开为 ACTIVE/ACKNOWLEDGED |
CLOSED | (无) | 终态 |
类别:AVAILABILITY 或 SECURITY。优先级:P1(最高)→ P5。
分诊工作流
- 检查 —
cx cases get <id>。负载包含groupings、labels、impactedEntities、kpiBreaches、aiSummary,以及priorityDetails.system(计算所得)和priorityDetails.override(用户设置)。 - 调查 — 查询告警的 DataPrime / PromQL,提取底层遥测数据,以便在采取行动前找出根本原因。
也可以通过
cx olly导出调查结果,或提取案例的impactedEntities/groupings以确认影响范围。 请参阅cx-telemetry-querying技能。 - 认领 — 执行
cx cases assign <id> --user [email protected],然后执行cx cases acknowledge <id>。 - 记录调查结果 — 执行
cx cases comment <id> --text "<note>",在调查过程中将调查记录(根本原因、链接、后续步骤)添加到时间线上。 评论会作为comment事件显示在cx cases events list中。 - 解决或关闭 — 见下文。
- 重新设置优先级(如果影响范围与计算值不符)—
使用
cx cases set-priority <id> --priority P1/clear-priority。仅当案例仍处于打开状态时才能执行; 案例变为RESOLVED或CLOSED后,无法再覆盖优先级。
解决案例
解决操作不可逆(RESOLVED 案例只能转为 CLOSED),因此 CLI 要求同时提供原因并进行确认:
- 传入
--reason "<text>"——一行事后总结(根本原因、修复方法、后续跟进),团队成员可在时间线上查看。仅当确实不适用原因时才使用--no-reason。 - 在 Agent/非交互模式下,还必须传入
--yes;若不提供此参数,命令会拒绝执行,并须交由用户在交互模式下运行。
如果不确定,请保持在 ACKNOWLEDGED 状态(可通过 unacknowledge 撤销),直到确认无误。对于非解决类编辑(标题、事后添加的总结链接),请使用
cx cases update。
批量操作
没有批量端点。若要处理多个案例,可通过循环传递 ID,例如:
... | jq -r '.[].id' | xargs -I {} cx cases acknowledge {}。
核心原则
- 使用电子邮件地址,绝不使用用户 ID — 用于
assign --user和所有输出。 resolve不可撤销,close是终态 — 执行解决前请确认;对于误报,可直接从ACTIVE状态执行close。- 除非确实适用
--no-reason,否则务必提供解决原因。 P1这类简写可用于任何需要优先级/状态/类别的地方。- 使用
-p <profile>(可重复)进行多配置文件扇出,以便跨环境分流处理。 - 链接到特定案例 — 构建
<base>/cases?id=<case_id>,其中<base>是本次会话中任何cx cases命令打印的 `View in Coralogix: /...` 行里已经出现的控制台 URL;切勿自行编造 ``。
参考资料
相关技能
cx-alerts— 事件分组到案例背后的告警定义。cx-slos— 其违规情况会触发可靠性案例的 SLO 定义。cx-telemetry-querying— 从案例中受影响的实体切换到日志/追踪/指标。
评论
支持 Markdown