debug-buttercup
trailofbits/skills
用于调试在 Kubernetes 上运行的 Buttercup CRS(网络推理系统)。适用于诊断 pod 崩溃、重启循环、Redis 故障、资源压力、磁盘饱和、DinD 问题,或 crs 命名空间中出现的任何服务异常行为。 涵盖以下组件的故障分级、日志分析、队列检查及常见故障模式:redis、fuzzer-bot、coverage-bot、seed-gen、patcher、build-bot、scheduler、task-server、task-downloader、program-model、litellm、 dind、tracer-bot、merger-bot、competition-api、pov-reprod
...展开全部关于debug-buttercup
debug-buttercup 技能旨在排查和诊断部署在Kubernetes上的Buttercup网络推理系统(CRS)中的问题。 该技能专注于识别 `crs` 命名空间中 Pod 崩溃、重启循环、Redis 故障、资源压力、磁盘饱和、Docker-in-Docker(DinD)问题以及其他服务异常行为的根本原因。 通过提供系统化的故障分级和日志分析,该技能可帮助工程师精确定位故障源头,从而减少整个系统的停机时间。
该技能提供了故障分级工作流功能,包括检查 Pod 状态、查看事件、检查日志,以及将实际资源限制与预期配置进行对比。它支持检测历史问题和当前问题,并能区分累积的重启次数与当前活跃的故障。Debug-buttercup 还支持级联故障检测,例如 Redis 不可用等单个服务问题可能引发大范围重启。用户可以分析所有副本的日志、流式传输实时日志,并将日志收集到磁盘以进行深入检查。该技能还包含在 Pod 和节点层面的资源压力检查,用于识别 CPU、内存和磁盘限制。
该技能非常适合需要维护系统稳定性并快速解决事件的 Kubernetes 运维人员、站点可靠性工程师以及使用 Buttercup CRS 的开发人员。 典型用例包括调查意外的 Pod 重启、诊断无响应的服务、验证队列进度以及排查健康检查失败问题。通过针对 `crs` 命名空间内的故障进行定位,debug-buttercup 确保能够精准高效地解决问题,同时不会影响无关的部署或性能调优任务。
常见问题
何时应使用debug-buttercup ?
当 `crs` 命名空间中的 Pod 发生崩溃、意外重启、资源压力过大,或 Redis 等服务无响应时,请使用此技能。它还适用于诊断队列阻塞、DinD 失败、调度器问题以及 CRS 系统中的其他异常行为。
我可以在 CRS 命名空间之外使用 `debug-buttercup ` 吗?
不可以,此技能专门用于调试 `crs` Kubernetes 命名空间内的服务。对于其他命名空间中的问题,应使用标准的 Kubernetes 故障排除方法或其他合适的工具。
debug-buttercup 是否支持部署或升级操作?
不,它并非用于部署或升级 Buttercup。部署和升级任务应通过 Helm 并遵循官方部署指南来执行。
debug-buttercup 如何帮助处理级联故障?
它能识别共享依赖项故障(例如 Redis 宕机),此类故障可能触发多个 Pod 的重启。通过分析跨服务的 `--previous` 日志,它使工程师能够专注于查找根本原因,而非逐个排查单个 Pod。
该技能中是否包含资源检查功能?
是的,debug-buttercup 包含用于检查 Pod 和节点层级 CPU、内存及磁盘使用情况的命令,有助于识别与资源相关的故障原因。
Debug Buttercup
When to Use
- Pods in the
crsnamespace are in CrashLoopBackOff, OOMKilled, or restarting - Multiple services restart simultaneously (cascade failure)
- Redis is unresponsive or showing AOF warnings
- Queues are growing but tasks are not progressing
- Nodes show DiskPressure, MemoryPressure, or PID pressure
- Build-bot cannot reach the Docker daemon (DinD failures)
- Scheduler is stuck and not advancing task state
- Health check probes are failing unexpectedly
- Deployed Helm values don't match actual pod configuration
When NOT to Use
- Deploying or upgrading Buttercup (use Helm and deployment guides)
- Debugging issues outside the
crsKubernetes namespace - Performance tuning that doesn't involve a failure symptom
Namespace and Services
All pods run in namespace crs. Key services:
| Layer | Services |
|---|---|
| Infra | redis, dind, litellm, registry-cache |
| Orchestration | scheduler, task-server, task-downloader, scratch-cleaner |
| Fuzzing | build-bot, fuzzer-bot, coverage-bot, tracer-bot, merger-bot |
| Analysis | patcher, seed-gen, program-model, pov-reproducer |
| Interface | competition-api, ui |
Triage Workflow
Always start with triage. Run these three commands first:
# 1. Pod status - look for restarts, CrashLoopBackOff, OOMKilledkubectl get pods -n crs -o wide# 2. Events - the timeline of what went wrongkubectl get events -n crs --sort-by='.lastTimestamp'# 3. Warnings only - filter the noisekubectl get events -n crs --field-selector type=Warning --sort-by='.lastTimestamp'
Then narrow down:
# Why did a specific pod restart? Check Last State Reason (OOMKilled, Error, Completed)kubectl describe pod -n crs <pod-name> | grep -A8 'Last State:'# Check actual resource limits vs intendedkubectl get pod -n crs <pod-name> -o jsonpath='{.spec.containers[0].resources}'# Crashed container's logs (--previous = the container that died)kubectl logs -n crs <pod-name> --previous --tail=200# Current logskubectl logs -n crs <pod-name> --tail=200
Historical vs Ongoing Issues
High restart counts don't necessarily mean an issue is ongoing -- restarts accumulate over a pod's lifetime. Always distinguish:
--tailshows the end of the log buffer, which may contain old messages. Use--since=300sto confirm issues are actively happening now.--timestampson log output helps correlate events across services.- Check
Last Statetimestamps indescribe podto see when the most recent crash actually occurred.
Cascade Detection
When many pods restart around the same time, check for a shared-dependency failure before investigating individual pods. The most common cascade: Redis goes down -> every service gets ConnectionError/ConnectionRefusedError -> mass restarts. Look for the same error across multiple --previous logs -- if they all say redis.exceptions.ConnectionError, debug Redis, not the individual services.
Log Analysis
# All replicas of a service at oncekubectl logs -n crs -l app=fuzzer-bot --tail=100 --prefix# Stream livekubectl logs -n crs -l app.kubernetes.io/name=redis -f# Collect all logs to disk (existing script)bash deployment/collect-logs.sh
Resource Pressure
# Per-pod CPU/memorykubectl top pods -n crs# Node-levelkubectl top nodes# Node conditions (disk pressure, memory pressure, PID pressure)kubectl describe node <node> | grep -A5 Conditions# Disk usage inside a podkubectl exec -n crs <pod> -- df -h# What's eating diskkubectl exec -n crs <pod> -- sh -c 'du -sh /corpus/* 2>/dev/null'kubectl exec -n crs <pod> -- sh -c 'du -sh /scratch/* 2>/dev/null'
Redis Debugging
Redis is the backbone. When it goes down, everything cascades.
# Redis pod statuskubectl get pods -n crs -l app.kubernetes.io/name=redis# Redis logs (AOF warnings, OOM, connection issues)kubectl logs -n crs -l app.kubernetes.io/name=redis --tail=200# Connect to Redis CLIkubectl exec -n crs <redis-pod> -- redis-cli# Inside redis-cli: key diagnosticsINFO memory # used_memory_human, maxmemoryINFO persistence # aof_enabled, aof_last_bgrewrite_status, aof_delayed_fsyncINFO clients # connected_clients, blocked_clientsINFO stats # total_connections_received, rejected_connectionsCLIENT LIST # see who's connectedDBSIZE # total keys# AOF configurationCONFIG GET appendonly # is AOF enabled?CONFIG GET appendfsync # fsync policy: everysec, always, or no# What is /data mounted on? (disk vs tmpfs matters for AOF performance)
kubectl exec -n crs <redis-pod> -- mount | grep /datakubectl exec -n crs <redis-pod> -- du -sh /data/
Queue Inspection
Buttercup uses Redis streams with consumer groups. Queue names:
| Queue | Stream Key |
|---|---|
| Build | fuzzer_build_queue |
| Build Output | fuzzer_build_output_queue |
| Crash | fuzzer_crash_queue |
| Confirmed Vulns | confirmed_vulnerabilities_queue |
| Download Tasks | orchestrator_download_tasks_queue |
| Ready Tasks | tasks_ready_queue |
| Patches | patches_queue |
| Index | index_queue |
| Index Output | index_output_queue |
| Traced Vulns | traced_vulnerabilities_queue |
| POV Requests | pov_reproducer_requests_queue |
| POV Responses | pov_reproducer_responses_queue |
| Delete Task | orchestrator_delete_task_queue |
# Check stream length (pending messages)kubectl exec -n crs <redis-pod> -- redis-cli XLEN fuzzer_build_queue# Check consumer group lagkubectl exec -n crs <redis-pod> -- redis-cli XINFO GROUPS fuzzer_build_queue# Check pending messages per consumerkubectl exec -n crs <redis-pod> -- redis-cli XPENDING fuzzer_build_queue build_bot_consumers - + 10# Task registry sizekubectl exec -n crs <redis-pod> -- redis-cli HLEN tasks_registry# Task state countskubectl exec -n crs <redis-pod> -- redis-cli SCARD cancelled_taskskubectl exec -n crs <redis-pod> -- redis-cli SCARD succeeded_taskskubectl exec -n crs <redis-pod> -- redis-cli SCARD errored_tasks
Consumer groups: build_bot_consumers, orchestrator_group, patcher_group, index_group, tracer_bot_group.
Health Checks
Pods write timestamps to /tmp/health_check_alive. The liveness probe checks file freshness.
# Check health file freshnesskubectl exec -n crs <pod> -- stat /tmp/health_check_alivekubectl exec -n crs <pod> -- cat /tmp/health_check_alive
If a pod is restart-looping, the health check file is likely going stale because the main process is blocked (e.g. waiting on Redis, stuck on I/O).
Telemetry (OpenTelemetry / Signoz)
All services export traces and metrics via OpenTelemetry. If Signoz is deployed (global.signoz.deployed: true), use its UI for distributed tracing across services.
# Check if OTEL is configuredkubectl exec -n crs <pod> -- env | grep OTEL# Verify Signoz pods are running (if deployed)kubectl get pods -n platform -l app.kubernetes.io/name=signoz
Traces are especially useful for diagnosing slow task processing, identifying which service in a pipeline is the bottleneck, and correlating events across the scheduler -> build-bot -> fuzzer-bot chain.
Volume and Storage
# PVC statuskubectl get pvc -n crs# Check if corpus tmpfs is mounted, its size, and backing typekubectl exec -n crs <pod> -- mount | grep corpus_tmpfskubectl exec -n crs <pod> -- df -h /corpus_tmpfs 2>/dev/null# Check if CORPUS_TMPFS_PATH is setkubectl exec -n crs <pod> -- env | grep CORPUS# Full disk layout - what's on real disk vs tmpfskubectl exec -n crs <pod> -- df -h
CORPUS_TMPFS_PATH is set when global.volumes.corpusTmpfs.enabled: true. This affects fuzzer-bot, coverage-bot, seed-gen, and merger-bot.
Deployment Config Verification
When behavior doesn't match expectations, verify Helm values actually took effect:
# Check a pod's actual resource limitskubectl get pod -n crs <pod-name> -o jsonpath='{.spec.containers[0].resources}'# Check a pod's actual volume definitionskubectl get pod -n crs <pod-name> -o jsonpath='{.spec.volumes}'
Helm values template typos (e.g. wrong key names) silently fall back to chart defaults. If deployed resources don't match the values template, check for key name mismatches.
Service-Specific Debugging
For detailed per-service symptoms, root causes, and fixes, see references/failure-patterns.md.
Quick reference:
- DinD:
kubectl logs -n crs -l app=dind --tail=100-- look for docker daemon crashes, storage driver errors - Build-bot: check build queue depth, DinD connectivity, OOM during compilation
- Fuzzer-bot: corpus disk usage, CPU throttling, crash queue backlog
- Patcher: LiteLLM connectivity, LLM timeout, patch queue depth
- Scheduler: the central brain --
kubectl logs -n crs -l app=scheduler --tail=-1 --prefix | grep "WAIT_PATCH_PASS\|ERROR\|SUBMIT"
Diagnostic Script
Run the automated triage snapshot:
bash {baseDir}/scripts/diagnose.shPass --full to also dump recent logs from all pods:
bash {baseDir}/scripts/diagnose.sh --fullThis collects pod status, events, resource usage, Redis health, and queue depths in one pass.





首页
