debug

Documentation

Index

• Variables
• func IsEnabled(c *Config) bool
• func RegisterPprof(server *Server)
• func RegisterPsutil(server *Server, json *marshaller.JSON)
• func RegisterStatsviz(server *Server)
• type Config
• type Server
  • func NewServer(params ServerParams) (*Server, error)
  • func (s *Server) Start() error
  • func (s *Server) Stop(ctx context.Context) error
• type ServerParams

Variables

var ErrInvalidPort = errors.New("invalid port")

ErrInvalidPort for HTTP.

var Module = fx.Options(
	fx.Provide(NewServer),
	fx.Invoke(RegisterStatsviz),
	fx.Invoke(RegisterPprof),
	fx.Invoke(RegisterPsutil),
)

Module for fx.

Functions

func IsEnabled

func IsEnabled(c *Config) bool

IsEnabled for HTTP.

func RegisterPprof

func RegisterPprof(server *Server)

RegisterPprof for debug.

func RegisterPsutil

func RegisterPsutil(server *Server, json *marshaller.JSON)

RegisterPprof for debug.

func RegisterStatsviz

func RegisterStatsviz(server *Server)

RegisterStatsviz for debug.

Types

type Config

type Config struct {
	*server.Config `yaml:",inline" json:",inline" toml:",inline"`
}

Config for HTTP.

type Server

type Server struct {
	Mux *http.ServeMux
	// contains filtered or unexported fields
}

Server for HTTP.

func NewServer

func NewServer(params ServerParams) (*Server, error)

NewServer for HTTP.

func (*Server) Start

func (s *Server) Start() error

Start the server.

func (*Server) Stop

func (s *Server) Stop(ctx context.Context) error

Stop the server.

type ServerParams

type ServerParams struct {
	fx.In

	Shutdowner fx.Shutdowner
	Config     *Config
	Logger     *zap.Logger
}

ServerParams for HTTP.