Back to Details

signoz-docs

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

SigNoz Docs

SigNoz 文档

Use official 
signoz.io
documentation and API references only. Ground every answer in fetched docs content and cite the canonical docs URL.
仅使用官方
signoz.io
文档和API参考。所有回答都必须基于获取的文档内容，并引用标准文档URL。

Access Docs

访问文档

SigNoz docs support 
Accept: text/markdown
. Fetch docs pages as markdown instead of scraping HTML.
SigNoz文档支持
Accept: text/markdown
。请以markdown格式获取文档页面，而非抓取HTML。

Discover pages

发现页面

Use the sitemap to search for candidate pages:
GET https://signoz.io/docs/sitemap.md
使用站点地图搜索候选页面：
GET https://signoz.io/docs/sitemap.md

Fetch a page

获取页面

Fetch any docs page as markdown by requesting it with:
GET https://signoz.io/docs/<path>/
Accept: text/markdown
For example, to fetch the logs overview page:
GET https://signoz.io/docs/logs-management/overview/
Accept: text/markdown
通过以下请求以markdown格式获取任意文档页面：
GET https://signoz.io/docs/<path>/
Accept: text/markdown
例如，获取日志概览页面：
GET https://signoz.io/docs/logs-management/overview/
Accept: text/markdown

Workflow

工作流程

  1. Identify the domain from the user's question: instrumentation, OpenTelemetry setup, querying, dashboards, alerts, troubleshooting, deployment, or API docs.
  2. Check the heuristics table below. If a heuristic matches, read that file before choosing docs pages.
  3. Search 
    sitemap.md
    for candidate pages     that match the user's product area, environment, language, and task.
  4. Rank the best 2-5 official pages by how directly they help the user complete the task.
  5. Fetch only the top page(s) as markdown with 
    Accept: text/markdown
    .
    • Fetch one page for narrow questions that map cleanly to a single setup guide, troubleshooting page, or API reference.
    • Fetch multiple pages when the task clearly spans multiple needs, such as collection-method selection plus a language guide, setup plus troubleshooting, or overview plus exact API/auth details.
    • Keep the fetch set small and purposeful. Do not fetch loosely related pages just because they share keywords.
  6. Answer from the fetched docs and cite canonical 
    https://signoz.io/docs/...
    URLs.
  7. Handle ambiguity deliberately: if multiple pages are plausible, prefer the page that completes the task most directly and mention alternates only when they materially change the answer.
  1. 确定用户问题的领域：埋点、OpenTelemetry配置、查询、仪表盘、告警、故障排查、部署或API文档。
  2. 查看下方的启发式规则表。如果有匹配的启发式规则，请先阅读对应文件再选择文档页面。
  3. 在
    sitemap.md
    中搜索候选页面    ，匹配用户的产品领域、环境、语言和任务。
  4. 筛选出最相关的2-5个官方页面，依据其对用户完成任务的直接帮助程度排序。
  5. 仅获取排名靠前的页面，以
    Accept: text/markdown
    请求markdown格式。
    • 对于范围明确的问题（如对应单一配置指南、故障排查页面或API参考），获取一个页面即可。
    • 当任务明显涉及多个需求时（如收集方法选择+语言指南、配置+故障排查、概览+具体API/认证细节），获取多个页面。
    • 保持获取的页面集精简且有针对性，不要仅因关键词相关就获取松散关联的页面。
  6. 基于获取的文档进行回答，并引用标准
    https://signoz.io/docs/...
    URL。
  7. 明确处理歧义：如果多个页面都看似相关，优先选择最能直接完成用户任务的页面，仅当其他页面会显著改变答案时才提及替代选项。

Ranking Hints

排序提示

  • Prefer setup, troubleshooting, or API-reference pages over overview pages when the user needs an action.
  • Prefer pages that match the user's runtime, language, deployment environment, or SigNoz product area.
  • For API questions, prefer the exact endpoint/auth/reference page over a general guide.
  • Stay within official 
    signoz.io
    docs pages when this skill applies.
  • 当用户需要执行操作时，优先选择配置、故障排查或API参考页面，而非概览页面。
  • 优先选择与用户的运行时、语言、部署环境或SigNoz产品领域匹配的页面。
  • 对于API相关问题，优先选择具体的端点/认证/参考页面，而非通用指南。
  • 当适用本技能时，仅使用官方
    signoz.io
    文档页面。

Domain Heuristics

领域启发式规则

Read the matching heuristic file before fetching docs. Each file contains decision logic to route the user to the right guide.
TopicTrigger keywordsHeuristic file
Sending Logslogs, log collection, logging, send logssending-logs.md
在获取文档前，请先阅读匹配的启发式规则文件。每个文件包含决策逻辑，可将用户引导至正确的指南。
主题触发关键词启发式规则文件
发送日志logs, log collection, logging, send logssending-logs.md