Skip to content

Commit

Permalink
Add documentation for Sentry notifier
Browse files Browse the repository at this point in the history
  • Loading branch information
tfausak committed Aug 4, 2016
1 parent 88fd2e9 commit 2f890ac
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ Check out [stoplight-admin][] for controlling your stoplights.
- [HipChat](#hipchat)
- [Honeybadger](#honeybadger)
- [Logger](#logger)
- [Sentry](#sentry)
- [Slack](#slack)
- [Rails](#rails-1)
- [Advanced usage](#advanced-usage)
Expand Down Expand Up @@ -356,6 +357,22 @@ Stoplight::Light.default_notifiers += [notifier]
# => [#<Stoplight::Notifier::IO:...>, #<Stoplight::Notifier::Logger:...>]
```

#### Sentry

Make sure you have [the Sentry gem][] (`~> 1.2`) installed before configuring
Stoplight.

``` rb
require 'sentry-raven'
# => true
configuration = Raven::Configuration.new
# => #<Raven::Configuration:...>
notifier = Stoplight::Notifier::Raven.new(configuration)
# => #<Stoplight::Notifier::Raven:...>
Stoplight::Light.default_notifiers += [notifier]
# => [#<Stoplight::Notifier::IO:...>, #<Stoplight::Notifier::Raven:...>]
```

#### Slack

Make sure you have [the Slack gem][] (`~> 1.3`) installed before configuring
Expand Down Expand Up @@ -476,6 +493,7 @@ Stoplight is licensed under [the MIT License][].
[the HipChat gem]: https://rubygems.org/gems/hipchat
[the Honeybadger gem]: https://rubygems.org/gems/honeybadger
[the Logger class]: http://ruby-doc.org/stdlib-2.2.3/libdoc/logger/rdoc/Logger.html
[the Sentry gem]: https://rubygems.org/gems/sentry-raven
[the Slack gem]: https://rubygems.org/gems/slack-notifier
[@camdez]: https://github.com/camdez
[@tfausak]: https://github.com/tfausak
Expand Down

0 comments on commit 2f890ac

Please sign in to comment.