bug_bot

BugBot

BugBot is a simple error monitoring gem that abstracts multiple reporting tools in one.

Features

• Easily switch error monitoring provider by changing config only
• Supported adapters
  • Airbrake
  • Bugsnag
• Upcoming features
  • Support for custom payloads and metadata
  • Aditional adapters for Sentry and Rollbar
  • Advanced configuration

Getting started

To install, run:

gem install bug_bot

Add the following to your Gemfile:

gem "bug_bot", '~> 0.1.0'

After you've added the bug_bot gem, please install one of the gems for the monitoring platform you want to use. To accomplish that, you can use one of the following installation guides:

• Airbrake
• Bugsnag

Usage

Reporting exceptions

After installing one of the supported gems, reporting of unhandled exceptions should happen automatically and be visible for you in their respective monitoring dashboard.

Report handled exceptions of errors can be done with:

begin
  raise 'Robots are taking over!'
rescue => exception
  BugBot.notify(exception)
end

Custom payload

If you need to add custom payload to the error report you can do this by providing a an options hash.

begin
  raise 'Robots are taking over!'
rescue => exception
  BugBot.notify(exception, {
    foo: {
      bar: 'baz'
    }
  })
end

Changing the provider

Changing of the monitoring provider should be easily achieved just by installing/configuring the other gem.

Tests

To test, run:

bundle exec rspec

Versioning

Read Semantic Versioning for details. Briefly, it means:

• Major (X.y.z) - Incremented for any backwards incompatible public API changes.
• Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
• Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.

Contributions

Read CONTRIBUTING for details.

License

Copyright 2018 . Read LICENSE for details.

History

Read CHANGES for details.