SuperAPI AI 工具集

datadog-design-dashboard

部署与运维

查看项目

更新于 10-16 02:24

技能介绍

用途

该技能用于 Datadog 仪表盘的设计、重构与审计。它帮助用户构建一个能讲清故事的仪表盘布局:从高层健康信号逐层下钻到细粒度诊断,并使用合适的组件类型、分组组织和模板变量实现复用。

技能明确要求:在创建新仪表盘前,先用 pup dashboards list --agent 检查是否已存在同类仪表盘。若同一服务或用途已有仪表盘,应更新现有仪表盘而非新建;只有在没有相关仪表盘或用户明确要求新建时才创建。

主要能力

  • 设计模式:通过访谈确定仪表盘用途、目标受众、数据来源、范围与仪表盘策略,然后执行完整设计流程。
  • 审计模式:对现有仪表盘进行审查,不涉及重新设计。
  • 领域发现:在设计前理解产品与业务背景,确保所选指标真正反映客户可见的结果,而非仅套用通用 RED/USE 信号。
  • 框架选择:根据用途匹配框架,如服务概览用 RED(Rate、Errors、Duration),基础设施用 USE(Utilization、Saturation、Errors),高管/业务用 Golden Signals,SLO 跟踪用 SLI/SLO,调试用 Drill-down。
  • 布局设计:设计分组结构与组件选择,参考 layouts.md、widgets.md、thresholds.md 等资料。
  • 标签页评估:当仪表盘有 7 个以上顶层分组时,评估是否使用标签页以减少滚动疲劳。
  • 审计检查:包括告警阈值审计、阈值接近度审计、业务分组审计、零知识可读性测试、标签页组织审计,并生成结构化审计报告。

使用方式

技能通过一系列 pup 命令与 Datadog 交互,例如:

pup dashboards list --agent
pup dashboards get <dashboard-id> --agent
pup metrics list --filter="<service-name>.*" --agent
pup metrics list --filter="trace.*" --tag-filter="service:<service-name>" --agent

设计流程包括:收集现有上下文、探索可用遥测数据、选择框架、设计布局、考虑标签页、输出设计文档。审计流程包括:获取仪表盘、建立组件清单、审计告警阈值、审计阈值接近度、审计业务分组、应用零知识查看者测试、审计标签页组织、生成审计报告。

设计输出使用固定模板,包含用途、模板变量表、各分组的组件表(组件、类型、查询/指标、宽度、告警阈值)。审计报告包含摘要、关键问题、各项审计结果以及按必须修复/应该修复/锦上添花分类的建议操作。

适用场景

  • 为某个服务或基础设施新建 Datadog 仪表盘。
  • 重新设计现有仪表盘以提升可读性与可操作性。
  • 审计现有仪表盘是否达到生产就绪标准。
  • 检查告警阈值是否合理、是否接近正常流量。
  • 确认仪表盘是否包含面向业务的客户可见指标分组。
  • 评估是否需要使用标签页组织大量分组。

限制

  • 技能中的框架、布局和组件指南是起点而非硬性规则,需结合具体产品与业务调整。
  • 设计业务分组前,必须能说出至少 3 个该服务特有的领域结果(用产品经理能理解的语言),否则需先询问用户。
  • 组件查询必须使用通过 pup metrics list --agent 验证过的真实指标名称与标签值,不得猜测或编造。
  • 若预期指标未出现,需在围绕其构建组件前向用户标记。
  • 向现有仪表盘添加标签页前,需审计所有组件 ID 是否重复,因为标签页会触发严格的唯一性校验。
  • 审计原则是指导性的,需根据产品与业务背景判断,而非机械套用清单。
  • 关于该技能的具体收费、价格、平台支持范围等信息,资料中暂未提供。