mcpField
C
clickhouse-architecture-advisor

clickhouse-architecture-advisor

github.com/clickhouse数据与数据库56210.0k 次安装1 周前更新
代码仓库

关于 clickhouse-architecture-advisor

用于制定 ClickHouse 架构建议的技能,会结合工作负载、决策规则和官方文档。面向 ClickHouse 系统设计者,并区分文档依据、推导结论与经验建议。

主要功能

  1. 01按工作负载制定架构决策
  2. 02涵盖摄取、保留、关联和迟到数据的规则
  3. 03附上官方文档链接
  4. 04标注建议的依据类别
  5. 05明确说明不确定性与经验判断

适用场景

  1. 01为特定工作负载设计实时数据摄取
  2. 02选择时间序列分区与保留方案
  3. 03规划数据丰富和维度查询

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/clickhouse/agent-skills --skill clickhouse-architecture-advisor

安装后在 Claude Code 中输入/clickhouse-architecture-advisor确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

AGENTS.md
metadata.json
README.md
examples/
finserv-market-surveillance.md
observability-high-throughput.md
README.md
siem-security-analytics.md
mappings/
doc_links.yaml
rules/
decision-ingestion-strategy.md
decision-join-enrichment.md
decision-late-arriving-upserts.md
decision-partitioning-timeseries.md
decision-real-time-preaggregation.md
schemas/
recommendation_schema.yaml

详细介绍

ClickHouse 架构顾问

此技能基于 clickhouse-best-practices,增加了感知工作负载的架构决策能力。

官方文档仍是事实依据。 有官方 ClickHouse 文档时,此技能必须始终优先参考。

必须遵循的行为

给出建议前:

  1. 识别工作负载类型
    • 可观测性
    • 安全 / SIEM
    • 产品分析
    • IoT / 遥测
    • 市场数据 / 金融服务
    • 混合 OLAP 与点查
  2. 阅读 rules/ 中相关的决策规则文件
  3. 使用 mappings/doc_links.yaml 附上官方文档
  4. 将每条建议标注为:
    • official
    • derived
    • field
  5. 绝不将现场经验建议说成官方建议
  6. 如果建议存在不确定性,请明确说明

来源规则

official

当建议得到官方文档直接支持时使用。

derived

当文档未逐字说明建议,但该建议可从文档记录的 ClickHouse 行为逻辑推导得出时使用。

field

仅用于可能因情境而异的经验型建议。 使用 field 时,需包含:

  • 说明该建议属于启发式建议的免责声明
  • 部分适用的相关官方文档
  • 说明该建议为何取决于工作负载情境

按场景阅读这些规则文件

实时摄取设计
  1. rules/decision-ingestion-strategy.md
  2. rules/decision-real-time-preaggregation.md
  3. 相关的最佳实践插入规则
时序数据与保留策略设计
  1. rules/decision-partitioning-timeseries.md
  2. 相关的最佳实践架构分区规则
丰富数据与维度查询
  1. rules/decision-join-enrichment.md
  2. 相关的最佳实践查询联接规则
可变状态 / 延迟到达的事件
  1. rules/decision-late-arriving-upserts.md
  2. 相关的最佳实践避免变更规则

输出格式

按以下格式组织回复:

## Workload Summary
- workload:
- latency target:
- data shape:
- primary query patterns:
- operational constraints:

## Key Decisions
- ...
- ...

## Recommendations

### <Recommendation title>

**What**
...

**Why**
...

**How**
...

**Category**
official | derived | field

**Confidence**
high | medium | heuristic

**Source**
- doc link(s)

**Validation**
- concrete SQL, metric, or smoke test

架构专项指导

优先采用决策框架,而非通用建议。优质回复应:

  • 解释权衡
  • 指出可能的运行瓶颈
  • 区分即时操作与结构性重设计
  • 提供目标架构模式,而不只是孤立的设置

完整参考

请参阅 AGENTS.md 中的汇编版本,以及 examples/ 中的示例输出。

评论

支持 Markdown