ipfs/kubo

Add goroutine leak profile to `ipfs diag profile`

Open

#11191 opened on Feb 10, 2026

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Go (13,906 stars) (2,725 forks)batch import
P1effort/hourshelp wantedkind/enhancement

Description

Go 1.26 ships an experimental goroutine leak profiler (GOEXPERIMENT=goroutineleakprofile). It detects goroutines blocked on channels, mutexes, or conditions that can never unblock, using GC reachability analysis. Zero runtime overhead unless actively collecting.

Available at /debug/pprof/goroutineleak when enabled.

Proposal

Once 1.27 ships with it enabled by default:

  • Add a goroutine-leak collector to ipfs diag profile --collectors (gated on the experiment being available at runtime)
  • Expose it via the existing /debug/pprof/ endpoint on the API port

This would help diagnose daemon goroutine leaks without external tooling. Useful for long-running nodes where leaked goroutines accumulate over time.

References

Contributor guide

Tech stack
go
Domain
observabilitytooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Go programmingunderstanding of pprof profiles
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
The issue proposes adding a goroutine leak collector to the `ipfs diag profile` command, gated on the Go experiment being available. Start by reading the Go 1.26 documentation on goroutine leak profiles and examining the existing collectors in the `ipfs diag profile` codebase (likely in a diagnostics package). Also review the `/debug/pprof/` endpoint implementation to see how to expose the new profile. The issue is waiting for Go 1.27 to enable it by default, but initial implementation can be done behind a build tag. Check if there are any linked PRs or comments for additional context.