mcpField
D
doris-debug

doris-debug

github.com/apacheData & databases4772 installsUpdated 4w ago
Repository

About doris-debug

doris-debug is a troubleshooting skill for Apache Doris operators. It routes symptoms to focused guides and combines diagnostic commands, source maps, metrics, configuration references, and production cases.

Key features

  1. 01Routes Doris symptoms to domain skills
  2. 02Provides diagnostic SQL, API, and CLI references
  3. 03Maps symptoms to Doris source code
  4. 04Indexes production cases, metrics, and configuration
  5. 05Uses evidence-led, top-down investigation

Use cases

  1. 01Investigating slow or hanging queries
  2. 02Diagnosing load, compaction, or tablet issues
  3. 03Tracing FE/BE crashes and startup failures
  4. 04Troubleshooting catalogs and resource isolation

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/apache/doris-skills --skill doris-debug

After installing, type/doris-debugin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

cloud/references/
case-001-warmup-empty-batch.md
compaction/references/
case-001-too-many-versions.md
case-002-schema-change-base-score.md
data-lake/references/
case-001-glue-pagination.md
import/references/
case-001-group-commit-wal-pileup.md
case-002-rpc-timeout-heavy-work-pool.md
case-003-insert-job-fe-oom.md
materialized-view/references/
case-001-mtmv-rewrite-miss.md
node/references/
case-001-be-oom-memtracker.md
case-002-filecache-lru-leak.md
case-003-be-scanner-pileup-memory.md
case-004-fe-bdbje-corruption.md
query/references/
case-001-exchange-waitfordata.md
case-002-plan-time-iceberg-rpc.md
case-003-exchange-e11-fanout.md
resource-isolation/references/
case-001-workload-policy-cme.md
shared/guides/
cascade-import-wal-versions.md
cascade-query-timeout-exchange.md
shared/references/
01-common-commands.md
02-source-map.md
03-cir-case-index.md
04-metrics-guide.md
05-config-quick-ref.md

Details

From the project README

Doris Debug Router

How to use

  1. Identify the symptom domain from the table below.
  2. Read shared/references/01-common-commands.md for diagnostic SQL and API commands.
  3. Read shared/references/02-source-map.md to map symptoms to Apache Doris source code locations.
  4. Open the target skill (<domain>/SKILL.md) and follow its cause table and decision tree.
  5. Check shared/references/03-case-index.md for matching production case patterns.

Skill routing

SymptomSkill
Slow / timeout / hanging query, Profile analysis, Exchange WaitForDataquery/SKILL.md
Stream Load / Broker Load / Routine Load failure, Group Commit WAL pile-upimport/SKILL.md
-235 / too many versions, compaction score high, compaction lagcompaction/SKILL.md
BE/FE OOM, crash, false Alive, memory leaknode/SKILL.md
Sync MV miss, async MTMV refresh/rewrite issuesmaterialized-view/SKILL.md
Tablet replica missing, clone backlog, disk skew, tablet repairtablet/SKILL.md
FE/BE startup failure, port conflict, priority_networks misconfigdeployment/SKILL.md
Hive/Iceberg/Paimon/Glue catalog query failure, metadata refresh, S3/HDFS connectivitydata-lake/SKILL.md
Workload Group queue starvation, CPU/memory isolation leaks, spill issuesresource-isolation/SKILL.md
Storage-compute separation, meta-service latency, file cache, warmupcloud/SKILL.md

Shared references

DocumentContent
shared/references/01-common-commands.mdDiagnostic SQL, HTTP API, and CLI commands
shared/references/02-source-map.mdSymptom → Doris source code mapping (with version annotations)
shared/references/03-case-index.md45 production case summaries across 8 domains
shared/references/04-metrics-guide.mdPer-domain key metrics with thresholds
shared/references/05-config-quick-ref.mdPer-domain key configuration parameters with tuning guidance
shared/guides/Cross-module cascade troubleshooting

Companion skills

  • doris-profile-reader: Deep Profile analysis for query bottlenecks (referenced by query/SKILL.md Cause C — BE compute bottleneck).
  • doris-best-practices: Preventive table design and configuration guidance.
  • doris-architecture-advisor: Workload-aware architecture decisions.

Methodology

  1. Client → FE → BE → Disk/Network top-down investigation
  2. Logs / Metrics / Profile / SHOW PROC evidence first
  3. Stop the bleeding (throttle, kill, reset_rpc_channel) before root cause
  4. Verify hypotheses against Doris source code (02-source-map.md)
  5. Match known case patterns (03-case-index.md) to avoid rediscovery

Comments

Markdown supported