Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/amirmujkic/multi_bug
:bug: Bug reporting via multiple platforms :ant:
https://github.com/amirmujkic/multi_bug
airbrake bug bugs bugsnag error-monitoring error-reporting exceptions hacktoberfest rails ruby
Last synced: 29 days ago
JSON representation
:bug: Bug reporting via multiple platforms :ant:
- Host: GitHub
- URL: https://github.com/amirmujkic/multi_bug
- Owner: amirmujkic
- License: mit
- Created: 2018-12-12T08:15:41.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-04-29T19:22:32.000Z (over 3 years ago)
- Last Synced: 2024-03-14T22:24:31.487Z (10 months ago)
- Topics: airbrake, bug, bugs, bugsnag, error-monitoring, error-reporting, exceptions, hacktoberfest, rails, ruby
- Language: Ruby
- Homepage:
- Size: 22.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
MultiBug
Error reporting via multiple platforms.
---
## Features
- Easily switch error monitoring provider by changing config only
- Supported adapters
- [Airbrake](https://github.com/airbrake/airbrake-ruby)
- [Bugsnag](https://github.com/bugsnag/bugsnag-ruby)
- Upcoming features
- Aditional adapters for [Sentry](https://github.com/getsentry/raven-ruby) and [Rollbar](https://github.com/rollbar/rollbar-gem)
- Advanced configuration
- Support for common advanced features
## Getting started
To install, run:
gem install multi_bug
Add the following to your Gemfile:
gem "multi_bug", '~> 0.2.2'
After you've added the `multi_bug` 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](https://github.com/airbrake/airbrake-ruby#installation)
- [Bugsnag](https://docs.bugsnag.com/platforms/ruby/rails/#installation)
## Usage
### Reporting exceptions
After installing one of the supported gems, reporting of unhandled exceptions should happen automatically and be visible in their respective monitoring dashboard.
Reporting of handled exceptions can be done with:
```ruby
begin
raise 'Robots are taking over!'
rescue => exception
MultiBug.notify(exception)
end
```
#### Custom payload
If you need to add custom payload to the error report you can do this by providing an options hash.
```ruby
begin
raise 'Robots are taking over!'
rescue => exception
MultiBug.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](https://semver.org) 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](CONTRIBUTING.md) for details.
## License
Copyright 2018 []().
Read [LICENSE](LICENSE.md) for details.
## History
Read [CHANGES](CHANGES.md) for details.