Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lrstanley/recoverer
Simple Go http middleware to catch (and optionally display) panics gracefully
https://github.com/lrstanley/recoverer
go golang http http-middleware
Last synced: about 1 month ago
JSON representation
Simple Go http middleware to catch (and optionally display) panics gracefully
- Host: GitHub
- URL: https://github.com/lrstanley/recoverer
- Owner: lrstanley
- License: mit
- Created: 2017-09-22T12:30:12.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-09-14T07:16:53.000Z (2 months ago)
- Last Synced: 2024-09-14T18:37:24.266Z (2 months ago)
- Topics: go, golang, http, http-middleware
- Language: Go
- Homepage: https://pkg.go.dev/github.com/lrstanley/recoverer
- Size: 69.3 KB
- Stars: 6
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
- Support: .github/SUPPORT.md
Awesome Lists containing this project
README
## :link: Table of Contents
- [Why](#grey_question-why)
- [Examples](#examples)
- [Using net/http's default ServeMux](#using-nethttps-default-servemux)
- [Using go-chi](#using-go-chi)
- [Screenshot](#screenshot)
- [Support & Assistance](#raising_hand_man-support--assistance)
- [Contributing](#handshake-contributing)
- [License](#balance_scale-license)
## :grey_question: 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
```console
go get -u github.com/lrstanley/recoverer@latest
```
### Using net/http's default ServeMux
```go
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
```go
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
## :raising_hand_man: Support & Assistance
* :heart: Please review the [Code of Conduct](.github/CODE_OF_CONDUCT.md) for
guidelines on ensuring everyone has the best experience interacting with
the community.
* :raising_hand_man: Take a look at the [support](.github/SUPPORT.md) document on
guidelines for tips on how to ask the right questions.
* :lady_beetle: For all features/bugs/issues/questions/etc, [head over here](https://github.com/lrstanley/recoverer/issues/new/choose).
## :handshake: Contributing
* :heart: Please review the [Code of Conduct](.github/CODE_OF_CONDUCT.md) for guidelines
on ensuring everyone has the best experience interacting with the
community.
* :clipboard: Please review the [contributing](.github/CONTRIBUTING.md) doc for submitting
issues/a guide on submitting pull requests and helping out.
* :old_key: For anything security related, please review this repositories [security policy](https://github.com/lrstanley/recoverer/security/policy).
## :balance_scale: License
```
MIT License
Copyright (c) 2017 Liam Stanley
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](LICENSE)_