debug

Documentation

Index

• func BlockHandler() gin.HandlerFunc
• func CmdlineHandler() gin.HandlerFunc
• func GoroutineHandler() gin.HandlerFunc
• func HeapHandler() gin.HandlerFunc
• func IndexHandler() gin.HandlerFunc
• func ProfileHandler() gin.HandlerFunc
• func SymbolHandler() gin.HandlerFunc
• func ThreadCreateHandler() gin.HandlerFunc
• func TraceHandler() gin.HandlerFunc

Functions

func BlockHandler

func BlockHandler() gin.HandlerFunc

BlockHandler

@Summary		Get pprof stack traces that led to blocking on synchronization primitives
@Description	Only available, when server was started with WOODPECKER_LOG_LEVEL=debug
@Router			/debug/pprof/block [get]
@Produce		plain
@Success		200
@Tags			Process profiling and debugging
@Param			Authorization	header	string	true	"Insert your personal access token"	default(Bearer <personal access token>)

func CmdlineHandler

func CmdlineHandler() gin.HandlerFunc

CmdlineHandler

@Summary		Get the command line invocation of the current program
@Description	Only available, when server was started with WOODPECKER_LOG_LEVEL=debug
@Router			/debug/pprof/cmdline [get]
@Produce		plain
@Success		200
@Tags			Process profiling and debugging
@Param			Authorization	header	string	true	"Insert your personal access token"	default(Bearer <personal access token>)

func GoroutineHandler

func GoroutineHandler() gin.HandlerFunc

GoroutineHandler

@Summary		Get pprof stack traces of all current goroutines
@Description	Only available, when server was started with WOODPECKER_LOG_LEVEL=debug
@Router			/debug/pprof/goroutine [get]
@Produce		plain
@Success		200
@Tags			Process profiling and debugging
@Param			Authorization	header	string	true	"Insert your personal access token"															default(Bearer <personal access token>)
@Param			debug			query	int		false	"Use debug=2 as a query parameter to export in the same format as an un-recovered panic"	default(1)

func HeapHandler

func HeapHandler() gin.HandlerFunc

HeapHandler

@Summary		Get pprof heap dump, a sampling of memory allocations of live objects
@Description	Only available, when server was started with WOODPECKER_LOG_LEVEL=debug
@Router			/debug/pprof/heap [get]
@Produce		plain
@Success		200
@Tags			Process profiling and debugging
@Param			Authorization	header	string	true	"Insert your personal access token"									default(Bearer <personal access token>)
@Param			gc				query	string	false	"You can specify gc=heap to run GC before taking the heap sample"	default()

func IndexHandler

func IndexHandler() gin.HandlerFunc

IndexHandler

@Summary		List available pprof profiles (HTML)
@Description	Only available, when server was started with WOODPECKER_LOG_LEVEL=debug
@Router			/debug/pprof [get]
@Produce		html
@Success		200
@Tags			Process profiling and debugging
@Param			Authorization	header	string	true	"Insert your personal access token"	default(Bearer <personal access token>)

func ProfileHandler

func ProfileHandler() gin.HandlerFunc

ProfileHandler

@Summary		Get pprof CPU profile
@Description	Only available, when server was started with WOODPECKER_LOG_LEVEL=debug
@Description	After you get the profile file, use the go tool pprof command to investigate the profile.
@Router			/debug/pprof/profile [get]
@Produce		plain
@Success		200
@Tags			Process profiling and debugging
@Param			Authorization	header	string	true	"Insert your personal access token"								default(Bearer <personal access token>)
@Param			seconds			query	int		true	"You can specify the duration in the seconds GET parameter."	default	(30)

func SymbolHandler

func SymbolHandler() gin.HandlerFunc

SymbolHandler

@Summary		Get pprof program counters mapping to function names
@Description	Only available, when server was started with WOODPECKER_LOG_LEVEL=debug
@Description	Looks up the program counters listed in the request,
@Description	responding with a table mapping program counters to function names.
@Description	The requested program counters can be provided via GET + query parameters,
@Description	or POST + body parameters. Program counters shall be space delimited.
@Router			/debug/pprof/symbol [get]
@Router			/debug/pprof/symbol [post]
@Produce		plain
@Success		200
@Tags			Process profiling and debugging
@Param			Authorization	header	string	true	"Insert your personal access token"	default(Bearer <personal access token>)

func ThreadCreateHandler

func ThreadCreateHandler() gin.HandlerFunc

ThreadCreateHandler

@Summary		Get pprof stack traces that led to the creation of new OS threads
@Description	Only available, when server was started with WOODPECKER_LOG_LEVEL=debug
@Router			/debug/pprof/threadcreate [get]
@Produce		plain
@Success		200
@Tags			Process profiling and debugging
@Param			Authorization	header	string	true	"Insert your personal access token"	default(Bearer <personal access token>)

func TraceHandler

func TraceHandler() gin.HandlerFunc

TraceHandler

@Summary		Get a trace of execution of the current program
@Description	Only available, when server was started with WOODPECKER_LOG_LEVEL=debug
@Description	After you get the profile file, use the go tool pprof command to investigate the profile.
@Router			/debug/pprof/trace [get]
@Produce		plain
@Success		200
@Tags			Process profiling and debugging
@Param			Authorization	header	string	true	"Insert your personal access token"								default(Bearer <personal access token>)
@Param			seconds			query	int		true	"You can specify the duration in the seconds GET parameter."	default	(30)