Module: Raygun

Extended by:
Testable
Defined in:
lib/raygun/sidekiq.rb,
lib/raygun.rb,
lib/raygun/error.rb,
lib/raygun/client.rb,
lib/raygun/version.rb,
lib/raygun/testable.rb,
lib/raygun/breadcrumbs.rb,
lib/raygun/affected_user.rb,
lib/raygun/configuration.rb,
lib/raygun/breadcrumbs/store.rb,
lib/raygun/javascript_tracker.rb,
lib/raygun/breadcrumbs/breadcrumb.rb,
lib/generators/raygun/install_generator.rb,
lib/raygun/middleware/rack_exception_interceptor.rb,
lib/raygun/middleware/rails_insert_affected_user.rb,
lib/raygun/middleware/breadcrumbs_store_initializer.rb,
lib/raygun/services/apply_whitelist_filter_to_payload.rb

Overview

Client for injecting JavaScript code for tracking front end exceptions raygun.com/docs/languages/javascript

Defined Under Namespace

Modules: Breadcrumbs, Middleware, Services, Testable Classes: AffectedUser, Client, Configuration, Error, InstallGenerator, ItWorksException, JavaScriptTracker, Railtie, SidekiqMiddleware, SidekiqReporter

Constant Summary collapse

CLIENT_URL =

used to identify ourselves to Raygun

"https://github.com/MindscapeHQ/raygun4ruby"
CLIENT_NAME = 
"Raygun4Ruby Gem"
VERSION = 
"3.1.1"

Class Attribute Summary collapse

Class Method Summary collapse

Methods included from Testable

track_test_exception

Class Attribute Details

.configuration ⇒ Object 



48
49
50
 
# File 'lib/raygun.rb', line 48

def configuration
  @configuration ||= Configuration.new
end

Class Method Details

.configured? ⇒ Boolean

Returns:

  • (Boolean) 


60
61
62
 
# File 'lib/raygun.rb', line 60

def configured?
  !!configuration.api_key
end

.default_configuration ⇒ Object 



52
53
54
 
# File 'lib/raygun.rb', line 52

def default_configuration
  configuration.defaults
end

.deprecation_warning(message) ⇒ Object 



114
115
116
117
118
119
120
 
# File 'lib/raygun.rb', line 114

def deprecation_warning(message)
  if defined?(ActiveSupport::Deprecation)
    ActiveSupport::Deprecation.warn(message)
  else
    puts message
  end
end

.failsafe_log(message) ⇒ Object 



110
111
112
 
# File 'lib/raygun.rb', line 110

def failsafe_log(message)
  configuration.failsafe_logger.info(message)
end

.log(message) ⇒ Object 



104
105
106
107
108
 
# File 'lib/raygun.rb', line 104

def log(message)
  return unless configuration.debug

  configuration.logger.info("[Raygun] #{message}") if configuration.logger
end

.record_breadcrumb(message: nil, category: '', level: :info, timestamp: Time.now.utc, metadata: {}, class_name: nil, method_name: nil, line_number: nil) ⇒ Object 



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/raygun.rb', line 80

def record_breadcrumb(
    message: nil,
    category: '',
    level: :info,
    timestamp: Time.now.utc,
    metadata: {},
    class_name: nil,
    method_name: nil,
    line_number: nil
)
  log('recording breadcrumb')

  Raygun::Breadcrumbs::Store.record(
    message: message,
    category: category,
    level: level,
    timestamp: timestamp,
    metadata: metadata,
    class_name: class_name,
    method_name: method_name,
    line_number: line_number,
  )
end

.reset_configuration ⇒ Object 



56
57
58
 
# File 'lib/raygun.rb', line 56

def reset_configuration
  @configuration = Configuration.new
end

.setup {|configuration| ... } ⇒ Object

Yields:



42
43
44
45
46
 
# File 'lib/raygun.rb', line 42

def setup
  yield(configuration)

  log("configuration settings: #{configuration.inspect}")
end

.track_exception(exception_instance, env = {}, user = nil, retry_count = 1) ⇒ Object 



64
65
66
67
68
69
70
71
72
 
# File 'lib/raygun.rb', line 64

def track_exception(exception_instance, env = {}, user = nil, retry_count = 1)
  log('tracking exception')

  if configuration.send_in_background
    track_exception_async(exception_instance, env, user, retry_count)
  else
    track_exception_sync(exception_instance, env, user, retry_count)
  end
end

.track_exceptions ⇒ Object 



74
75
76
77
78
 
# File 'lib/raygun.rb', line 74

def track_exceptions
  yield
rescue => e
  track_exception(e)
end