coralogix-docs
Search and read official Coralogix platform documentation using **`cx docs search`** and **`cx docs fetch`**. Use when the user asks how Coralogix features work, how to configure or use the UI, set up integrations (OpenTelemetry, agents, collectors, webhooks), manage API keys, explore spans/traces/logs in the product, configure alerts/SLOs/dashboards, or needs authoritative product docs — not live tenant telemetry.
Resumen
Coralogix docs (cx docs search, cx docs fetch)
These commands read official Coralogix product documentation from coralogix.com/docs. They answer how the platform works and how to configure or use it. They do not query your tenant's logs, spans, metrics, or alerts.
No Coralogix API key is required.
CLI commands
| Command | Purpose |
|---|---|
cx docs search <query> | Find doc pages by keyword. Returns numbered titles + path suffixes. |
cx docs fetch <suffix> | Download one page as markdown. Pass the suffix from search. |
Flags
| Flag | Commands | Description |
|---|---|---|
--limit | search | Max results, 1–20 (default 5) |
-o json / -o toon | both | Machine-readable output |
Examples
cx docs search "explore spans" --limit 5
cx docs search "OpenTelemetry traces"
cx docs fetch user-guides/data_exploration/spans/
cx docs search "API keys" -o jsonWhen to use these commands
Use cx docs search + cx docs fetch when the user wants:
| Topic | Example questions |
|---|---|
| UI / workflows | "How do I view spans in Coralogix?", "Where is Explore spans?" |
| Ingestion & integrations | OpenTelemetry setup, agent/collector config, Send Your Data API keys |
| Platform features | Alerts, SLOs, dashboards, enrichments, parsing rules, retention |
| Concepts & architecture | How tracing works, trace-log correlation, data model |
| Account & access | API keys, SSO, roles, regions |
Prefer these commands over guessing when the answer depends on current Coralogix product behavior or UI navigation.
When not to use these commands
| User need | Use instead |
|---|---|
| Query live logs | cx logs — cx-telemetry-querying |
| Query live spans/traces | cx spans — cx-telemetry-querying |
| DataPrime syntax / commands | cx dataprime list / cx dataprime show — cx-telemetry-querying |
| Alerts & cases in the tenant | cx alerts, cx cases — cx-alerts, cx-cases |
| Metrics (PromQL) | cx metrics — cx-telemetry-querying |
| Discover field paths in tenant data | cx search-fields |
Standard workflow
cx docs searchwith a focused query (2–4 keywords, not full sentences).- Pick the most relevant suffix from the results.
cx docs fetchon that suffix.- Answer from the fetched content. Fetch additional pages only when needed.
User: "How do I show spans in the Coralogix website?"
1. cx docs search "explore spans" --limit 5
2. cx docs fetch user-guides/data_exploration/spans/
3. Summarize: Explore → spans dataset → Spans/Traces/Flows tabs → drilldownTips
cx docs search
- Start with 2–4 focused terms, not full sentences.
- If no matches, try synonyms or broader terms (
"tracing"instead of"distributed trace waterfall view"). - Increase
--limitwhen the first page of hits is ambiguous. - Results use path suffixes under
/docs/(not full URLs) — pass them directly tocx docs fetch.
cx docs fetch
- Pass the suffix from
cx docs search(e.g.user-guides/data_exploration/spans/). Full URLs are rejected. cx docs fetchone page at a time — pick the best match first.
Troubleshooting
| Problem | Action |
|---|---|
| No search matches | Broaden or rephrase the query; try feature name + category ("spans UI", "OTel ingestion"). |
| Fetched page is too narrow | Search for the parent topic or run a second search with related terms. |
| User wants their actual data | Switch to cx logs, cx spans, cx metrics, or alerts — docs describe the product, not tenant contents. |
Related
- Telemetry queries: cx-telemetry-querying
- Alerts: cx-alerts
- Dashboards: cx-dashboards
Archivos 1 archivo
Instálala a mano
Deska ejecuta esto por ti, para cada agente que elijas. Para ejecutarlo tú en una terminal:
npx skills add coralogix/cx-cli --skill coralogix-docsMás de coralogix
- cx-telemetry-queryingcoralogixUse this skill for any question involving telemetry data: "investigate an issue", "debug a problem", "find out why something is slow", "check error rates", "analyze user behavior", "understand a production incident", "query telemetry data", "look at logs", "search logs", "find errors", "find stack traces", "filter by severity", "check traces", "examine spans", "investigate request latency", "debug service-to-service calls", "look up a trace ID", "analyze RUM data", "query rum.events", "check frontend performance", "frontend errors", "Core Web Vitals", "JavaScript exceptions", "query metrics", "check CPU usage", "run a PromQL query", "check error rate", "look up a metric", "check memory usage", "how do I write a DataPrime query", "DataPrime syntax", or wants to answer questions using observability data from logs, metrics, traces, RUM, or APM.3,700 instalaciones en skills.sh0
- cx-alertscoralogixThis skill should be used when the user asks to "manage alerts", "create alert", "list alerts", "delete alert", "check alert status", "enable alert", "disable alert", "investigate firing alerts", "check which alerts are active", "find alerting rules", "set up an alert", "configure alerting", "mute an alert", "silence an alert", "see alert definitions", "check alert priority", or wants to manage Coralogix alert definitions using the cx CLI.2,900 instalaciones en skills.sh0
- cx-search-dashboardcoralogixThis 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.2,900 instalaciones en skills.sh0
- cx-cost-optimizationcoralogixUse this skill when the user asks to "check data usage", "list TCO policies", "reduce Coralogix costs", "optimize observability spend", "lower our logging bill", "data budget exceeded", "TCO policy", "retention tier", "archive storage", "ingestion costs", "frequent search vs archive", "why is our bill so high", "spending too much on logs", "data retention settings", "cost analysis", "usage breakdown", "optimize log volume", "control data ingestion", "archive cold data", "billing units", "plan consumption", "daily plan", "overage", "PAYG", "usage anomaly", "usage trend", "cx_data_usage_units", or wants to investigate, analyze, or reduce Coralogix data costs.2,700 instalaciones en skills.sh0
- cx-data-pipelinecoralogixUse this skill when the user asks to "set up parsing", "create parsing rule", "extract fields from logs", "regex extraction", "log parsing", "enrich logs", "add context to logs", "custom enrichment table", "lookup table", "geo enrichment", "create metric from logs", "events to metrics", "convert logs to metrics", "generate metrics from events", "recording rule", "precomputed metrics", "PromQL recording", "configure data pipeline", "transform log data", "data processing rules", "rule group", "enrichment settings", "E2M definition", "labels cardinality", "bulk delete rules", "enrichment limits", "search enrichment table", "what should I convert to metrics", "E2M not producing metrics", "E2M no series", "reduce log cost with E2M", "logs to metrics aggregation", "spans to metrics", or wants to configure how Coralogix processes, enriches, or transforms ingested data.2,700 instalaciones en skills.sh0