SuperAPI AI 工具集

create-dashboard

部署与运维

查看项目

更新于 10-15 23:47

技能介绍

用途:在 Kopai 可观测性平台创建仪表盘。通过编写简短 TypeScript 脚本设计 uiTree,为每个数据组件配一个类型安全的 kq 查询,再用 client.createDashboard(...) 创建;CLI 作为一次性创建的备用方式。

主要能力:数据源支持 OpenTelemetry 指标、日志、追踪。组件分为布局类(Stack、Grid、Card)、静态类(Heading、Text、Badge、Divider、Empty)与数据类(MetricStat、MetricTimeSeries、MetricHistogram、MetricTable、LogTimeline、TraceDetail)。

必要用法:安装 @kopai/sdk,脚本用 .mts 后缀并以 npx tsx 运行,以便支持顶层 await。通过 clientFromConfig() 读取 .kopairc。用 discoverMetrics() 发现指标(含 name、type、unit 等),据其 type 调用 kq.metrics("<Type>")。数据组件必须使用 raw 查询并用 dataSource: { method: "query", params: <builtQuery> } 嵌入。每个组件声明的 prop 都要写全,未用到的设 null,否则创建能过但渲染会报错。查询需带时间窗口(.timeRelative("1h") 或 .timeAbsolute(startISO, endISO))。uiTreeVersion 当前为 0.14.0。创建后以 <baseUrl>/?tab=metrics&dashboardId=<dash.id> 查看。

限制:KopaiValidationError 时需重新 discoverMetrics() 核对名称与类型。时序/直方图需设 height(如 300),LogTimeline 建议 600。CLI 无法构建 kq 查询,只能用旧式 searchMetricsPage/searchLogsPage 形式。其余细节暂未提供。