debug

package

v2.286.0 Latest Latest Go to latest Published: Feb 17, 2026 License: MIT Imports: 17 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/alexfalkowski/go-service

Links

Open Source Insights

Documentation ¶

Overview ¶

Package debug provides debug endpoints and profiling helpers for go-service.

Index ¶

Variables
type Config
- func (c *Config) IsEnabled() bool
type Server
- func NewServer(params ServerParams) (*Server, error)
- func (s *Server) GetService() *server.Service
type ServerParams

Constants ¶

This section is empty.

Variables ¶

View Source

var Module = di.Module(
	di.Constructor(http.NewServeMux),
	di.Constructor(NewServer),
	di.Register(statsviz.Register),
	di.Register(pprof.Register),
	di.Register(fgprof.Register),
	di.Register(psutil.Register),
)

Module for fx.

Functions ¶

This section is empty.

Types ¶

type Config ¶

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

Config configures the debug server.

func (*Config) IsEnabled ¶ added in v2.115.0

func (c *Config) IsEnabled() bool

IsEnabled reports whether debug configuration is present and enabled.

type Server ¶

type Server struct {
	*server.Service
}

Server wraps the debug HTTP service.

func NewServer ¶

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

NewServer constructs the debug server if enabled; otherwise it returns nil.

func (*Server) GetService ¶ added in v2.26.0

func (s *Server) GetService() *server.Service

GetService returns the service, if defined.

type ServerParams ¶

type ServerParams struct {
	di.In
	Shutdowner di.Shutdowner
	Mux        *debug.ServeMux
	Config     *Config
	Logger     *logger.Logger
	FS         *os.FS
}

ServerParams defines dependencies for constructing the debug server.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
fgprof Package fgprof provides Fx wiring to expose fgprof profiling over HTTP.	Package fgprof provides Fx wiring to expose fgprof profiling over HTTP.
http Package http provides debug HTTP endpoints for go-service.	Package http provides debug HTTP endpoints for go-service.
pprof Package pprof provides Fx wiring to expose net/http/pprof profiling endpoints.	Package pprof provides Fx wiring to expose net/http/pprof profiling endpoints.
psutil Package psutil provides debug endpoints and profiling helpers for go-service.	Package psutil provides debug endpoints and profiling helpers for go-service.
statsviz Package statsviz provides Fx wiring to expose statsviz diagnostics over HTTP.	Package statsviz provides Fx wiring to expose statsviz diagnostics over HTTP.

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