-
-
Notifications
You must be signed in to change notification settings - Fork 3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add an "ipfs diag profile" command
This should replace the "collect-profiles.sh" script and allow users to easily collect profiles. At the moment, it just dumps all profiles into a single zip file. It does this server-side so it's easy fetch them with curl. In the future, it would be nice to add: 1. Progress indicators (cpu profiles take 30 seconds). 2. An option to specify which profiles to collect. 3. An option to specify how long the CPU profile should run. But we can handle that later. Unfortunately, this command doesn't produce symbolized svgs as I didn't want to depend on having a local go compiler.
- Loading branch information
Showing
3 changed files
with
227 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,191 @@ | ||
| package commands | ||
|
|
||
| import ( | ||
| "archive/zip" | ||
| "context" | ||
| "encoding/json" | ||
| "fmt" | ||
| "io" | ||
| "io/fs" | ||
| "os" | ||
| "runtime" | ||
| "runtime/pprof" | ||
| "strings" | ||
| "time" | ||
|
|
||
| cmds "github.com/ipfs/go-ipfs-cmds" | ||
| "github.com/ipfs/go-ipfs/core" | ||
| "github.com/ipfs/go-ipfs/core/commands/cmdenv" | ||
| "github.com/ipfs/go-ipfs/core/commands/e" | ||
| ) | ||
|
|
||
| // time format that works in filenames on windows. | ||
| var timeFormat = strings.ReplaceAll(time.RFC3339, ":", "_") | ||
|
|
||
| type profileResult struct { | ||
| File string | ||
| } | ||
|
|
||
| var sysProfileCmd = &cmds.Command{ | ||
| NoLocal: true, | ||
| Options: []cmds.Option{ | ||
| cmds.StringOption(outputOptionName, "o", "The path where the output should be stored."), | ||
| }, | ||
| Run: func(req *cmds.Request, res cmds.ResponseEmitter, env cmds.Environment) error { | ||
| nd, err := cmdenv.GetNode(env) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| r, w := io.Pipe() | ||
| go func() { | ||
| _ = w.CloseWithError(writeProfiles(req.Context, nd, w)) | ||
| }() | ||
| return res.Emit(r) | ||
| }, | ||
| PostRun: cmds.PostRunMap{ | ||
| cmds.CLI: func(res cmds.Response, re cmds.ResponseEmitter) error { | ||
| v, err := res.Next() | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| outReader, ok := v.(io.Reader) | ||
| if !ok { | ||
| return e.New(e.TypeErr(outReader, v)) | ||
| } | ||
|
|
||
| outPath, _ := res.Request().Options[outputOptionName].(string) | ||
| if outPath == "" { | ||
| outPath = "ipfs-profile-" + time.Now().Format(timeFormat) + ".zip" | ||
| } | ||
| fi, err := os.Create(outPath) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| defer fi.Close() | ||
|
|
||
| _, err = io.Copy(fi, outReader) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| return re.Emit(&profileResult{File: outPath}) | ||
| }, | ||
| }, | ||
| Encoders: cmds.EncoderMap{ | ||
| cmds.Text: cmds.MakeTypedEncoder(func(req *cmds.Request, w io.Writer, out *profileResult) error { | ||
| fmt.Fprintf(w, "Wrote profiles to: %s\n", out.File) | ||
| return nil | ||
| }), | ||
| }, | ||
| } | ||
|
|
||
| func writeProfiles(ctx context.Context, nd *core.IpfsNode, w io.Writer) error { | ||
| archive := zip.NewWriter(w) | ||
|
|
||
| // Take some profiles. | ||
| type profile struct { | ||
| name string | ||
| file string | ||
| debug int | ||
| } | ||
|
|
||
| profiles := []profile{{ | ||
| name: "goroutine", | ||
| file: "goroutines.stacks", | ||
| debug: 2, | ||
| }, { | ||
| name: "goroutine", | ||
| file: "goroutines.pprof", | ||
| }, { | ||
| name: "heap", | ||
| file: "heap.pprof", | ||
| }} | ||
|
|
||
| for _, profile := range profiles { | ||
| prof := pprof.Lookup(profile.name) | ||
| out, err := archive.Create(profile.file) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| err = prof.WriteTo(out, profile.debug) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| } | ||
|
|
||
| // Take a CPU profile. | ||
| { | ||
| out, err := archive.Create("cpu.pprof") | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| err = writeCPUProfile(ctx, out) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| } | ||
|
|
||
| // Collect info | ||
| { | ||
| out, err := archive.Create("sysinfo.json") | ||
| if err != nil { | ||
| return err | ||
| } | ||
| info, err := getInfo(nd) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| err = json.NewEncoder(out).Encode(info) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| } | ||
|
|
||
| // Collect binary | ||
| if fi, err := openIPFSBinary(); err == nil { | ||
| fname := "ipfs" | ||
| if runtime.GOOS == "windows" { | ||
| fname += ".exe" | ||
| } | ||
|
|
||
| out, err := archive.Create(fname) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| _, err = io.Copy(out, fi) | ||
| _ = fi.Close() | ||
| if err != nil { | ||
| return err | ||
| } | ||
| } | ||
| return archive.Close() | ||
| } | ||
|
|
||
| func writeCPUProfile(ctx context.Context, w io.Writer) error { | ||
| pprof.StartCPUProfile(w) | ||
| defer pprof.StopCPUProfile() | ||
| select { | ||
| case <-time.After(30 * time.Second): | ||
| case <-ctx.Done(): | ||
| return ctx.Err() | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func openIPFSBinary() (fs.File, error) { | ||
| if runtime.GOOS == "linux" { | ||
| pid := os.Getpid() | ||
| fi, err := os.Open(fmt.Sprintf("/proc/%d/exe", pid)) | ||
| if err == nil { | ||
| return fi, nil | ||
| } | ||
| } | ||
| path, err := os.Executable() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return os.Open(path) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters