Public | Automated Build

Last pushed: 4 days ago
Short Description
The open source error catcher that's Airbrake API compliant
Full Description


The open source, self-hosted error catcher

Errbit is a tool for collecting and managing errors from other applications.
It is Airbrake API compliant, so if you are already using
Airbrake, you can just point the airbrake gem to your Errbit server.

<td align="center">
<a href="" target="_blank" title="Apps">
<img src="" alt="Apps">
<br />
<td align="center">
<a href="" target="_blank" title="Errors">
<img src="" alt="Errors">
<br />
<td align="center">
<a href="" target="_blank" title="Error Summary">
<img src="" alt="Error Summary">
<br />
<em>Error Summary</em>
<td align="center">
<a href="" target="_blank" title="Error Backtraces">
<img src="" alt="Error Backtraces">
<br />
<em>Error Backtraces</em>

Mailing List

Join the Google Group at to receive
updates and notifications.


The list of requirements to install Errbit are:

  • Ruby 2.3.x-2.4.x (>= 2.5.x not yet supported)
  • MongoDB 3.2.x-3.4.x (>= 3.6.x not yet supported)


Note: This app is intended for people with experience deploying and maintaining
Rails applications. If you're uncomfortable with any steps below then Errbit is not
for you.


Errbit configuration is done entirely through environment variables. See


See notes on deployment

Notice Grouping

The way Errbit arranges notices into error groups is configurable. By default,
Errbit uses the notice's error class, error message, complete backtrace,
component (or controller), action and environment name to generate a unique
fingerprint for every notice. Notices with identical fingerprints appear in the
UI as different occurences of the same error and notices with differing
fingerprints are displayed as separate errors.

Changing the fingerprinter (under the 'config' menu) applies to all apps and
the change affects only notices that arrive after the change. If you want to
refingerprint old notices, you can run rake errbit:notice_refingerprint.

Managing apps

An Errbit app is a place to collect error notifications from your external
application deployments.

See apps


Configuring GitHub authentication:

If you host Errbit at, you would fill in:

<dt>Callback URL

  • After you have registered your app, set GITHUB_CLIENT_ID and GITHUB_SECRET
    with your app's Client ID and Secret key.

When you start your application, you should see the option to Sign in with
on the Login page. You will also be able to link your GitHub profile
to your user account on your Edit profile page.

If you have signed in with GitHub, or linked your GitHub profile, and you're
working with an App that has a GitHub repo configured, then you will be able to
create issues on GitHub. If you use another issue tracker, see Issue

You can change the OAuth scope Errbit requests from GitHub by setting
GITHUB_ACCESS_SCOPE. The default ['repo'] is very permissive, but there are a
few others that could make sense for your needs:

<dd>Allow creating issues for public and private repos</dd>
<dd>Allow creating issues for public repos only</dd>
<dd>No permissions at all, but allows errbit login through github</dd>

  • GITHUB_ORG_ID is an optional environment variable you can set to your own
    github organization id. If set, only users of the specified GitHub
    organization can log in to Errbit through GitHub. Errbit will provision
    accounts for new users.

Configuring Google authentication:

If you host Errbit at, you would fill in:

<dt>Callback URL

  • After you have registered your app, set GOOGLE_CLIENT_ID and GOOGLE_SECRET
    with your app's Client ID and Secret key.

When you start your application, you should see the option to Sign in with
on the Login page. You will also be able to link your Google profile
to your user account on your Edit profile page.

Configuring LDAP authentication:

  • Follow the instructions at to set up the
    devise_ldap_authenticatable gem.
  • Set config.ldap_create_user = true in config/initializers/devise.rb, this enables creating the users from LDAP, otherwhise login will not work.
  • Create a new initializer (e.g. config/initializers/devise_ldap.rb) and add the following code to enable ldap authentication in the User-model:
Errbit::Config.devise_modules << :ldap_authenticatable
  • If you are authenticating by username, you will need to set the user's email manually
    before authentication. You must add the following lines to app/models/user.rb:
  def ldap_before_save
    name = Devise::LDAP::Adapter.get_ldap_param(self.username, "givenName")
    surname = Devise::LDAP::Adapter.get_ldap_param(self.username, "sn")
    mail = Devise::LDAP::Adapter.get_ldap_param(self.username, "mail") = (name + surname).join ' ' = mail.first
  • Now login with your user from LDAP, this will create a user in the database
  • Open a rails console and set the admin flag for your user:
user = User.first
user.admin = true!


When upgrading Errbit, please run:

git pull origin master # assuming origin is the repo
bundle install
rake db:migrate
rake db:mongoid:remove_undefined_indexes
rake db:mongoid:create_indexes
rake assets:precompile

This will ensure that your application stays up to date with any schema changes.

Upgrading errbit beyond v0.4.0

  • You must have already run migrations at least up to v0.3.0. Check to
    make sure you're schema version is at least 20131011155638 by running rake
    db:version before you upgrade beyond v0.4.0
  • Notice fingerprinting has changed and is now easy to configure. But this
    means you'll have to regenerate fingerprints on old notices in order to for
    them to be properly grouped with new notices. To do this run: rake errbit:notice_refingerprint. If you were using a custom fingerprinter class
    in a previous version, be aware that it will no longer have any effect.
    Fingerprinting is now configurable within the Errbit UI.
  • Prior to v0.4.0, users were only able to see apps they were watching. All
    users can now see all apps and they can watch or unwatch any app. If you were
    using the watch feature to hide secret apps, you should not upgrade beyond

Upgrading errbit from v0.3.0 to v0.4.0

  • All configuration is now done through the environment. See
  • Ruby 1.9 and 2.0 are no longer offically supported. Please upgrade to Ruby
  • Errbit now maintains an issue tracker only for github. If you're using
    another issue tracker integration, you may need to maintain it yourself. See
    Issue Trackers

User information in error reports

Errbit can now display information about the user who experienced an error.
This gives you the ability to ask the user for more information,
and let them know when you've fixed the bug.

The Airbrake gem will look for current_user or current_member. By default it will only send the id of the user, to specify other attributes you can set config.user_attributes. See the Airbrake wiki for more information.

If user information is received with an error report,
it will be displayed under the User Details tab:

This tab will be hidden if no user information is available.

Javascript error notifications

You can log javascript errors that occur in your application by including the
airbrake-js javascript library.

Install airbrake-js according to the docs at and set your project and host as
soon as you want to start reporting errors. Then follow along with the
documentation at

var airbrake = new airbrakeJs.Client({
  projectId: 'ERRBIT API KEY',
  projectKey: 'ERRBIT API KEY (again)',
  reporter: 'xhr',
  host: ''

Plugins and Integrations

You can extend Errbit by adding Ruby gems and plugins which are typically gems.
It's nice to keep track of which gems are core Errbit dependencies and which
gems are your own dependencies. If you want to add gems to your own Errbit,
place them in a new file called UserGemfile and Errbit will treat that file
as an additional Gemfile. If you want to use a file with a different name, you
can pass the name of that file in an environment variable named USER_GEMFILE.
If you want to use errbit_jira_plugin, just add it to UserGemfile:

echo "gem 'errbit_jira_plugin'" > UserGemfile
bundle install

Issue Trackers

Each issue tracker integration is implemented as a gem that depends on
errbit_plugin. The only officially
supported issue tracker plugin is

If you want to implement your own issue tracker plugin, read the file
at errbit_plugin.

What if Errbit has an error?

Errbit will log it's own errors to an internal app named Self.Errbit. The
Self.Errbit app is automatically created when the first error happens.

If your Errbit instance has logged an error, we would appreciate a bug report
on GitHub Issues. You can post this manually at,
or you can set up the GitHub Issues tracker for your Self.Errbit app:

  • Go to the Self.Errbit app's edit page. If that app does not exist yet,
    go to the apps page and click Add a new App to create it. (You can also
    create it by running rake airbrake:test.)
  • In the Issue Tracker section, click GitHub Issues.
  • Fill in the Account/Repository field with errbit/errbit.
  • Fill in the Username field with your github username.
  • If you are logged in on GitHub, you can find your
    API Token on this page:
  • Save the settings by clicking Update App (or Add App)
  • You can now easily post bug reports to GitHub Issues by clicking the
    Create Issue button on a Self.Errbit error.

Use Errbit with applications written in other languages

In theory, any Airbrake-compatible error catcher for other languages should work with Errbit.
Solutions known to work are listed below:

<th>PHP (>= 5.3)</th>
<th>OOP PHP (>= 5.3)</th>
<td>mkorenkov/ , pulseenergy/airbrakepy</td>

People using Errbit

See our wiki page for a list of people and companies around the world who use
. You may
edit this
, and add
your name and country to the list if you are using Errbit.

Special Thanks

See the contributors graph for more details.

Contributing to Errbit

See the contribution guidelines

Running tests

Check the .travis.yml file to see how tests are run


Copyright (c) 2010-2015 Errbit Team

Docker Pull Command
Source Repository