Stuckgo

io.github.GillMacedo由 GitHub 账号 GillMacedo 发布v0.1.0更新于 Nov 3, 2026

Find what a stuck Go program is waiting on from a goroutine dump, with no connection to it.

已验证STDIO仅桌面开发者工具安全与监控

概览

AI 生成的概览

读取 Go goroutine dump,告诉助手卡住或泄漏的 Go 程序在等什么,且不连接该程序。

可以做什么
  • 审查单份 goroutine dump(文本或文件),合并相同堆栈、排除正常空闲的 goroutine 并给出排序后的发现
  • 识别死锁、nil channel 阻塞、互斥锁堆积及可能的持有者、未完成的 WaitGroup、database/sql 连接池耗尽、长时间 HTTP 调用和 channel 泄漏
  • 比较同一程序的两份 dump,显示哪些堆栈在增长、哪些 goroutine ID 原地不动
  • 以文本或 JSON 输出带严重程度和建议的发现
适用场景
适用于 Go 服务卡死、goroutine 泄漏、数据库连接耗尽或疑似被互斥锁阻塞,且手上有 dump 或崩溃堆栈可粘贴时。也可用于间隔一段时间取两份 dump 来验证泄漏怀疑。
运行要求
以 stdio 在本地运行,通常通过 npx(需 Node 18 或更新版本)或 Go 安装。未声明任何账号、API 密钥或环境变量。dump 文本需自行提供,例如来自 pprof goroutine 端点或崩溃堆栈。
安装前请注意
dump 可能包含程序中的文件路径和数值,而 MCP 客户端会把工具结果发送给其模型,分享前请先检查。发现只是线索而非证据:可能的锁持有者是推断的,单份 dump 无法证明泄漏。用 kill -QUIT 获取 dump 会终止进程。

安装

在 SourceWeft 中

  1. 打开 控制台中的 Stuckgo,将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Desktop only,通过 STDIO。 STDIO 服务会启动本地进程,因此需要 SourceWeft 桌面宿主。

其他 MCP 客户端

参照 仓库 中的启动说明。

README

stuckgo: why is this Go program stuck?

[npm] [CI] [MIT license]

An MCP server and CLI that reads a Go goroutine dump and tells you what the program is waiting on. It finds goroutine leaks, lock pile-ups, full database pools and HTTP calls with no timeout. It works from the dump text alone, so it never connects to your service.

A hung service can have thousands of goroutines, and most of them are normal: listeners, read loops, idle workers. stuckgo groups identical stacks, sets aside what's normally idle, and ranks what's left. When 40 goroutines wait on a mutex, it also names what might be holding it.

What you can ask your agent

  • "Our Go service is hanging. Here's the goroutine dump."
  • "Do we have a goroutine leak? Here are two dumps ten minutes apart."
  • "Why is this service out of database connections?"
  • "What's holding this mutex?"

Install

As a Claude Code plugin:

claude plugin marketplace add GillMacedo/stuckgoclaude plugin install stuckgo@stuckgo-marketplace

As an MCP server, for any client:

{"mcpServers": {"stuckgo": {"command": "npx", "args": ["-y", "[email protected]", "serve"]}}}

As a CLI, with Node 18 or newer:

npx stuckgo review dump.txt

Or with Go 1.27 or newer: go install github.com/GillMacedo/stuckgo@latest.

Usage

Get a dump from a service that imports net/http/pprof. This doesn't stop the program:

curl 'http://localhost:6060/debug/pprof/goroutine?debug=2' > dump.txt

kill -QUIT <pid> also prints a dump, but it ends the process. Crash output works too, and GOTRACEBACK=all shows every goroutine rather than just the failing one.

Here's a real dump from a made-up service in examples/, run from a clone of this repo:

$ go run . review examples/dumps/mutex-late.txt43 goroutines, 1 normally idle
Groups:      40  sync.Mutex.Lock, up to 2 min  main.(*store).Get (app/main.go:109)       1  chan receive, up to 2 min  main.mutex (app/main.go:130)       1  select, up to 2 min  main.(*store).Refresh (app/main.go:118)
HIGH   SG107 main.(*store).Get (app/main.go:109)  40 goroutines waiting for a mutex, waiting up to 2 minutes. Possible holder, not proven: main.(*store).Refresh (app/main.go:118), in select.  Try: Look at what the holder does while it holds the lock. Don't hold a lock across network calls, channel operations or slow work.

To check for a leak, compare two dumps taken some time apart. A stack that grows, with the same goroutine IDs staying in place, is much stronger evidence than one dump:

$ go run . compare examples/dumps/leak-early.txt examples/dumps/leak-late.txtGoroutines: 344 -> 637 (+293)
Growing:    +293  342 -> 635  chan send  main.lookupPrice.func1 (app/main.go:79)
Same goroutine IDs in the same place in both dumps:     342  chan send, up to 2 min  main.lookupPrice.func1 (app/main.go:79)

With Go 1.27 or newer, Go can also check for itself: /debug/pprof/goroutineleak?debug=2. stuckgo reads that output too.

Add --json for JSON, or --fail-on high to exit 1 in CI. Use - to read from stdin.

What it finds

RuleFinds
SG101Go's own "all goroutines are asleep" deadlock
SG102A panic or fatal error, and where it happened
SG103Goroutines that Go's leak profile reports as leaked
SG104A send or receive on a nil channel, which never returns
SG105Goroutines waiting for a free database/sql connection
SG106Outgoing HTTP calls that have been waiting a long time
SG107Goroutines piling up on a mutex, with possible holders
SG108A WaitGroup that hasn't finished, and what it started
SG109Goroutines stuck sending on a channel, the usual leak
SG110Many goroutines waiting on a channel receive or select
SG111Long waits on network I/O
SG112Long system calls
SG113Long waits in sync.Cond.Wait
SG114Many goroutines sleeping at one line
SG115One function that started most of the goroutines, across several stacks
SG116Many goroutines running or waiting for a CPU
SG117Many goroutines parked at one line in a debug=1 dump, which doesn't say why

Severity comes from how many goroutines are involved and how long they've waited. These thresholds are judgment calls.

MCP tools

ToolDoes
go_goroutine_reviewReviews one dump, from text or a file
go_goroutine_compareCompares two dumps of one program

Limits

  • Findings are leads. A dump is one moment. Check each finding against the code.
  • It can't prove who holds a lock. Go's dumps don't say. A "possible holder" is another goroutine in the same type's methods.
  • One dump can't prove a leak, unless it's Go's own leak profile. An idle worker pool looks the same as a leak, so compare two dumps.
  • debug=1 shows less. It has counts, with no wait times or goroutine IDs, and hides most of what a goroutine waits on. Use debug=2 when you can.
  • Wait times are rough. Go only prints a wait of a minute or more, and starts the clock at a garbage collection, so a missing time doesn't mean a short wait.
  • It can't see CPU use. For a program that's slow with nothing parked, take a CPU profile.
  • The list of normally idle stacks is short: the Go runtime, net/http, database/sql, gRPC and golang.org/x/net/http2. Other libraries' background loops show up as groups, but rarely as findings.
  • Dumps can hold file paths and values from your program. stuckgo stays on your machine, but your MCP client sends tool results to its model.

FAQ

How do I find a goroutine leak in Go? Take two dumps some time apart and run stuckgo compare. A growing stack whose goroutine IDs stay in place is the sign to look for.

How do I get a goroutine dump from a running Go program? Import net/http/pprof, then fetch /debug/pprof/goroutine?debug=2. Keep that endpoint private.

What does [chan send, 5 minutes] mean in a goroutine dump? That goroutine has been blocked for about 5 minutes, sending on a channel nothing is receiving from. SG109 covers it.

Why is my Go service out of database connections? Goroutines waiting in database/sql.(*DB).conn mean the pool is full. SG105 flags them. Look at what's holding the connections, such as slow queries or Rows that aren't closed.

How is this different from panicparse or goroutine-inspect? panicparse and goroutine-inspect help a person read and explore a dump. stuckgo gives an agent ranked findings, can compare two dumps, and sets aside what's normally idle.

Tested on

  • Real programs in examples/programs/: every rule from SG101 to SG109, plus SG111, SG114 and SG117, fired on dumps from programs that really got stuck, in examples/dumps/. Most also ran on Go 1.22.
  • Real services: idle Prometheus 3.7.3 and etcd 3.6.5, in examples/dumps/real/, raised nothing above low. Prometheus gets two low WaitGroup findings, which are normal there.
  • Written examples only: SG110, SG112, SG113, SG115 and SG116.
  • MCP tool calls went through the MCP Inspector.

It hasn't been used on an incident in production yet, or in a fresh Claude session.

Contributing

Contributions are welcome, from people and from people working with AI agents. See CONTRIBUTING.md. Good first issues are listed here.

AI disclosure

This project was largely generated with Claude Code and reviewed by its maintainer.

About me

I'm Giulliano Macedo, and I build developer tools at GoTech Solutions. Follow along or get in touch:

If stuckgo found what your program was stuck on, a star helps others find it.


Built by Giulliano Macedo, GoTech Solutions · LinkedIn · X

来源:README.md,提交 6627356

工具

2

go_goroutine_compare

Compare two Go goroutine dumps

Compares two goroutine dumps of one Go program taken some time apart, and shows which stacks are growing and which goroutine IDs never moved, which is stronger evidence of a leak than one dump. It never connects to the program.

输入参数afterbeforeafter_pathbefore_path

go_goroutine_review

Review a Go goroutine dump

Finds what a stuck or leaking Go program is waiting on, from a goroutine dump: /debug/pprof/goroutine?debug=2 or debug=1, a panic traceback, or SIGQUIT output. Groups identical stacks, separates normal idle goroutines, and flags channel leaks, lock pile-ups with possible holders, WaitGroups that never finish, full database pools, HTTP calls with no timeout and nil channels. It only reads the text you give it and never connects to the program. Findings are leads.

输入参数dumppath

版本历史

1
  1. v0.1.0最新Nov 1, 2026

评分

已满足适用检查项的 90%

该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。

  • 近 30 天内可连通25 分
  • 已声明认证方式10 分

    请在注册中心条目中声明凭据请求头,或保持端点能够响应探测,以便判定其认证方式。

  • 已列出工具必需15 分
  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分