debug

Documentation

Index

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

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.