debug

package

v1.147.0 Latest Latest Go to latest Published: Mar 20, 2024 License: MIT Imports: 16 Imported by: 7

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

This section is empty.

View Source

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

Module for fx.

func IsEnabled(c *Config) bool

IsEnabled for HTTP.

func RegisterPprof(server *Server)

RegisterPprof for debug.

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

RegisterPprof for debug.

func RegisterStatsviz(server *Server)

RegisterStatsviz for debug.

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

Config for HTTP.

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

Server for HTTP.

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

NewServer for HTTP.

func (s *Server) Start() error

Start the server.

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

Stop the server.

type ServerParams struct {
	fx.In

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

ServerParams for HTTP.