safely

Documentation

Index

• func Go(f func())
• func Middleware(next http.Handler) http.Handler
• func Recover()
• func Run(r Runnable)
• func TombGo(t *tomb.Tomb, f func() error)
• type ErrPanicked
  • func (e *ErrPanicked) Error() string
• type Runnable

Functions

func Go

func Go(f func())

Go executes a supplied function and recovers from any panics that happen, logging those panics with a severity sufficient to push them to whatever error recording systems are registered as logrus hooks (i.e. bugsnag). It's meant to be called like: go safely.Go(...)

func Middleware

func Middleware(next http.Handler) http.Handler

func Recover

func Recover()

Recover recovers a panic, if any, and submits it to bugsnag through logrus (assuming that handler is registered) before terminating the program for real.

func Run

func Run(r Runnable)

func TombGo

func TombGo(t *tomb.Tomb, f func() error)

TombGo is the compose of Go and tomb.Go. Unlike Go though, the supplied function must return an error, because that's what tomb expects.

Types

type ErrPanicked

type ErrPanicked struct {
	// contains filtered or unexported fields
}

ErrPanicked is passed to bugsnag when we instrument a panic.

func (*ErrPanicked) Error

func (e *ErrPanicked) Error() string

type Runnable

type Runnable interface {
	// Tomb returns this Runnable's tomb used for lifecycle management.
	Tomb() *tomb.Tomb

	// Run begins the Runnable's main run loop.
	Run() error
}