gl_exception_notifier

Give Lively Exception Notifier

This is GiveLively's exception notification wrapper. The goal of this gem is to provide the charity api with a clean set of exception and logging apis regardless of what exception client is used under the hood.

Currently we use sentry-ruby. GLExceptionNotifier isolates the main charity api app from the exception notifier in use.

Installation

Add this line to your application's Gemfile:

gem 'gl_exception_notifier'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install gl_exception_notifier

Usage

GLExceptionNotifier supports the following:

Record an Exception

Capture exceptions with the call method.

  begin
    raise StandardError
  rescue StandardError => error
    GLExceptionNotifier.call(error)
  end

Adding Context

The add_context method takes two arguments, first a type which must be symbol: :tags_context, :user_context, or :extra_context. Second, a Hash of parameters to add to the given context type.

# add tags to the context
GLExceptionNotifier.add_context(:tags_context, my_tag: my_tag_value)

# add user info to the context
GLExceptionNotifier.add_context(:user_context, user_id: user_id)

# add extra info to the context
GLExceptionNotifier.add_context(:extra_context, more_info: { interesting_data: 1234, more_data: 'hello world' })

Add Breadcrumbs to Context

The breadcrumbs method takes two arguments, first a message which must be a String, and second a Hash of data to add to the context's breadcrumb trail.

GLExceptionNotifier.breadcrumbs(message: 'foo', data: { bar: 'baz' })

Breadcrumb Inspection

For testing purposes, we may wish to inspect the last breadcrumb. To do so, we provide a last_breadcrumb method.

# spec/...
describe '#method' do
  let(:breadcrumb) { GLExceptionNotifier.last_breadcrumb }

  it 'adds correct message' do
    expect(breadcrumb.message).to eq expected_message
  end

  it 'adds correct data' do
    expect(breadcrumb.data).to eq expected_data
  end
end