Sinatra, BugSnag, and Pretty Error Pages

Exception monitoring just didn’t seem particularly important on my little open source side project, until one day I found myself tailing Heroku production logs while asking some person I didn’t know to “try it again” so that I could see the error happen before the logs disappeared into the black hole of the not-so-distant past.

How awkward.

I was a bit giddy to discover that BugSnag loves open source, and was willing to set exercism.io up for free.

A couple of days and a bit of flailing later, I came to the unsatisfactory conclusion that I could either have a pretty error page, or I could get notified via BugSnag automatically, but I couldn’t have both.

Getting set up in Sinatra with BugSnag is deceptively easy:

-- CODE language-ruby --
   BugSnag.configure do |config|
     config.api_key = "MY_API_KEY"
   end

   class App < Sinatra::Base
     use BugSnag::Rack
     enable :raise_errors

     get '/' do
       raise 'hell'
     end
   end

BugSnag is notified, and the user is presented with a plain-text response that says, simply Internal server error.

Minimalistic, yes. Lots of whitespace, yeah, that too. But to be honest, it’s boring, unfriendly, and, frankly, kind of embarrassing.

The response can be spruced up using Sinatra’s [CODE]error[/CODE] block:

-- CODE language-ruby --
   class App < Sinatra::Base
     use BugSnag::Rack
     enable :raise_errors

     error 500 do
       erb :so_so_so_sorry
     end

     get '/' do
       raise 'hell'
     end
   end

While this does result in a nice, custom error page, the drawback is that BugSnag isn’t notified about the problem because the [CODE]error[/CODE] block gets called before the [CODE]BugSnag::Rack[/CODE] middleware can jump in and get word of the exception off to the BugSnag API.

So, forget about the [CODE]BugSnag::Rack[/CODE] middleware, that’s not going to work.

That said, all is not lost, because the [CODE]bugsnag[/CODE] gem lets you trigger notifications explicitly.

-- CODE language-ruby --
   error 500 do
     BugSnag.auto_notify($!)
     erb :so_so_so_sorry
   end

And with four lines of code you can send the most recent exception to the BugSnag API, and provide a beautiful, friendly error message to the poor individual who encountered a problem.