Add PProf to admin pages and to gitea manager
#22742
+733
−93
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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,100 @@ | ||
| // Copyright 2023 The Gitea Authors. All rights reserved. | ||
| // SPDX-License-Identifier: MIT | ||
|
|
||
| package process | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "fmt" | ||
| "io" | ||
| ) | ||
|
|
||
| // WriteProcesses writes out processes to a provided writer | ||
| func WriteProcesses(out io.Writer, processes []*Process, processCount int, goroutineCount int64, indent string, flat bool) error { | ||
| if goroutineCount > 0 { | ||
| if _, err := fmt.Fprintf(out, "%sTotal Number of Goroutines: %d\n", indent, goroutineCount); err != nil { | ||
| return err | ||
| } | ||
| } | ||
| if _, err := fmt.Fprintf(out, "%sTotal Number of Processes: %d\n", indent, processCount); err != nil { | ||
| return err | ||
| } | ||
| if len(processes) > 0 { | ||
| if err := WriteProcess(out, processes[0], indent+" ", flat); err != nil { | ||
| return err | ||
| } | ||
| } | ||
| if len(processes) > 1 { | ||
| for _, process := range processes[1:] { | ||
| if _, err := fmt.Fprintf(out, "%s |\n", indent); err != nil { | ||
| return err | ||
| } | ||
| if err := WriteProcess(out, process, indent+" ", flat); err != nil { | ||
| return err | ||
| } | ||
| } | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| // WriteProcess writes out a process to a provided writer | ||
| func WriteProcess(out io.Writer, process *Process, indent string, flat bool) error { | ||
| sb := &bytes.Buffer{} | ||
| if flat { | ||
| if process.ParentPID != "" { | ||
| _, _ = fmt.Fprintf(sb, "%s+ PID: %s\t\tType: %s\n", indent, process.PID, process.Type) | ||
| } else { | ||
| _, _ = fmt.Fprintf(sb, "%s+ PID: %s:%s\tType: %s\n", indent, process.ParentPID, process.PID, process.Type) | ||
| } | ||
| } else { | ||
| _, _ = fmt.Fprintf(sb, "%s+ PID: %s\tType: %s\n", indent, process.PID, process.Type) | ||
| } | ||
| indent += "| " | ||
|
|
||
| _, _ = fmt.Fprintf(sb, "%sDescription: %s\n", indent, process.Description) | ||
| _, _ = fmt.Fprintf(sb, "%sStart: %s\n", indent, process.Start) | ||
|
|
||
| if len(process.Stacks) > 0 { | ||
| _, _ = fmt.Fprintf(sb, "%sGoroutines:\n", indent) | ||
| for _, stack := range process.Stacks { | ||
| indent := indent + " " | ||
| _, _ = fmt.Fprintf(sb, "%s+ Description: %s", indent, stack.Description) | ||
| if stack.Count > 1 { | ||
| _, _ = fmt.Fprintf(sb, "* %d", stack.Count) | ||
| } | ||
| _, _ = fmt.Fprintf(sb, "\n") | ||
| indent += "| " | ||
| if len(stack.Labels) > 0 { | ||
| _, _ = fmt.Fprintf(sb, "%sLabels: %q:%q", indent, stack.Labels[0].Name, stack.Labels[0].Value) | ||
|
|
||
| if len(stack.Labels) > 1 { | ||
| for _, label := range stack.Labels[1:] { | ||
| _, _ = fmt.Fprintf(sb, ", %q:%q", label.Name, label.Value) | ||
| } | ||
| } | ||
| _, _ = fmt.Fprintf(sb, "\n") | ||
| } | ||
| _, _ = fmt.Fprintf(sb, "%sStack:\n", indent) | ||
| indent += " " | ||
zeripath marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| for _, entry := range stack.Entry { | ||
| _, _ = fmt.Fprintf(sb, "%s+ %s\n", indent, entry.Function) | ||
| _, _ = fmt.Fprintf(sb, "%s| %s:%d\n", indent, entry.File, entry.Line) | ||
| } | ||
| } | ||
| } | ||
| if _, err := out.Write(sb.Bytes()); err != nil { | ||
| return err | ||
| } | ||
| sb.Reset() | ||
| if len(process.Children) > 0 { | ||
| if _, err := fmt.Fprintf(out, "%sChildren:\n", indent); err != nil { | ||
| return err | ||
| } | ||
| for _, child := range process.Children { | ||
| if err := WriteProcess(out, child, indent+" ", flat); err != nil { | ||
| return err | ||
| } | ||
| } | ||
| } | ||
| return nil | ||
| } | ||
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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,187 @@ | ||
| // Copyright 2022 The Gitea Authors. All rights reserved. | ||
| // SPDX-License-Identifier: MIT | ||
|
|
||
| package admin | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "net/http" | ||
| "runtime/pprof" | ||
| "runtime/trace" | ||
| "strconv" | ||
| "time" | ||
|
|
||
| "code.gitea.io/gitea/modules/context" | ||
| "code.gitea.io/gitea/modules/process" | ||
| "code.gitea.io/gitea/modules/setting" | ||
|
|
||
| "github.com/felixge/fgprof" | ||
| ) | ||
|
|
||
| // PProfProcessStacktrace returns the stacktrace similar to GoroutineStacktrace but without rendering it | ||
| func PProfProcessStacktrace(ctx *context.Context) { | ||
| flat := ctx.FormBool("flat") | ||
| noSystem := ctx.FormBool("no-system") | ||
|
|
||
| format := ctx.FormString("format") | ||
| jsonFormat := format == "json" | ||
delvh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| start := time.Now() | ||
| filename := "process-stacktrace-" + strconv.FormatInt(start.Unix(), 10) | ||
| if jsonFormat { | ||
| filename += ".json" | ||
| } | ||
|
|
||
| processStacks, processCount, goroutineCount, err := process.GetManager().ProcessStacktraces(flat, noSystem) | ||
| if err != nil { | ||
| ctx.ServerError("ProcessStacktraces", err) | ||
| } | ||
|
|
||
| ctx.SetServeHeaders(&context.ServeHeaderOptions{ | ||
| Filename: filename, | ||
| LastModified: start, | ||
| }) | ||
|
|
||
| if jsonFormat { | ||
| ctx.JSON(http.StatusOK, map[string]interface{}{ | ||
| "TotalNumberOfGoroutines": goroutineCount, | ||
| "TotalNumberOfProcesses": processCount, | ||
| "Processes": processStacks, | ||
| }) | ||
| return | ||
| } | ||
|
|
||
| if err := process.WriteProcesses(ctx.Resp, processStacks, processCount, goroutineCount, "", flat); err != nil { | ||
| ctx.ServerError("WriteProcesses", err) | ||
| } | ||
| } | ||
|
|
||
| // PProfFGProfile returns the Full Go Profile from fgprof | ||
| func PProfFGProfile(ctx *context.Context) { | ||
| durationStr := ctx.FormString("duration") | ||
| duration := 30 * time.Second | ||
| if durationStr != "" { | ||
| var err error | ||
| duration, err = time.ParseDuration(durationStr) | ||
| if err != nil { | ||
| ctx.Flash.Error(ctx.Tr("admin.monitor.pprof.duration_invalid")) | ||
| ctx.Redirect(setting.AppSubURL + "/admin/monitor") | ||
| return | ||
| } | ||
| } | ||
|
|
||
| format := fgprof.Format(ctx.FormString("format")) | ||
| if format != fgprof.FormatFolded { | ||
| format = fgprof.FormatPprof | ||
| } | ||
delvh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| start := time.Now() | ||
|
|
||
| ctx.SetServeHeaders(&context.ServeHeaderOptions{ | ||
| Filename: "fgprof-profile-" + strconv.FormatInt(start.Unix(), 10), | ||
| LastModified: start, | ||
| }) | ||
|
|
||
| fn := fgprof.Start(ctx.Resp, format) | ||
|
|
||
| select { | ||
| case <-time.After(duration): | ||
| case <-ctx.Done(): | ||
| } | ||
|
|
||
| err := fn() | ||
| if err != nil { | ||
| ctx.ServerError("fgprof.Write", err) | ||
| } | ||
| } | ||
|
|
||
| // PProfCPUProfile returns the PProf CPU Profile | ||
| func PProfCPUProfile(ctx *context.Context) { | ||
| durationStr := ctx.FormString("duration") | ||
| duration := 30 * time.Second | ||
| if durationStr != "" { | ||
| var err error | ||
| duration, err = time.ParseDuration(durationStr) | ||
| if err != nil { | ||
| ctx.Flash.Error(ctx.Tr("admin.monitor.pprof.duration_invalid")) | ||
| ctx.Redirect(setting.AppSubURL + "/admin/monitor") | ||
| return | ||
| } | ||
| } | ||
|
|
||
| start := time.Now() | ||
|
|
||
| ctx.SetServeHeaders(&context.ServeHeaderOptions{ | ||
| Filename: "cpu-profile-" + strconv.FormatInt(start.Unix(), 10), | ||
| LastModified: start, | ||
| }) | ||
|
|
||
| err := pprof.StartCPUProfile(ctx.Resp) | ||
| if err != nil { | ||
| ctx.ServerError("StartCPUProfile", err) | ||
| return | ||
| } | ||
|
|
||
| select { | ||
| case <-time.After(duration): | ||
| case <-ctx.Done(): | ||
| } | ||
| pprof.StopCPUProfile() | ||
| } | ||
|
|
||
| // PProfNamedProfile returns the PProf Profile | ||
| func PProfNamedProfile(ctx *context.Context) { | ||
| name := ctx.FormString("name") | ||
| profile := pprof.Lookup(name) | ||
| if profile == nil { | ||
| ctx.ServerError(fmt.Sprintf("pprof.Lookup(%s)", name), fmt.Errorf("missing profile: %s", name)) | ||
| return | ||
| } | ||
|
|
||
| debug := ctx.FormInt("debug") | ||
|
|
||
| start := time.Now() | ||
|
|
||
| ctx.SetServeHeaders(&context.ServeHeaderOptions{ | ||
| Filename: name + "-profile-" + strconv.FormatInt(start.Unix(), 10), | ||
| LastModified: start, | ||
| }) | ||
| if err := profile.WriteTo(ctx.Resp, debug); err != nil { | ||
| ctx.ServerError(fmt.Sprintf("PProfNamedProfile(%s).WriteTo", name), err) | ||
| return | ||
delvh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
| } | ||
|
|
||
| // Trace returns a trace | ||
| func Trace(ctx *context.Context) { | ||
| durationStr := ctx.FormString("duration") | ||
| duration := 30 * time.Second | ||
| if durationStr != "" { | ||
| var err error | ||
| duration, err = time.ParseDuration(durationStr) | ||
| if err != nil { | ||
| ctx.Flash.Error(ctx.Tr("admin.monitor.pprof.duration_invalid")) | ||
| ctx.Redirect(setting.AppSubURL + "/admin/monitor") | ||
| return | ||
| } | ||
| } | ||
|
|
||
| start := time.Now() | ||
|
|
||
| ctx.SetServeHeaders(&context.ServeHeaderOptions{ | ||
| Filename: "trace-" + strconv.FormatInt(start.Unix(), 10), | ||
| LastModified: start, | ||
| }) | ||
|
|
||
| err := trace.Start(ctx.Resp) | ||
| if err != nil { | ||
| ctx.ServerError("StartCPUProfile", err) | ||
| return | ||
| } | ||
|
|
||
| select { | ||
| case <-time.After(duration): | ||
| case <-ctx.Done(): | ||
| } | ||
| trace.Stop() | ||
| } | ||
This file contains hidden or 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 hidden or 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 hidden or 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,96 @@ | ||
| <h4 class="ui top attached header"> | ||
| {{.locale.Tr "admin.monitor.pprof"}} | ||
| </h4> | ||
| <div class="ui attached segment"> | ||
| <p>{{.locale.Tr "admin.monitor.pprof.description"}}</p> | ||
| <p>{{.locale.Tr "admin.monitor.pprof.description_2"}}</p> | ||
delvh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| <h4>{{.locale.Tr "admin.monitor.pprof.cpuprofile"}}</h4> | ||
| <form action="{{AppSubUrl}}/admin/monitor/cpu-profile"> | ||
| <div class="ui form"> | ||
| <div class="help">{{.locale.Tr "admin.monitor.pprof.cpuprofile.description"}}</div> | ||
| <div class="field"> | ||
| <label for="pprof-cpuprofile-duration">{{.locale.Tr "admin.monitor.pprof.duration"}}</label> | ||
| <input id="pprof-cpuprofile-duration" type="text" name="duration" placeholder="{{.locale.Tr "admin.monitor.pprof.duration_placeholder"}}"> | ||
| </div> | ||
| <input class="ui button basic" type="submit" value="{{.locale.Tr "admin.monitor.pprof.download"}}"> | ||
| </div> | ||
| </form> | ||
| <h4>{{.locale.Tr "admin.monitor.pprof.fgprof"}}</h4> | ||
| <form action="{{AppSubUrl}}/admin/monitor/fgprof"> | ||
| <div class="ui form"> | ||
| <div class="help">{{.locale.Tr "admin.monitor.pprof.fgprof.description"}}</div> | ||
| <div class="field"> | ||
| <label for="pprof-fgprof-duration">{{.locale.Tr "admin.monitor.pprof.duration"}}</label> | ||
| <input id="pprof-fgprof-duration" type="text" name="duration" placeholder="{{.locale.Tr "admin.monitor.pprof.duration_placeholder"}}"> | ||
| </div> | ||
| <div class="field"> | ||
| <label for="pprof-fgprof-format">{{.locale.Tr "admin.monitor.pprof.fgprof.format"}}</label> | ||
| <select class="ui search dropdown" id="pprof-fgprof-format" name="format"> | ||
| <option value="pprof" selected>pprof</option> | ||
| <option value="folded">folded</option> | ||
| </select> | ||
| </div> | ||
| <input class="ui button basic" type="submit" value="{{.locale.Tr "admin.monitor.pprof.download"}}"> | ||
| </div> | ||
| </form> | ||
| <h4>{{.locale.Tr "admin.monitor.stacktrace"}}</h4> | ||
| <form action="{{AppSubUrl}}/admin/monitor/stacktrace-profile"> | ||
| <div class="ui form"> | ||
| <div class="help">{{.locale.Tr "admin.monitor.pprof.stacktrace.description"}}</div> | ||
| <div class="inline field"> | ||
| <div class="ui checkbox"> | ||
| <input id="pprof-stacktrace-flat" type="checkbox" tabindex="0" class="hidden" name="flat"> | ||
zeripath marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| <label for="pprof-stacktrace-flat">{{.locale.Tr "admin.monitor.pprof.stacktrace.flat"}}</label> | ||
| </div> | ||
| </div> | ||
| <div class="inline field"> | ||
| <div class="ui checkbox"> | ||
| <input id="pprof-stacktrace-no-system" type="checkbox" tabindex="0" class="hidden" name="no-system"> | ||
zeripath marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| <label for="pprof-stacktrace-no-system">{{.locale.Tr "admin.monitor.pprof.stacktrace.no-system"}}</label> | ||
| </div> | ||
| </div> | ||
| <div class="field"> | ||
| <label for="pprof-stacktrace-format">{{.locale.Tr "admin.monitor.pprof.stacktrace.format"}}</label> | ||
| <select class="ui search dropdown" id="pprof-stacktrace-format" name="format"> | ||
| <option value="text" selected>text</option> | ||
| <option value="json">json</option> | ||
| </select> | ||
| </div> | ||
| <input class="ui button basic" type="submit" value="{{.locale.Tr "admin.monitor.pprof.download"}}"> | ||
| </div> | ||
| </form> | ||
| <h4>{{.locale.Tr "admin.monitor.pprof.named_profiles"}}</h4> | ||
| <form action="{{AppSubUrl}}/admin/monitor/profile"> | ||
| <div class="ui form"> | ||
| <div class="help">{{.locale.Tr "admin.monitor.pprof.named_profiles.description"}}</div> | ||
| <div class="field"> | ||
| <label for="pprof-named_profiles-name">{{.locale.Tr "admin.monitor.pprof.named_profiles.name"}}</label> | ||
| <select class="ui search dropdown" id="pprof-named_profiles-name" name="name"> | ||
| {{range .Profiles}} | ||
| <option value="{{.Name}}">{{.Name}}</option> | ||
| {{end}} | ||
| </select> | ||
| </div> | ||
| <div class="field"> | ||
| <label for="pprof-named_profiles-debug">{{$.locale.Tr "admin.monitor.pprof.named_profiles.debug"}}</label> | ||
| <select class="ui search dropdown" id="pprof-named_profiles-debug" name="format"> | ||
| <option value="0" selected>{{.locale.Tr "admin.monitor.pprof.named_profiles.format_pprof"}}</option> | ||
| <option value="1">{{.locale.Tr "admin.monitor.pprof.named_profiles.format_text"}}</option> | ||
| <option value="2">{{.locale.Tr "admin.monitor.pprof.named_profiles.format_goroutine"}}</option> | ||
zeripath marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| </select> | ||
| </div> | ||
| <input class="ui button basic" type="submit" value="{{$.locale.Tr "admin.monitor.pprof.download"}}"> | ||
| </div> | ||
| </form> | ||
| <h4>{{.locale.Tr "admin.monitor.pprof.trace"}}</h4> | ||
| <form action="{{AppSubUrl}}/admin/monitor/trace"> | ||
| <div class="ui form"> | ||
| <div class="help">{{.locale.Tr "admin.monitor.pprof.trace.description"}}</div> | ||
| <div class="field"> | ||
| <label for="pprof-trace-duration">{{.locale.Tr "admin.monitor.pprof.duration"}}</label> | ||
| <input id="pprof-trace-duration" type="text" name="duration" placeholder="{{.locale.Tr "admin.monitor.pprof.duration_placeholder"}}"> | ||
| </div> | ||
| <input class="ui button basic" type="submit" value="{{.locale.Tr "admin.monitor.pprof.download"}}"> | ||
| </div> | ||
| </form> | ||
| </div> | ||
This file contains hidden or 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 hidden or 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.