debug

README

debug

Debug plugin.

• Expvar HTTP endpoint.
• Pprof HTTP endpoint.

Install

go get github.com/atreugo/debug

Contributing

Feel free to contribute... 😉

Documentation

Index

• func Register(s *atreugo.Atreugo, cfg Config)
• type Config
• type ExpvarConfig
• type PprofConfig

Functions

func Register

func Register(s *atreugo.Atreugo, cfg Config)

Register registers the debug plugin to the server with the given configuration.

Types

type Config

type Config struct {
	Expvar ExpvarConfig
	Pprof  PprofConfig
}

Config is the configuration for the Debug plugin.

type ExpvarConfig

type ExpvarConfig struct {
	// Method is the HTTP method to use for the metrics endpoint.
	//
	// Default: "GET"
	Method string

	// URL is the HTTP URL to scrape for expvar metrics.
	//
	// Default: "/debug/vars"
	URL string
}

ExpvarConfig is the expvar configuration.

type PprofConfig

type PprofConfig struct {
	// Method is the HTTP method to use for the metrics endpoint.
	//
	// Default: "GET"
	Method string

	// URL is the HTTP URL to scrape for pprof metrics.
	//
	// Default: "/debug/pprof/{profile:*}"
	URL string
}

PprofConfig is the pprof configuration.