Recover

Recover middleware recovers from panics anywhere in the chain, prints stack trace and handles the control to the centralized HTTPErrorHandler.

Usage

  1. e.Use(middleware.Recover())

Custom Configuration

Usage

  1. e := echo.New()
  2. e.Use(middleware.RecoverWithConfig(middleware.RecoverConfig{
  3.   StackSize: 1 << 10, // 1 KB
  4.   LogLevel:  log.ERROR,
  5. }))

Example above uses a StackSize of 1 KB, LogLevel of error and default values for DisableStackAll and DisablePrintStack.

Configuration

  1. // LogErrorFunc defines a function for custom logging in the middleware.
  2. LogErrorFunc func(c echo.Context, err error, stack []byte) error
  4. RecoverConfig struct {
  5.   // Skipper defines a function to skip middleware.
  6.   Skipper Skipper
  8.   // Size of the stack to be printed.
  9.   // Optional. Default value 4KB.
  10.   StackSize int `yaml:"stack_size"`
  12.   // DisableStackAll disables formatting stack traces of all other goroutines
  13.   // into buffer after the trace for the current goroutine.
  14.   // Optional. Default value false.
  15.   DisableStackAll bool `yaml:"disable_stack_all"`
  17.   // DisablePrintStack disables printing stack trace.
  18.   // Optional. Default value as false.
  19.   DisablePrintStack bool `yaml:"disable_print_stack"`
  21.   // LogLevel is log level to printing stack trace.
  22.   // Optional. Default value 0 (Print).
  23.   LogLevel log.Lvl
  25.   // LogErrorFunc defines a function for custom logging in the middleware.
  26.   // If it's set you don't need to provide LogLevel for config.
  27.   LogErrorFunc LogErrorFunc
  28. }

Default Configuration

  1. DefaultRecoverConfig = RecoverConfig{
  2.   Skipper:           DefaultSkipper,
  3.   StackSize:         4 << 10, // 4 KB
  4.   DisableStackAll:   false,
  5.   DisablePrintStack: false,
  6.   LogLevel:          0,
  7.   LogErrorFunc:      nil,
  8. }