Celerbrake

Celerbrake is the Ruby/Rails integration gem for Celerbrake — a self-hosted error- and exception-tracking service. Add it to a Rack-compliant app and unhandled exceptions are captured and shipped to your Celerbrake instance automatically, with full backtraces, request context, and per-error grouping.

It builds on the celerbrake-ruby notifier and adds out-of-the-box integrations for Rails, Sinatra, Sidekiq, Resque, Delayed Job, Shoryuken, Sneakers, ActiveJob, Rack, and more.

Heritage. Celerbrake began as a fork of the airbrake gem (v13.0.2) and stays wire-compatible with the Airbrake v3 create-notice API. The difference is where your errors go: a Celerbrake instance you run, with a default host of https://api.celerbrake.com instead of a third-party service. We're grateful to Airbrake Technologies, Inc. for the original, MIT-licensed work — see LICENSE.md.

gem 'celerbrake'

gem install celerbrake

Generate the initializer with your project credentials (find these on your Celerbrake instance under /admin/projects/:id):

bundle exec rails generate celerbrake PROJECT_ID PROJECT_KEY

This writes config/initializers/celerbrake.rb. The generated initializer reads from environment variables, so you can also set credentials without regenerating:

CELERBRAKE_PROJECT_ID=1
CELERBRAKE_PROJECT_KEY=...the api_key from the admin page...

To point at your own instance instead of the default https://api.celerbrake.com, add a host line to the initializer:

# config/initializers/celerbrake.rb
Celerbrake.configure do |c|
  c.project_id  = ENV.fetch('CELERBRAKE_PROJECT_ID').to_i
  c.project_key = ENV.fetch('CELERBRAKE_PROJECT_KEY')
  c.host        = ENV.fetch('CELERBRAKE_HOST') # e.g. https://errors.example.com
  c.environment = Rails.env
  c.ignore_environments = %w[development test]
end

Once configured, Celerbrake installs its Rack middleware, subscribes to Rails instrumentation, and hooks ActiveJob — unhandled exceptions are reported with no further code.

For non-Rails apps, configure celerbrake-ruby directly and require only the integrations you need:

require 'celerbrake'

Celerbrake.configure do |c|
  c.project_id  = 123
  c.project_key = 'fa0123456789abcdef0123456789abcd'
  c.host        = 'https://errors.example.com'
end

require 'celerbrake/sidekiq'   # Sidekiq middleware
require 'celerbrake/resque'    # Resque failure backend
require 'celerbrake/rack'      # Generic Rack middleware
require 'celerbrake/delayed_job'

begin
  raise 'Oops!'
rescue => exception
  Celerbrake.notify(exception)
end

See celerbrake-ruby for the full notifier API (notify, notify_sync, filters, blocklist keys, and configuration options).

Rails (Railtie, ActiveJob, ActionCable, ActiveRecord, ActionController), Rack, Sinatra, Sidekiq, Resque, Delayed Job, Shoryuken, Sneakers, Capistrano, and Rake — the same set shipped by the upstream gem.

bundle install
bundle exec rspec
bundle exec rubocop

Celerbrake is released under the MIT License. It is a derivative work of the airbrake gem, also MIT-licensed; the original copyright is preserved in LICENSE.md.