Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
joel committed Mar 2, 2017
1 parent 2d48dff commit e4898b2
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

[![Build Status](https://travis-ci.org/FinalCAD/airbrake_proxy.png?branch=master)](https://travis-ci.org/FinalCAD/airbrake_proxy) (Travis CI)

[![Coverage Status](https://coveralls.io/repos/FinalCAD/airbrake_proxy/badge.png)](https://coveralls.io/r/FinalCAD/airbrake_proxy)
[![Coverage Status](https://coveralls.io/repos/github/FinalCAD/airbrake_proxy/badge.svg?branch=master)](https://coveralls.io/github/FinalCAD/airbrake_proxy?branch=master)

Basic Circuit Breaker to attempt not reach Airbrake limit for the same exception

Expand All @@ -20,6 +20,28 @@ Add this line to your application's Gemfile:
gem 'airbrake_proxy'
```

Please add a config file on your project.

Rails sample

`config/initializers/airbrake_proxy.rb`

```ruby
AirbrakeProxy.configure do |conf|
conf.redis = Resque.redis
conf.logger = Rails.logger
end
```

in `spec/spec_helper.rb` or `spec/rails_helper.rb`

```ruby
AirbrakeProxy.configure do |conf|
conf.redis = MockRedis.new
conf.logger = Logger.new($stderr)
end
```

And then execute:

$ bundle
Expand All @@ -30,6 +52,7 @@ Or install it yourself as:

## Usage

Simply use `AirbrakeProxy.notify(exception)` in your code instead of `Airbrake.notify exception`

## Development

Expand Down

0 comments on commit e4898b2

Please sign in to comment.