cx-search-dashboard
coralogix/cx-cli
Search and discover existing Coralogix dashboards and widgets by description or field reference.
What is cx-search-dashboard?
This skill lets you find existing Coralogix dashboards and widgets using natural-language search or by field path. Use it before creating new dashboards to avoid duplication and to discover reusable query patterns already in your monitoring setup.
- Search dashboards by natural-language description (e.g., 'payment service error rate')
- Find widgets whose queries match a topic or description
- Locate all widgets that reference a specific field path
- Browse and inspect the full JSON definition of any dashboard
- Discover reusable PromQL and DataPrime query patterns already in use
How to install cx-search-dashboard
npx skills add https://github.com/coralogix/cx-cli --skill cx-search-dashboard- Coralogix CLI (`cx`) installed and authenticated
- Access to your Coralogix account and dashboards
How to use cx-search-dashboard
- 1.Run `cx dashboards search "<description>"` with a natural-language phrase (e.g., 'kubernetes node cpu') to find relevant dashboards
- 2.Use `cx dashboards query-search --description "<text>"` to find widgets whose queries cover a specific topic
- 3.Use `cx dashboards query-search --field "<field-path>"` to locate all widgets referencing a field (e.g., '$d.http.status_code')
- 4.Run `cx dashboards get <dashboard-id> -o json` to inspect the full definition of a dashboard you found
- 5.Append `-o json` or `-o toon` to any search command for machine-readable output suitable for scripting
Use cases
- Check whether a monitoring dashboard for a service or topic already exists before building a new one
- Find widgets querying HTTP error rates, latency, or other metrics to reuse their query logic
- Discover all places a specific field (e.g., 'http.status_code') is being queried across dashboards
- Inspect a found dashboard's JSON structure to clone and customize it
- Identify common query patterns for a field to maintain consistency across monitoring
- DevOps engineers and SREs managing Coralogix monitoring
- Platform teams standardizing dashboard and query patterns
- Anyone building new dashboards who wants to avoid duplication
cx-search-dashboard FAQ
Yes. Always run `cx dashboards search` first to check if a dashboard for your topic already exists and avoid duplication.
Use `cx dashboards query-search --field "<field-path>"` (e.g., `--field '$d.http.status_code'`). This shows all widgets querying that field and reveals reusable query patterns.
Description search is fuzzy and ranked by similarity. Try rephrasing your search with different keywords or use `cx dashboards catalog` to browse all dashboards.
Yes. Run `cx dashboards get <dashboard-id> -o json > dashboard.json`, edit the JSON, then use `cx dashboards create --from-file dashboard.json` to create a copy.
Append `-o json` for machine-readable JSON or `-o toon` for formatted text output. Default is human-readable text.
Full instructions (SKILL.md)
Source of truth, from coralogix/cx-cli.
name: cx-search-dashboard description: This skill should be used when the user asks to "find a dashboard", "search dashboards", "does a dashboard exist for X", "find widgets that query Y", "which dashboards use this field", "find a dashboard about errors", "look up dashboards by description", "search for existing monitoring dashboards", "find widgets that reference a field", or wants to discover existing Coralogix dashboards or widgets using natural-language or field-based search. metadata: version: "0.1.0"
Dashboard Search Skill
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.
CLI Commands
| Command | Purpose | Key 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 toon for machine-readable output.
When to Use Each Command
| Goal | Command |
|---|---|
| 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 |
Examples
Find a dashboard for a service
cx dashboards search "payment service error rate"
cx dashboards search "kubernetes node cpu"
Find widgets whose queries cover a topic
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
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.
Inspect and clone a found dashboard
# Get full JSON of a dashboard you found
cx dashboards get <dashboard-id> -o json > dashboard.json
# Modify it, then create a copy
cx dashboards create --from-file dashboard.json
Key Principles
- Search before creating — always run
cx dashboards searchbefore building a new dashboard to avoid duplicates - Use field search for discovery —
cx dashboards query-search --fieldshows 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 getto inspect — once you find a relevant dashboard or widget, pull its full JSON to study the query structure
Related Skills
cx-dashboards— build and deploy a new Coralogix dashboard from scratchcx-telemetry-querying— discover what telemetry fields and metrics exist before searching dashboards
Related skills
More from coralogix/cx-cli and the wider catalog.
cx-service-catalog
Query Coralogix Service Catalog to discover and analyze APM entities—services, databases, operations, pods, and JVMs.
cx-slos
Manage Coralogix SLO definitions—list, inspect health, and create/update/delete objectives.
cx-telemetry-querying
Query telemetry data across logs, metrics, traces, RUM, and APM to investigate issues and debug problems.
coralogix-docs
Search and read official Coralogix platform documentation with cx docs search and fetch.
ab-test-setup
Design and run statistically valid A/B tests and build a continuous experimentation program.
ab-testing
Design and run statistically valid A/B tests and build a continuous experimentation program.