coralogix-docs

Coralogix 文档（cx docs search、cx docs fetch）

这些命令会读取 coralogix.com/docs 上的 Coralogix 官方产品文档，解答平台如何运作以及如何配置或使用平台。它们不会查询你租户中的日志、跨度、指标或告警。

无需 Coralogix API 密钥。

CLI 命令

命令	用途
cx docs search <query>	按关键词查找文档页面。返回带编号的标题和路径后缀。
cx docs fetch <suffix>	将单个页面下载为 Markdown。传入搜索结果中的后缀。

标志

标志	命令	说明
--limit	search	最大结果数，1–20（默认值为 5）
-o json / -o toon	两者均适用	机器可读输出

示例

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

何时使用这些命令

当用户想了解以下内容时，使用 cx docs search + cx docs fetch：

主题	示例问题
UI / 工作流	“如何在 Coralogix 中查看跨度？”、“Explore spans 在哪里？”
数据摄取与集成	OpenTelemetry 设置、Agent/收集器配置、Send Your Data API 密钥
平台功能	告警、SLO、仪表板、丰富化、解析规则、保留期限
概念与架构	追踪的工作原理、追踪与日志的关联、数据模型
帐户与访问权限	API 密钥、SSO、角色、区域

当答案取决于 Coralogix 当前的产品行为或 UI 导航时，优先使用这些命令，不要猜测。

何时不要使用这些命令

用户需求	改用
查询实时日志	cx logs — cx-telemetry-querying
查询实时跨度/追踪	cx spans — cx-telemetry-querying
DataPrime 语法 / 命令	cx dataprime list / cx dataprime show — cx-telemetry-querying
租户中的告警与案例	cx alerts、cx cases — cx-alerts、cx-cases
指标（PromQL）	cx metrics — cx-telemetry-querying
在租户数据中发现字段路径	cx search-fields

标准工作流

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

提示

cx docs search

• 从 2–4 个聚焦词语开始，不要输入完整句子。
• 如果没有匹配结果，尝试同义词或更宽泛的词语（例如用 "tracing" 替代 "distributed trace waterfall view"）。
• 如果第一页结果难以判断，增大 --limit。
• 结果使用 /docs/ 下的路径后缀（而非完整 URL）——直接将其传给 cx docs fetch。

cx docs fetch

• 传入 cx docs search 返回的后缀（例如 user-guides/data_exploration/spans/）。不接受完整 URL。
• cx docs fetch 一次获取一个页面——先选择最匹配的页面。

故障排除

问题	操作
没有搜索结果	扩大或改写查询；尝试“功能名称 + 类别”（例如 "spans UI"、"OTel ingestion"）。
获取的页面范围太窄	搜索上级主题，或使用相关词语再次搜索。
用户想查询自己的实际数据	改用 cx logs、cx spans、cx metrics 或告警命令——文档介绍的是产品，而不是租户内容。

相关内容

• 遥测查询： cx-telemetry-querying
• 告警： cx-alerts
• 仪表板： cx-dashboards