debug

Documentation

Index

• type Option
  • func WithAddr(addr string) Option
  • func WithAuthToken(token string) Option
  • func WithLogger(logger log.Logger) Option
  • func WithPrefix(prefix string) Option
• type Server
  • func StartServer(opts ...Option) (*Server, error)
  • func (s *Server) Shutdown() error
  • func (s *Server) Start() error

Types

type Option

type Option func(*Server)

Option is the functional option type for Server.

func WithAddr

func WithAddr(addr string) Option

WithAddr sets the address to bind to.

func WithAuthToken

func WithAuthToken(token string) Option

WithAuthToken sets the auth token to use. If it is unset, there is no auth.

func WithLogger

func WithLogger(logger log.Logger) Option

WithLogger sets the logger to use.

func WithPrefix

func WithPrefix(prefix string) Option

WithPrefix sets the URL prefix to use.

type Server

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

Server is the debug server struct. It should be created through StartServer.

func StartServer

func StartServer(opts ...Option) (*Server, error)

StartServer creates and starts a new debug server using the provided functional Options.

func (*Server) Shutdown

func (s *Server) Shutdown() error

Shutdown stops the running debug server.

func (*Server) Start

func (s *Server) Start() error