vikarti.anatra/safing-portbase
1
0
Fork 0
mirror of https://github.com/safing/portbase synced 2025-09-01 10:09:50 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Improve profiling API endpoint docs

Browse source
This commit is contained in:
Daniel 2022-09-22 14:36:22 +02:00
parent eda7a122db
commit 52a2a1f673
1 changed files with 29 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

44
api/endpoints_debug.go
View file

@ -7,6 +7,7 @@ import (
"net/http" "net/http"
"os" "os"
"runtime/pprof" "runtime/pprof"
"strings"
"time" "time"
"github.com/safing/portbase/utils/debug" "github.com/safing/portbase/utils/debug"
@ -44,11 +45,16 @@ func registerDebugEndpoints() error {
} }
if err := RegisterEndpoint(Endpoint{ if err := RegisterEndpoint(Endpoint{
Path: "debug/cpu", Path: "debug/cpu",
Read: PermitAnyone, Read: PermitAnyone,
DataFunc: handleCPUProfile, DataFunc: handleCPUProfile,
Name: "Get CPU Profile", Name: "Get CPU Profile",
Description: "", Description: strings.ReplaceAll(`Gather and return the CPU profile.
This data needs to gathered over a period of time, which is specified using the duration parameter.
You can easily view this data in your browser with this command (with Go installed):
"go tool pprof -http :8888 http://127.0.0.1:817/api/v1/debug/cpu"
`, `"`, "`"),
Parameters: []Parameter{{ Parameters: []Parameter{{
Method: http.MethodGet, Method: http.MethodGet,
Field: "duration", Field: "duration",
@ -60,21 +66,29 @@ func registerDebugEndpoints() error {
} }
if err := RegisterEndpoint(Endpoint{ if err := RegisterEndpoint(Endpoint{
Path: "debug/heap", Path: "debug/heap",
Read: PermitAnyone, Read: PermitAnyone,
DataFunc: handleHeapProfile, DataFunc: handleHeapProfile,
Name: "Get Heap Profile", Name: "Get Heap Profile",
Description: "", Description: strings.ReplaceAll(`Gather and return the heap memory profile.
You can easily view this data in your browser with this command (with Go installed):
"go tool pprof -http :8888 http://127.0.0.1:817/api/v1/debug/heap"
`, `"`, "`"),
}); err != nil { }); err != nil {
return err return err
} }
if err := RegisterEndpoint(Endpoint{ if err := RegisterEndpoint(Endpoint{
Path: "debug/allocs", Path: "debug/allocs",
Read: PermitAnyone, Read: PermitAnyone,
DataFunc: handleAllocsProfile, DataFunc: handleAllocsProfile,
Name: "Get Allocs Profile", Name: "Get Allocs Profile",
Description: "", Description: strings.ReplaceAll(`Gather and return the memory allocation profile.
You can easily view this data in your browser with this command (with Go installed):
"go tool pprof -http :8888 http://127.0.0.1:817/api/v1/debug/allocs"
`, `"`, "`"),
}); err != nil { }); err != nil {
return err return err
} }