debug

Documentation

Index

• Variables
• func IsEnabled(cfg *Config) bool
• func RegisterFgprof(mux *ServeMux)
• func RegisterPprof(mux *ServeMux)
• func RegisterPsutil(mux *ServeMux, cont *content.Content)
• func RegisterStatsviz(mux *ServeMux) error
• type CPU
• type Config
• type Mem
• type Response
• type ServeMux
  • func NewServeMux() *ServeMux
• type Server
  • func NewServer(params ServerParams) (*Server, error)
  • func (s *Server) GetServer() *server.Service
• type ServerParams

Variables

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

Module for fx.

Functions

func IsEnabled

func IsEnabled(cfg *Config) bool

IsEnabled for HTTP.

func RegisterFgprof

func RegisterFgprof(mux *ServeMux)

RegisterFgprof for debug.

func RegisterPprof

func RegisterPprof(mux *ServeMux)

RegisterPprof for debug.

func RegisterPsutil

func RegisterPsutil(mux *ServeMux, cont *content.Content)

RegisterPprof for debug.

func RegisterStatsviz

func RegisterStatsviz(mux *ServeMux) error

RegisterStatsviz for debug.

Types

type CPU

type CPU struct {
	Info  []cpu.InfoStat  `yaml:"info,omitempty" json:"info,omitempty" toml:"info,omitempty"`
	Times []cpu.TimesStat `yaml:"times,omitempty" json:"times,omitempty" toml:"times,omitempty"`
}

CPU for debug.

type Config

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

Config for HTTP.

type Mem

type Mem struct {
	Swap    *mem.SwapMemoryStat    `yaml:"swap,omitempty" json:"swap,omitempty" toml:"swap,omitempty"`
	Virtual *mem.VirtualMemoryStat `yaml:"virtual,omitempty" json:"virtual,omitempty" toml:"virtual,omitempty"`
	Devices []*mem.SwapDevice      `yaml:"devices,omitempty" json:"devices,omitempty" toml:"devices,omitempty"`
}

Mem for debug.

type Response

type Response struct {
	CPU *CPU `yaml:"cpu,omitempty" json:"cpu,omitempty" toml:"cpu,omitempty"`
	Mem *Mem `yaml:"mem,omitempty" json:"mem,omitempty" toml:"mem,omitempty"`
}

Response for debug.

type ServeMux

type ServeMux struct {
	*http.ServeMux
}

ServeMux is a wrapper around http.ServeMux.

func NewServeMux

func NewServeMux() *ServeMux

NewServeMux creates a new ServeMux.

type Server

type Server struct {
	*server.Service
}

Server for debug.

func NewServer

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

NewServer for debug.

func (*Server) GetServer

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

GetServer returns the server, if defined.

type ServerParams

type ServerParams struct {
	fx.In

	Shutdowner fx.Shutdowner
	Mux        *ServeMux
	Config     *Config
	Logger     *logger.Logger
	FS         *os.FS
}

ServerParams for debug.