middleware

Documentation

Index

• Variables
• func DefaultSkipper(ctx air.Context) bool
• func Recover() air.MiddlewareFunc
• func RecoverWithConfig(config RecoverConfig) air.MiddlewareFunc
• type RecoverConfig
• type Skipper

Variables

var (
	// DefaultRecoverConfig is the default Recover middleware config.
	DefaultRecoverConfig = RecoverConfig{
		Skipper:           DefaultSkipper,
		StackSize:         4 << 10,
		DisableStackAll:   false,
		DisablePrintStack: false,
	}
)

Functions

func DefaultSkipper

func DefaultSkipper(ctx air.Context) bool

DefaultSkipper returns false which processes the middleware.

func Recover

func Recover() air.MiddlewareFunc

func RecoverWithConfig

func RecoverWithConfig(config RecoverConfig) air.MiddlewareFunc

Types

type RecoverConfig

type RecoverConfig struct {
	// Skipper defines a function to skip middleware.
	Skipper Skipper

	// Size of the stack to be printed.
	// Optional. Default value 4KB.
	StackSize int `yaml:"stack_size"`

	// DisableStackAll disables formatting stack traces of all other goroutines
	// into buffer after the trace for the current goroutine.
	// Optional. Default value false.
	DisableStackAll bool `yaml:"disable_stack_all"`

	// DisablePrintStack disables printing stack trace.
	// Optional. Default value as false.
	DisablePrintStack bool `yaml:"disable_print_stack"`
}

RecoverConfig defines the config for Recover middleware.

type Skipper

type Skipper func(ctx air.Context) bool