sajoku / go.airbrake

Airbrake package

go.airbrake

go.airbrake provides airbrake v3 error logging functionality.

Installation

go get github.com/GeertJohan/go.airbrake

Usage

First, create a Brake:

brake := airbrake.NewBrake("projectID", "apiKey", "application environment", nil)

Then, use the brake when there is a problem:

brake.Error("household", "All the food is gone!")

Use Errorf for formatted strings (fmt.Sprintf shorthand):

roof := "roof"
fire := "fire!"
brake.Errorf("house-structure", "The %s is on %s", roof, fire)

Send data with your error:

brake.ErrorData("data-dump", "some error message here", airbrake.Data{
	Environment: airbrake.Vars{"GOPATH": os.Getenv("GOPATH")},
	Session:     airbrake.Vars{"AccountID": 1337},
	Params:      airbrake.Vars{
		"filename": "foo.bar",
		"object": airbrake.Vars{
			"foo": "bar",
			"number": 42,
		}
	},
})

You can also use the brake to recover from a panic

func doStuff() {
	defer brake.Recover()

	// do stuff

	// suddenly, a wild panic appears
	panic("oh noes! a panic!")
}

The deferred call to brake.Recover() recovers from the panic and sends the message to Airbrake.io. Error class will be "panic".

You can use the WrapHTTP* methods to wrap any http.Handler or http.HandlerFunc. This recovers the Handler/HandlerFunc from any panic.

//++ TODO, test and example

TODO

• think about airb.at
• make human log configurable (disable type, disable message, cap message to chars (0=infinite), disable url)
• more TODO's in code