Back to Details

coralogix-docs

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Coralogix docs (
cx docs search
, 
cx docs fetch
)

Coralogix 文档（
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.
这些命令从coralogix.com/docs读取Coralogix官方产品文档，用于解答平台的工作原理以及配置使用方法。它们不会查询租户的日志、链路追踪数据、指标或告警。
无需Coralogix API密钥。

CLI commands

CLI命令

CommandPurpose
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.
命令用途
cx docs search <query>
通过关键词查找文档页面，返回带编号的标题和路径后缀。
cx docs fetch <suffix>
下载单个页面为markdown格式，传入搜索结果中的后缀即可。

Flags

标记（Flags）

FlagCommandsDescription
--limit
search
Max results, 1–20 (default 5)
-o json
/ 
-o agents
bothMachine-readable output
标记适用命令描述
--limit
search
最大结果数，范围1–20（默认值为5）
-o json
/ 
-o agents
两者均适用机器可读格式输出

Examples

示例

bash
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 json
bash
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 json

When to use these commands

何时使用这些命令

Use 
cx docs search
 + 
cx docs fetch
 when the user wants:
TopicExample questions
UI / workflows"How do I view spans in Coralogix?", "Where is Explore spans?"
Ingestion & integrationsOpenTelemetry setup, agent/collector config, Send Your Data API keys
Platform featuresAlerts, SLOs, dashboards, enrichments, parsing rules, retention
Concepts & architectureHow tracing works, trace-log correlation, data model
Account & accessAPI keys, SSO, roles, regions
Prefer these commands over guessing when the answer depends on current Coralogix product behavior or UI navigation.
当用户需要以下信息时，使用**
cx docs search
** + 
cx docs fetch
：
主题示例问题
UI / 工作流"如何在Coralogix中查看链路追踪数据？"、"链路追踪探索功能在哪里？"
数据采集与集成OpenTelemetry设置、agent/collector配置、数据发送API密钥
平台功能告警、SLO、仪表盘、数据增强、解析规则、数据留存
概念与架构链路追踪工作原理、追踪-日志关联、数据模型
账户与权限API密钥、单点登录（SSO）、角色、区域
当答案依赖于Coralogix当前产品行为或UI导航时，优先使用这些命令而非自行猜测。

When not to use these commands

何时不使用这些命令

User needUse 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 & incidents in the tenant
cx alerts
, 
cx incidents
— cx-alerts, cx-incident-management
Metrics (PromQL)
cx metrics
— cx-telemetry-querying
Discover field paths in tenant data
cx search-fields
用户需求替代方案
查询实时日志
cx logs
— cx-telemetry-querying
查询实时链路追踪数据
cx spans
— cx-telemetry-querying
DataPrime语法/命令
cx dataprime list
/ 
cx dataprime show
— cx-telemetry-querying
租户中的告警与事件
cx alerts
、
cx incidents
— cx-alerts、cx-incident-management
指标（PromQL）
cx metrics
— cx-telemetry-querying
发现租户数据中的字段路径
cx search-fields

Standard workflow

标准工作流

  1. cx docs search
     with a focused query (2–4 keywords, not full sentences).
  2. Pick the most relevant suffix from the results.
  3. cx docs fetch
     on that suffix.
  4. 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 → drilldown
  1. 使用**
    cx docs search
    **执行精准查询（2–4个关键词，而非完整句子）。
  2. 从结果中选择最相关的路径后缀。
  3. 对该后缀执行**
    cx docs fetch
    **。
  4. 根据获取的内容作答，仅在需要时获取额外页面。
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 → drilldown

Tips

技巧

cx docs search

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 
    --limit
    when the first page of hits is ambiguous.
  • Results use path suffixes under 
    /docs/
    (not full URLs) — pass them directly to 
    cx docs fetch
    .
  • 以2–4个精准术语开头，而非完整句子。
  • 如果没有匹配结果，尝试同义词或更宽泛的术语（用
    "tracing"
    替代
    "distributed trace waterfall view"
    ）。
  • 当第一页结果不明确时，增大
    --limit
    的值。
  • 结果使用
    /docs/
    下的路径后缀（而非完整URL），可直接传入**
    cx docs fetch
    **使用。

cx 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 fetch
    one page at a time     — pick the best match first.
  • 传入**
    cx docs search
    **返回的路径后缀（例如
    user-guides/data_exploration/spans/
    ），完整URL会被拒绝。
  • 一次仅获取一个页面——先选择最匹配的页面。

Troubleshooting

故障排除

ProblemAction
No search matchesBroaden or rephrase the query; try feature name + category (
"spans UI"
, 
"OTel ingestion"
).
Fetched page is too narrowSearch for the parent topic or run a second search with related terms.
User wants their actual dataSwitch to 
cx logs
, 
cx spans
, 
cx metrics
, or alerts — docs describe the product, not tenant contents.
问题解决方法
无搜索匹配结果扩大查询范围或重新表述；尝试功能名称+类别（例如
"spans UI"
、
"OTel ingestion"
）。
获取的页面范围过窄搜索父主题或使用相关术语执行第二次搜索。
用户需要查看自身实际数据切换至
cx logs
、
cx spans
、
cx metrics
或告警相关命令——文档描述的是产品本身，而非租户内容。

Related

相关内容

  • Telemetry queries: cx-telemetry-querying
  • Alerts: cx-alerts
  • Dashboards: cx-dashboards
  • 遥测查询： cx-telemetry-querying
  • 告警： cx-alerts
  • 仪表盘： cx-dashboards