debug

README

go-debug

This library provides a very simple method for compile-time or runtime determined debug checks, set using build tags.

The compile-time checks use Go constants, so when disabled your debug code will not be compiled.

The possible build tags are:

• "debug" || "" = debug determined at compile-time

• "debugenv" = debug determined at runtime using the $DEBUG environment variable

An example for how this works in practice can be seen by the following code:

func main() {
	println("debug.DEBUG() =", debug.DEBUG())
}

# Debug determined at compile-time, it is disabled
$ go run .
debug.DEBUG() = false

# Debug determined at compile-time, it is enabled
$ go run -tags=debug .
debug.DEBUG() = true

# Debug determined at runtime, $DEBUG is not set
$ go run -tags=debugenv .
debug.DEBUG() = false

# Debug determined at runtime, $DEBUG is set
$ DEBUG=y go run -tags=debugenv .
debug.DEBUG() = true

Documentation

Index

• Constants
• func BuildInfo(name string) string
• func Run(fn func())
• func ServePprof(addr string) error
• func WithPprof(handler http.Handler) http.Handler

Constants

const DEBUG = false

DEBUG returns whether debugging is enabled.

Functions

func BuildInfo

func BuildInfo(name string) string

BuildInfo will return a useful new-line separated build info string for current binary, setting name as given value.

func Run

func Run(fn func())

Run will only call fn if DEBUG is enabled.

func ServePprof

func ServePprof(addr string) error

ServePprof will start an HTTP server serving /debug/pprof only if debug enabled.

func WithPprof

func WithPprof(handler http.Handler) http.Handler

WithPprof will add /debug/pprof handling (provided by "net/http/pprof") only if debug enabled.