cx-search-dashboard

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Dashboard Search Skill

Dashboard搜索技能

Use this skill to discover existing Coralogix dashboards and widgets using semantic or field-based search via the
cx dashboards
CLI commands. Before creating a new dashboard, always search first to avoid duplication.
使用本Skill通过
cx dashboards
CLI命令,以语义搜索或基于字段的搜索方式发现现有Coralogix仪表盘和widget。创建新仪表盘前,请务必先进行搜索以避免重复。

CLI Commands

CLI命令

CommandPurposeKey flags
cx dashboards search "<description>"
Find dashboards by natural-language description
--limit
cx dashboards query-search --description "<text>"
Find widgets whose queries match a description
--limit
cx dashboards query-search --field "<field-path>"
Find all widgets that reference a specific field
--limit
cx dashboards catalog -o json
List all dashboards-
cx dashboards get <id> -o json
Get full dashboard definition-
Output format: append
-o json
or
-o agents
for machine-readable output.
命令用途关键参数
cx dashboards search "<description>"
通过自然语言描述查找仪表盘
--limit
cx dashboards query-search --description "<text>"
查找查询语句匹配指定描述的widget
--limit
cx dashboards query-search --field "<field-path>"
查找所有引用特定字段的widget
--limit
cx dashboards catalog -o json
列出所有仪表盘-
cx dashboards get <id> -o json
获取完整的仪表盘定义-
输出格式: 添加
-o json
-o agents
可获得机器可读的输出。

When to Use Each Command

各命令的适用场景

GoalCommand
Check if a dashboard for a service or topic already exists
cx dashboards search
Find widgets whose queries cover a topic you care about
cx dashboards query-search --description
Find widgets whose queries reference a specific field path
cx dashboards query-search --field
Browse all dashboards
cx dashboards catalog
目标命令
检查是否已存在针对某服务或主题的仪表盘
cx dashboards search
查找查询语句涵盖你关注主题的widget
cx dashboards query-search --description
查找查询语句引用特定字段路径的widget
cx dashboards query-search --field
浏览所有仪表盘
cx dashboards catalog

Examples

示例

Find a dashboard for a service

查找某服务的仪表盘

bash
cx dashboards search "payment service error rate"
cx dashboards search "kubernetes node cpu"
bash
cx dashboards search "payment service error rate"
cx dashboards search "kubernetes node cpu"

Find widgets whose queries cover a topic

查找查询语句涵盖某主题的widget

bash
cx dashboards query-search --description "http 5xx error rate"
cx dashboards query-search --description "p99 latency over time"
bash
cx dashboards query-search --description "http 5xx error rate"
cx dashboards query-search --description "p99 latency over time"

Find all widgets that reference a field

查找所有引用某字段的widget

bash
cx dashboards query-search --field '$d.http.status_code'
cx dashboards query-search --field '$d.kubernetes.pod.name'
This reveals query patterns already in use — useful for reusing existing approaches when adding new widgets.
bash
cx dashboards query-search --field '$d.http.status_code'
cx dashboards query-search --field '$d.kubernetes.pod.name'
这可以揭示已在使用的查询模式——在添加新widget时,有助于复用现有方案。

Inspect and clone a found dashboard

查看并克隆找到的仪表盘

bash
undefined
bash
undefined

Get full JSON of a dashboard you found

获取找到的仪表盘完整JSON

cx dashboards get <dashboard-id> -o json > dashboard.json
cx dashboards get <dashboard-id> -o json > dashboard.json

Modify it, then create a copy

修改后创建副本

cx dashboards create --from-file dashboard.json
undefined
cx dashboards create --from-file dashboard.json
undefined

Key Principles

核心原则

  • Search before creating — always run
    cx dashboards search
    before building a new dashboard to avoid duplicates
  • Use field search for discovery
    cx dashboards query-search --field
    shows how a field is already being queried, which is the fastest way to find reusable PromQL or DataPrime patterns
  • Description search is fuzzy — the results are ranked by similarity, not exact match; try several phrasings if the first search returns nothing useful
  • Use
    cx dashboards get
    to inspect
    — once you find a relevant dashboard or widget, pull its full JSON to study the query structure
  • 创建前先搜索——在构建新仪表盘前,务必运行
    cx dashboards search
    以避免重复
  • 使用字段搜索进行发现——
    cx dashboards query-search --field
    可展示字段的现有查询方式,这是查找可复用PromQL或DataPrime模式的最快途径
  • 描述搜索为模糊匹配——结果按相似度排序,而非精确匹配;若首次搜索无有效结果,可尝试多种表述
  • 使用
    cx dashboards get
    查看详情
    ——找到相关仪表盘或widget后,获取其完整JSON以研究查询结构

Related Skills

相关技能

  • cx-create-dashboard
    — build and deploy a new Coralogix dashboard from scratch
  • cx-telemetry-querying
    — discover what telemetry fields and metrics exist before searching dashboards
  • cx-create-dashboard
    ——从头构建并部署新的Coralogix仪表盘
  • cx-telemetry-querying
    ——在搜索仪表盘前,先发现存在哪些遥测字段和指标