Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rollbar/rollbar-gem

Exception tracking and logging from Ruby to Rollbar
https://github.com/rollbar/rollbar-gem

crash-reporting crash-reports error-handler error-monitoring error-reporting exceptions observability rack-middleware rails resque rollbar ruby sinatra stacktrace uncaught-exceptions

Last synced: 7 days ago
JSON representation

Exception tracking and logging from Ruby to Rollbar

Awesome Lists containing this project

README 

        


  rollbar-logo




Rollbar Ruby Gem





  Proactively discover, predict, and resolve errors in real-time with Rollbar’s error monitoring platform. Start tracking errors today!




![Build Status](https://github.com/rollbar/rollbar-gem/workflows/Rollbar-gem%20CI/badge.svg?tag=latest)

[![Gem Version](https://badge.fury.io/rb/rollbar.svg)](http://badge.fury.io/rb/rollbar)

[![SemVer](https://api.dependabot.com/badges/compatibility_score?dependency-name=rollbar&package-manager=bundler&version-scheme=semver&target-version=latest)](https://dependabot.com/compatibility-score.html?dependency-name=rollbar&package-manager=bundler&version-scheme=semver&new-version=latest)



---



[Rollbar](https://rollbar.com) is a real-time exception reporting service for Ruby and other languages. The Rollbar service will alert you of problems with your code and help you understand them in a ways never possible before. We love it and we hope you will too.



Rollbar-gem is the SDK for Ruby apps and includes support for apps using Rails, Sinatra, Rack, plain Ruby, and other frameworks.



## Key benefits of using Rollbar Ruby Gem are:



- **Frameworks:** Rollbar Ruby Gem supports popular Ruby frameworks such as Rails, Sinatra, Grape and more.

- **Integrations:** Rollbar Ruby has integrations for Resque, ActiveJob, rollbar-agent, Sidekiq and more!

- **Automatic error grouping:** Rollbar aggregates Occurrences caused by the same error into Items that represent application issues. Learn more about reducing log noise.

- **Advanced search:** Filter items by many different properties. Learn more about search.

- **Customizable notifications:** Rollbar supports several messaging and incident management tools where your team can get notified about errors and important events by real-time alerts. Learn more about Rollbar notifications.



## Setup Instructions



1. [Sign up for a Rollbar account](https://rollbar.com/signup)

2. Follow the [Getting Started](https://docs.rollbar.com/docs/ruby#section-getting-started) instructions in our [Ruby SDK docs](https://docs.rollbar.com/docs/ruby) to install rollbar-gem and configure it for your platform.



## Usage and Reference



For complete usage instructions and configuration reference, see our [Ruby SDK docs](https://docs.rollbar.com/docs/ruby).



## Compatibility



Version >= 3.0.0 is compatible with Ruby >= 2.0.0.



Version >= 2.19.0 is compatible with Ruby >= 1.9.3.



Version < 2.19.0 is compatible with Ruby >= 1.8.7.



### Ruby 2.6.0



> WARNING: Ruby 2.6.0 introduced a new bug ([#15472 -

Invalid JSON data being sent from Net::HTTP in some cases with Ruby 2.6.0](https://bugs.ruby-lang.org/issues/15472)) that may result in the Rollbar API returning an error when an exception is reported.  (See [rollbar-gem issue #797](https://github.com/rollbar/rollbar-gem/issues/797)).



> UPDATE: This bug is fixed in Ruby 2.6.1, and rollbar-gem has a safe workaround in version >= 2.19.0.

If you need to stay on Ruby 2.6.0 for any reason, make sure you have the latest rollbar-gem.



## Release History & Changelog



See our [Releases](https://github.com/rollbar/rollbar-gem/releases) page for a list of all releases, including changes.



## Help / Support



If you run into any issues, please email us at [[email protected]](mailto:[email protected])



For bug reports, please [open an issue on GitHub](https://github.com/rollbar/rollbar-gem/issues/new).



## Contributing



1. Fork it

2. Create your feature branch (```git checkout -b my-new-feature```).

3. Commit your changes (```git commit -am 'Added some feature'```)

4. Push to the branch (```git push origin my-new-feature```)

5. Create new Pull Request



We're using RSpec for testing. Run the test suite with ```rake spec```. Tests for pull requests are appreciated but not required. (If you don't include a test, we'll write one before merging.)



## License

Rollbar-gem is free software released under the MIT License. See [LICENSE](LICENSE) for details.