recovr

README

recovr

Recovr is a HTTP middleware that catches any panics and serves a proper error response.

Works with all frameworks that support native http handler (eg. Echo, Goji, etc.).

Installation

$ go get github.com/afansv/recovr

Usage

package main

import (
    "net/http"

    "github.com/afansv/recovr"
)

var myPanicHandler = http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
    panic("you should not have a handler that just panics ;)")
})

func main() {
    recovery := recovr.New()
    app := recovery(myPanicHandler)
    http.ListenAndServe("0.0.0.0:3000", app)
}

Examples

Echo Example

import "github.com/labstack/echo/v4"

func main() {
    e := echo.New()
    e.Use(echo.WrapMiddleware(recovr.New()))
    e.Logger.Fatal(e.Start(":1323"))
}

Goji Example

import "github.com/zenazn/goji"

func main() {
    goji.Use(recovr.New())
    goji.Serve()
}

Screenshots

• Logger

• JSON

• HTML

Documentation

Overview

Package recovr is a HTTP middleware that catches any panics and serves a proper error response.

package main

import (
	"net/http"

	"github.com/afansv/recovr"
)

var myPanicHandler = http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
	panic("you should not have a handler that just panics ;)")
})

func main() {
	recovery := recovr.New()
	app := recovery(myPanicHandler)
	http.ListenAndServe("0.0.0.0:3000", app)
}

Index

• func New(opts ...Option) func(h http.Handler) http.Handler
• type Option
  • func OptionDisableLogging(disable bool) Option
  • func OptionStatusCode(statusCode int) Option

Functions

func New

func New(opts ...Option) func(h http.Handler) http.Handler

New returns a middleware that: recovers from panics, logs the panic and backtrace, writes a HTML response and Internal Server Error status.

If a JSON content type is detected it returns a JSON response.

Types

type Option

type Option struct {
	StatusCode     int
	DisableLogging *bool
}

func OptionDisableLogging

func OptionDisableLogging(disable bool) Option

func OptionStatusCode

func OptionStatusCode(statusCode int) Option