diagnostic

Documentation

Index

• func Register(ctx context.Context, conf *Config, r *http.ServeMux) (func(), error)
• type Config
  • func (c *Config) Validate() error

Functions

func Register

func Register(ctx context.Context, conf *Config, r *http.ServeMux) (func(), error)

Register adds diagnostic tools to main process

Types

type Config

type Config struct {
	GOPS struct {
		Enabled   bool   `toml:"enabled" default:"false" comment:"Enable GOPS agent"`
		RemoteURL string `toml:"remoteDebugURL" comment:"start a gops agent on specified URL. Ex: localhost:9999"`
	}
	PProf struct {
		Enabled bool `toml:"enabled" default:"true" comment:"Enable PProf handler"`
	}
	ZPages struct {
		Enabled bool `toml:"enabled" default:"true" comment:"Enable zPages handler"`
	}
}

Config holds information for diagnostic handlers.

func (*Config) Validate

func (c *Config) Validate() error

Validate checks that the configuration is valid.