Class: Hoodoo::Services::Middleware::ExceptionReporting::RaygunReporter

Inherits:
BaseReporter show all
Defined in:
lib/hoodoo/services/middleware/exception_reporting/reporters/raygun_reporter.rb

Overview

Hoodoo::Services::Middleware::ExceptionReporting::BaseReporter subclass giving Hoodoo::Services::Middleware::ExceptionReporting access to Raygun for error reporting. See raygun.io.

Your application must include the Raygun gem ‘raygun4ruby’ via Gemfile (+gem ‘raygun4ruby’+ / bundle install) or direct installation (gem install raygun4ruby+).

The API key must be set during your application initialization and the class must be added to Hoodoo for use as an error reporter, e.g. through a ‘config/initializers’ folder, as follows:

require 'raygun4ruby'

Raygun.setup do | config |
  config.api_key = 'YOUR_RAYGUN_API_KEY'
end

Hoodoo::Services::Middleware::ExceptionReporting.add(
  Hoodoo::Services::Middleware::ExceptionReporting::RaygunReporter
) unless Service.config.env.test? || Service.config.env.development?

Services and the Hoodoo middleware do not pass Rails-like params around in forms or query strings, but do beware of search or filter query data containing sensitive material or POST bodies in e.g. JSON encoding containing sensitive data. This comes down to the filtering ability of the Raygun gem:

https://github.com/MindscapeHQ/raygun4ruby

Instance Method Summary collapse

Methods inherited from BaseReporter

#communicate

Methods inherited from Communicators::Slow

#communicate, #dropped

Instance Method Details

#contextual_report(e, context) ⇒ Object

Report an exception for errors that occur within a fully handled Rack request context, with a high level processed Hoodoo representation available.

e

Exception (or subclass) instance to be reported.

context

Hoodoo::Services::Context instance describing an in-flight request/response cycle.



68
69
70
71
72
73
 
# File 'lib/hoodoo/services/middleware/exception_reporting/reporters/raygun_reporter.rb', line 68

def contextual_report( e, context )
  hash = context.owning_interaction.rack_request.env rescue {}
  hash = hash.merge( :custom_data => user_data_for( context ) || { 'user_data' => 'unknown' } )

  Raygun.track_exception( e, hash )
end

#report(e, env = nil) ⇒ Object

Report an exception to Raygun.

e

Exception (or subclass) instance to be reported.

env

Optional Rack environment hash for the inbound request, for exception reports made in the context of Rack request handling.



55
56
57
 
# File 'lib/hoodoo/services/middleware/exception_reporting/reporters/raygun_reporter.rb', line 55

def report( e, env = nil )
  Raygun.track_exception( e, env )
end