debug

package

v0.2.2 Latest Latest Go to latest Published: May 14, 2024 License: BSD-3-Clause Imports: 3 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/heroku/x

Links

Open Source Insights

Documentation ¶

Overview ¶

Package debug wraps the gops agent for use as a cmdutil-compatible Server.

The debug server will be started on DEBUG_PORT (default 9999). Get a stack trace, profile memory, etc. by running the gops command line connected to locahost:9999 like:

$ gops stack localhost:9999
goroutine 50 [running]:
  runtime/pprof.writeGoroutineStacks(0x4a18a20, 0xc000010138, 0x0, 0x0)
  	/usr/local/Cellar/go/1.13.5/libexec/src/runtime/pprof/pprof.go:679 +0x9d
  runtime/pprof.writeGoroutine(0x4a18a20, 0xc000010138, 0x2, 0x0, 0x0)
  ...

Learn more about gops at https://github.com/google/gops.

Index ¶

type Config
type Server
- func New(l logrus.FieldLogger, port int) *Server
- func (s *Server) Run() error
- func (s *Server) Stop(_ error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Config ¶

type Config struct {
	Port int `env:"DEBUG_PORT,default=9999"`
}

Config describes the configurable parameters for debugging.

type Server ¶

type Server struct {
	// contains filtered or unexported fields
}

Server wraps a gops server for easy use with oklog/group.

func New ¶

func New(l logrus.FieldLogger, port int) *Server

New inializes a debug server listening on the provided port.

Connect to the debug server with gops:

gops stack localhost:PORT

func (*Server) Run ¶

func (s *Server) Run() error

Run starts the debug server.

It implements oklog group's runFn.

func (*Server) Stop ¶

func (s *Server) Stop(_ error)

Stop shuts down the debug server.

It implements oklog group's interruptFn.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL