用途
cx-create-dashboard 用于为目标服务生成并部署 Coralogix 仪表板,数据来源为该服务的日志、span、指标和服务规范。它先发现服务的遥测数据,再与用户对齐意图、起草计划、产出 JSON,通过 cx 实时验证每个查询,最后在选定的文件夹中创建仪表板。
该技能遵循一条硬性约束:只使用可通过服务代码、README、配置或返回结果的实时查询引用的指标名称、日志字段和 span 属性,不虚构它们。
主要能力
- 发现服务遥测与业务含义:阅读 README 与入口文件,搜索指标与标签、发现日志字段、发现 span 属性、识别消息总线与 DLQ、提取服务配置中的标签与环境。
- 收集仪表板规格:向用户询问受众与用途、默认时间范围、切片维度、环境范围、类 SLO 信号、优先级等(不超过 6 个问题)。
- 起草内部计划:以 Markdown 输出分区、行、列出 widget 类型与来源、顶层过滤器与假设/缺口。
- 生成 Coralogix JSON:包含 id、name、layout.sections、variables、filters、relativeTimeFrame 等字段,使用 UUID,行高默认 19,过滤器默认 equals,relativeTimeFrame 默认 172800s(48 小时)。
- 实时验证查询:所有 PromQL 与 DataPrime 查询在部署前都要通过 cx 成功运行;PromQL 需将 relativeTimeFrame 映射为 $RANGE 令牌,DataPrime 用固定短窗口(now-15m → now)验证。
- 结构自检:按查询语法与结构两套清单核对最终 JSON。
- 部署与分享:通过 cx dashboards create --from-file 部署,并构建可点击的仪表板链接。
使用方式
技能按 8 个阶段顺序执行:发现遥测与业务含义、收集仪表板规格、起草内部计划、生成 JSON、实时验证每个查询、结构自检、通过 cx dashboards create 部署、分享仪表板链接。必须先获得用户对第 3 阶段计划的批准,再进入 JSON 生成;第 5、6 阶段都通过后才能部署;第 8 阶段为强制步骤。
部署时先列出文件夹(cx dashboards folders list -o json),推荐最匹配的文件夹,若无则默认根目录;将验证后的 JSON 写入临时文件,运行 cx dashboards create --from-file /tmp/cx-dashboard-<slug>.json --folder <id>,CLI 会生成 requestId 信封并输出创建的仪表板 ID。
参考文件
技能针对不同任务加载对应参考文件:DataPrime 查询语法(references/dataprime-reference.md)、PromQL 语法与计数器/仪表/直方图(references/promql-guidelines.md)、日志字段发现与查询模式(references/logs-querying.md)、span 字段发现与延迟分析(references/spans-querying.md)、仪表板查询注意事项如 ${__range} 与 promqlQueryType(references/query-syntax.md)、widget JSON 模板(references/widget-templates.md)。此外还有验证流程(references/verification.md)与部署流程(references/deploy.md)。选择正确信号可参考 cx-telemetry-querying。
仪表板管理命令
- cx dashboards catalog -o json:列出目录中所有仪表板
- cx dashboards get <id> -o json:获取仪表板定义(可作为模板)
- cx dashboards folders list -o json:列出仪表板文件夹
- cx dashboards folders create --name "Name":创建文件夹
- cx dashboards folders create --name "Sub" --parent-id <id>:创建嵌套文件夹
复制或修改现有仪表板:cx dashboards get <dashboard-id> -o json > dashboard.json,编辑后运行 cx dashboards create --from-file dashboard.json。
适用场景
适用于需要为 Coralogix 上的某个服务快速搭建监控仪表板的场景,包括值班排障、产品/业务跟踪、容量规划、客户成功等用途。支持按指标、日志、span 不同信号组合构建,也可仅构建日志或跟踪仪表板。
限制
- 严格禁止虚构指标名称、日志字段和 span 属性,只能使用经过验证的来源。
- 每个查询必须在部署前通过 cx 实时验证;若在重试预算内仍无法通过,需将 CLI 错误原文反馈给用户,不得交付损坏的 widget。
- 当无法推导 webapp 主机(不匹配 api.<host> 约定的自定义端点)时,不得编造 URL,应省略链接。
相关技能
- cx-observability-setup:完整监控搭建流程(视图、webhook、通知、集成)
- cx-incident-management:SLO 与告警关联仪表板、事件分诊
- cx-telemetry-querying:在构建仪表板前发现正确的遥测信号