lrstanley / recoverer

Simple Go http middleware to catch (and optionally display) panics gracefully

🔗 Table of Contents

• Why
• Examples
  • Using net/http's default ServeMux
  • Using go-chi
• Screenshot
• Support & Assistance
• Contributing
• License

❔ Why

recoverer is a simple Go http middleware to catch (and optionally display when debugging) panics, and attempt to gracefully recover them. recoverer also has the ability to display such errors (and exported expvar variables) via a clean and simple html generated error page (shown below).

Examples

go get -u github.com/lrstanley/recoverer@latest

Using net/http's default ServeMux

package main

import (
	"log"
	"net/http"
	"os"

	"github.com/lrstanley/recoverer"
)

func hello(w http.ResponseWriter, r *http.Request) {
	panic("uhoh.. things happened.")

	w.Write([]byte("Hello World!
"))
}

func main() {
	rec := recoverer.New(recoverer.Options{
		Logger: os.Stderr, Show: true, Simple: false,
	})

	http.Handle("/", rec(http.HandlerFunc(hello)))

	log.Fatal(http.ListenAndServe(":8080", nil))
}

Using go-chi

package main

import (
	"net/http"
	"os"

	"github.com/go-chi/chi"
	"github.com/go-chi/chi/middleware"
	"github.com/lrstanley/recoverer"
)

func main() {
	r := chi.NewRouter()

	r.Use(recoverer.New(recoverer.Options{Logger: os.Stderr, Show: true, Simple: false}))
	r.Use(middleware.Logger)
	r.Use(middleware.DefaultCompress)

	r.Get("/", func(w http.ResponseWriter, r *http.Request) {
		w.Write([]byte("Hello World!
"))

		panic("uhoh.. things happened.")
	})

    log.Fatal(http.ListenAndServe(":8080", r))
}

Screenshot

🙋‍♂️ Support & Assistance

• ❤️ Please review the Code of Conduct for guidelines on ensuring everyone has the best experience interacting with the community.
• 🙋‍♂️ Take a look at the support document on guidelines for tips on how to ask the right questions.
• 🐞 For all features/bugs/issues/questions/etc, head over here.

🤝 Contributing

• ❤️ Please review the Code of Conduct for guidelines on ensuring everyone has the best experience interacting with the community.
• 📋 Please review the contributing doc for submitting issues/a guide on submitting pull requests and helping out.
• 🗝️ For anything security related, please review this repositories security policy.

⚖️ License

MIT License

Copyright (c) 2017 Liam Stanley <[e-mail]>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Also located here