Set up docs MCP您可以通过 URL 查询参数使用深度链接打开 ClickStack 页面，从外部系统 (如告警通知、运行手册、CI 作业或聊天消息) 直接跳转到特定搜索、仪表盘或面板。
本页示例使用 <YOUR_CLICKSTACK_URL>。请将其替换为您的 ClickStack URL：例如，本地开源部署可使用 http://localhost:8080，ClickHouse Cloud 中的托管 ClickStack 可使用 https://hyperdx.clickhouse.cloud。
搜索 — /search
主要的日志/trace 搜索视图。有关搜索语法的详细信息，请参阅搜索。
| 参数 | 格式 | 描述 |
|---|---|---|
source |
string | 要搜索的数据源——可接受数据源 ID 或数据源名称 (例如 Logs) 。此页面仅支持日志和 trace 数据源。 |
where |
string | 过滤查询文本，可使用 Lucene 或 SQL 语法 (请参阅 whereLanguage) 。 |
whereLanguage |
lucene |
sql |
select |
string | 要在结果表中显示的 SQL 列/表达式列表。 |
filters |
{"type":"sql","condition":"<column> IN ('<value1>', '<value2>', ...)"}[] |
除 where 外额外应用的结构化分面过滤器。 |
orderBy |
string | 结果表的 SQL 排序表达式。 |
mode |
results |
delta |
isLive |
true |
false |
traceId |
string | 直接跳转到指定 trace ID 的 trace 瀑布视图。 |
from, to |
纪元毫秒 | 绝对时间范围。若省略，默认为最近 15 分钟。 |
也可通过 /search/<savedSearchId> 直接打开已保存的搜索。
示例：在指定时间范围内搜索 Logs 源中 checkout 服务的错误
<YOUR_CLICKSTACK_URL>/search?source=Logs&from=1735689600000&to=1735693200000&where=level:error&filters=[{"type":"sql","condition":"ServiceName IN ('checkout')"}]示例：直接跳转到 trace 的瀑布视图
<YOUR_CLICKSTACK_URL>/search?source=Traces&traceId=ba7217967eb90d040b7eb39f97ecc5c4已保存的搜索 — /search/list
已保存搜索的列表。
| 参数 | 格式 | 描述 |
|---|---|---|
tag |
string | 仅显示带有此标签的已保存搜索。 |
示例：列出带有 production 标签的已保存搜索
<YOUR_CLICKSTACK_URL>/search/list?tag=production仪表盘 — /dashboards/<dashboardId>
已保存的仪表盘。省略 <dashboardId> (/dashboards) 可打开一个临时的未保存仪表盘。有关创建仪表盘的详细信息，请参阅仪表盘。
| 参数 | 格式 | 描述 |
|---|---|---|
from, to |
纪元毫秒 | 应用于所有卡片的时间范围。若省略，默认为最近 15 分钟。 |
where |
字符串 | 应用于所有卡片的仪表盘级过滤器查询文本。 |
whereLanguage |
lucene |
sql |
filters |
{"type":"sql","condition":"<column> IN ('<value1>', '<value2>', ...)"}[] |
结构化仪表盘过滤器配置值，用于在 ServiceName 过滤器下拉列表中选择两个项目。 |
granularity |
auto |
30 second |
highlightedTileId |
字符串 | 滚动到并突出显示指定卡片——从告警跳转时非常有用。 |
示例：打开指定时间范围的仪表盘，并高亮显示某个卡片
适用于从告警通知直接跳转到触发该告警的卡片。
<YOUR_CLICKSTACK_URL>/dashboards/64f1c2a1e8b9f3a1b0d2e5c7?from=1735689600000&to=1735693200000&highlightedTileId=chart-1仪表盘列表 — /dashboards/list
| 参数 | 格式 | 描述 |
|---|---|---|
tag |
string | 按标签筛选仪表盘列表。 |
示例：列出标有 infra 标签的仪表盘
<YOUR_CLICKSTACK_URL>/dashboards/list?tag=infraChart Explorer — /chart
用于临时创建和共享图表的构建器。
| 参数 | 格式 | 描述 |
|---|---|---|
config |
JSON | 完整的图表配置 (source、select、where、图表类型等) 。通常由应用内的“共享”链接生成，而非手动编写。 |
from, to |
纪元毫秒 | 时间范围。省略时，默认使用最近 15 分钟。 |
示例：打开指定时间范围内的 p99 延迟图表配置
<YOUR_CLICKSTACK_URL>/chart?granularity=auto&from=1785759381784&to=1785762981785&config={"name":"","select":[{"aggFn":"quantile","aggCondition":"","aggConditionLanguage":"lucene","valueExpression":"Duration","level":0.99,"alias":"p99"}],"where":"","whereLanguage":"lucene","displayType":"line","alignDateRangeToGranularity":true,"source":"68814eb5d40a9d0449afc1f2","connection":"68814b6fd40a9d0449afbe78","groupBy":"ServiceName"}告警 — /alerts
有关创建和管理告警的详细信息，请参阅告警。
| 参数 | 格式 | 描述 |
|---|---|---|
search |
string | 按告警名称或描述进行全文过滤。 |
tag |
string | 按标签过滤。 |
creator |
string | 按告警创建者名称过滤。 |
示例：列出带有 on-call 标签的告警
<YOUR_CLICKSTACK_URL>/alerts?tag=on-call会话回放 — /sessions
浏览和播放会话回放。有关功能详情，请参阅会话回放。
| 参数 | 格式 | 描述 |
|---|---|---|
sessionSource |
string | 会话源 ID 或名称。 |
where |
string | 用于筛选会话列表的查询文本。 |
whereLanguage |
lucene |
sql |
from, to |
纪元毫秒 | 会话列表的时间范围。若省略，默认为最近 15 分钟。 |
sid |
string | 通过 ID 打开指定会话。 |
sfrom, sto |
纪元毫秒 | 已打开会话的时间窗口 (与 sid 配合使用) 。 |
示例：在指定时间范围内浏览会话回放
<YOUR_CLICKSTACK_URL>/sessions?from=1735689600000&to=1735693200000示例：在录制时段打开指定的会话回放
<YOUR_CLICKSTACK_URL>/sessions?sid=6712abf0e4b0f2a1c3d4e5f6&sfrom=1735689600000&sto=1735690200000服务地图 — /service-map
功能详情请参阅服务地图。
| 参数 | 格式 | 说明 |
|---|---|---|
source |
string | 链路追踪数据源 ID 或名称。 |
samplingFactor |
integer | 链路追踪采样除数 (1 = 100% 的链路追踪，2 = 50%，4 = 25%，等等) 。 |
from, to |
纪元毫秒 | 时间范围。省略时默认为最近 15 分钟。 |
示例：查看指定时间范围内的服务地图
<YOUR_CLICKSTACK_URL>/service-map?from=1735689600000&to=1735693200000服务 — /services
按服务查看 HTTP、数据库和错误仪表盘。
| 参数 | 格式 | 描述 |
|---|---|---|
tab |
http |
database |
source |
string | 链路追踪数据源 ID。 |
service |
string | 所选服务名称。 |
where |
string | 过滤查询文本。 |
whereLanguage |
lucene |
sql |
filters |
{"type":"sql","condition":"<column> IN ('<value1>', '<value2>', ...)"}[] |
仪表盘过滤栏配置值。 |
from, to |
纪元毫秒 | 时间范围。如未指定，默认为最近 15 分钟。 |
示例：查看服务在指定时间范围内的数据库仪表板
<YOUR_CLICKSTACK_URL>/services?tab=database&service=checkout&from=1735689600000&to=1735693200000示例：查看服务的错误仪表板
<YOUR_CLICKSTACK_URL>/services?tab=errors&service=paymentsKubernetes — /kubernetes
| 参数 | 格式 | 描述 |
|---|---|---|
logSource, metricSource |
string | 日志和指标数据源 ID。仅提供其中一个时，另一个默认使用关联的数据源。 |
tab |
例如 pods、nodes、namespaces |
当前活动的子视图。 |
q |
string | 资源列表的 Lucene 查询。 |
podName, nodeName, namespaceName |
string | 打开特定 pod (容器组) 、节点或命名空间的详情面板。 |
from, to |
纪元毫秒 | 时间范围。省略时，默认为最近 15 分钟。 |
示例：打开特定 pod (容器组) 的详情面板
<YOUR_CLICKSTACK_URL>/kubernetes?tab=pods&podName=checkout-7d9f8b5c-2xk9p笔记本 — /notebook/<notebookId>
示例：在指定的 Cloud 服务中打开特定 notebook
<YOUR_CLICKSTACK_URL>/notebook/64f1c2a1e8b9f3a1b0d2e5c7?chcServiceId=abc123