sentry-ruby 4.1.2 → 4.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (53) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +9 -7
  3. metadata +21 -57
  4. data/.craft.yml +0 -19
  5. data/.gitignore +0 -11
  6. data/.rspec +0 -3
  7. data/.travis.yml +0 -6
  8. data/CHANGELOG.md +0 -102
  9. data/CODE_OF_CONDUCT.md +0 -74
  10. data/Gemfile +0 -16
  11. data/Rakefile +0 -8
  12. data/bin/console +0 -14
  13. data/bin/setup +0 -8
  14. data/lib/sentry-ruby.rb +0 -152
  15. data/lib/sentry/background_worker.rb +0 -37
  16. data/lib/sentry/backtrace.rb +0 -128
  17. data/lib/sentry/benchmarks/benchmark_transport.rb +0 -14
  18. data/lib/sentry/breadcrumb.rb +0 -25
  19. data/lib/sentry/breadcrumb/sentry_logger.rb +0 -87
  20. data/lib/sentry/breadcrumb_buffer.rb +0 -47
  21. data/lib/sentry/client.rb +0 -90
  22. data/lib/sentry/configuration.rb +0 -399
  23. data/lib/sentry/core_ext/object/deep_dup.rb +0 -57
  24. data/lib/sentry/core_ext/object/duplicable.rb +0 -153
  25. data/lib/sentry/dsn.rb +0 -48
  26. data/lib/sentry/event.rb +0 -177
  27. data/lib/sentry/hub.rb +0 -137
  28. data/lib/sentry/integrable.rb +0 -24
  29. data/lib/sentry/interface.rb +0 -22
  30. data/lib/sentry/interfaces/exception.rb +0 -11
  31. data/lib/sentry/interfaces/request.rb +0 -74
  32. data/lib/sentry/interfaces/single_exception.rb +0 -14
  33. data/lib/sentry/interfaces/stacktrace.rb +0 -57
  34. data/lib/sentry/linecache.rb +0 -44
  35. data/lib/sentry/logger.rb +0 -20
  36. data/lib/sentry/rack.rb +0 -5
  37. data/lib/sentry/rack/capture_exceptions.rb +0 -62
  38. data/lib/sentry/rack/deprecations.rb +0 -19
  39. data/lib/sentry/rack/interface.rb +0 -22
  40. data/lib/sentry/rake.rb +0 -17
  41. data/lib/sentry/scope.rb +0 -214
  42. data/lib/sentry/span.rb +0 -132
  43. data/lib/sentry/transaction.rb +0 -157
  44. data/lib/sentry/transaction_event.rb +0 -29
  45. data/lib/sentry/transport.rb +0 -88
  46. data/lib/sentry/transport/configuration.rb +0 -21
  47. data/lib/sentry/transport/dummy_transport.rb +0 -14
  48. data/lib/sentry/transport/http_transport.rb +0 -62
  49. data/lib/sentry/utils/exception_cause_chain.rb +0 -20
  50. data/lib/sentry/utils/real_ip.rb +0 -70
  51. data/lib/sentry/utils/request_id.rb +0 -16
  52. data/lib/sentry/version.rb +0 -3
  53. data/sentry-ruby.gemspec +0 -27
@@ -1,37 +0,0 @@
1
- require "concurrent/executor/thread_pool_executor"
2
- require "concurrent/executor/immediate_executor"
3
-
4
- module Sentry
5
- class BackgroundWorker
6
- attr_reader :max_queue, :number_of_threads
7
-
8
- def initialize(configuration)
9
- @max_queue = 30
10
- @number_of_threads = configuration.background_worker_threads
11
-
12
- @executor =
13
- if configuration.async?
14
- configuration.logger.debug(LOGGER_PROGNAME) { "config.async is set, BackgroundWorker is disabled" }
15
- Concurrent::ImmediateExecutor.new
16
- elsif @number_of_threads == 0
17
- configuration.logger.debug(LOGGER_PROGNAME) { "config.background_worker_threads is set to 0, all events will be sent synchronously" }
18
- Concurrent::ImmediateExecutor.new
19
- else
20
- configuration.logger.debug(LOGGER_PROGNAME) { "initialized a background worker with #{@number_of_threads} threads" }
21
-
22
- Concurrent::ThreadPoolExecutor.new(
23
- min_threads: 0,
24
- max_threads: @number_of_threads,
25
- max_queue: @max_queue,
26
- fallback_policy: :discard
27
- )
28
- end
29
- end
30
-
31
- def perform(&block)
32
- @executor.post do
33
- block.call
34
- end
35
- end
36
- end
37
- end
@@ -1,128 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- ## Inspired by Rails' and Airbrake's backtrace parsers.
4
-
5
- module Sentry
6
- # Front end to parsing the backtrace for each notice
7
- class Backtrace
8
- # Handles backtrace parsing line by line
9
- class Line
10
- RB_EXTENSION = ".rb"
11
- # regexp (optional leading X: on windows, or JRuby9000 class-prefix)
12
- RUBY_INPUT_FORMAT = /
13
- ^ \s* (?: [a-zA-Z]: | uri:classloader: )? ([^:]+ | <.*>):
14
- (\d+)
15
- (?: :in \s `([^']+)')?$
16
- /x.freeze
17
-
18
- # org.jruby.runtime.callsite.CachingCallSite.call(CachingCallSite.java:170)
19
- JAVA_INPUT_FORMAT = /^(.+)\.([^\.]+)\(([^\:]+)\:(\d+)\)$/.freeze
20
-
21
- # The file portion of the line (such as app/models/user.rb)
22
- attr_reader :file
23
-
24
- # The line number portion of the line
25
- attr_reader :number
26
-
27
- # The method of the line (such as index)
28
- attr_reader :method
29
-
30
- # The module name (JRuby)
31
- attr_reader :module_name
32
-
33
- attr_reader :in_app_pattern
34
-
35
- # Parses a single line of a given backtrace
36
- # @param [String] unparsed_line The raw line from +caller+ or some backtrace
37
- # @return [Line] The parsed backtrace line
38
- def self.parse(unparsed_line, in_app_pattern)
39
- ruby_match = unparsed_line.match(RUBY_INPUT_FORMAT)
40
- if ruby_match
41
- _, file, number, method = ruby_match.to_a
42
- file.sub!(/\.class$/, RB_EXTENSION)
43
- module_name = nil
44
- else
45
- java_match = unparsed_line.match(JAVA_INPUT_FORMAT)
46
- _, module_name, method, file, number = java_match.to_a
47
- end
48
- new(file, number, method, module_name, in_app_pattern)
49
- end
50
-
51
- def initialize(file, number, method, module_name, in_app_pattern)
52
- @file = file
53
- @module_name = module_name
54
- @number = number.to_i
55
- @method = method
56
- @in_app_pattern = in_app_pattern
57
- end
58
-
59
- def in_app
60
- if file =~ in_app_pattern
61
- true
62
- else
63
- false
64
- end
65
- end
66
-
67
- # Reconstructs the line in a readable fashion
68
- def to_s
69
- "#{file}:#{number}:in `#{method}'"
70
- end
71
-
72
- def ==(other)
73
- to_s == other.to_s
74
- end
75
-
76
- def inspect
77
- "<Line:#{self}>"
78
- end
79
- end
80
-
81
- APP_DIRS_PATTERN = /(bin|exe|app|config|lib|test)/.freeze
82
-
83
- # holder for an Array of Backtrace::Line instances
84
- attr_reader :lines
85
- attr_reader :configuration
86
-
87
- def self.parse(backtrace, configuration:)
88
- ruby_lines = backtrace.is_a?(Array) ? backtrace : backtrace.split(/\n\s*/)
89
-
90
- ruby_lines = configuration.backtrace_cleanup_callback.call(ruby_lines) if configuration&.backtrace_cleanup_callback
91
-
92
- in_app_pattern ||= begin
93
- project_root = configuration.project_root&.to_s
94
- Regexp.new("^(#{project_root}/)?#{configuration.app_dirs_pattern || APP_DIRS_PATTERN}")
95
- end
96
-
97
- lines = ruby_lines.to_a.map do |unparsed_line|
98
- Line.parse(unparsed_line, in_app_pattern)
99
- end
100
-
101
- new(lines)
102
- end
103
-
104
- def initialize(lines)
105
- @lines = lines
106
- end
107
-
108
- def inspect
109
- "<Backtrace: " + lines.map(&:inspect).join(", ") + ">"
110
- end
111
-
112
- def to_s
113
- content = []
114
- lines.each do |line|
115
- content << line
116
- end
117
- content.join("\n")
118
- end
119
-
120
- def ==(other)
121
- if other.respond_to?(:lines)
122
- lines == other.lines
123
- else
124
- false
125
- end
126
- end
127
- end
128
- end
@@ -1,14 +0,0 @@
1
- module Sentry
2
- class BenchmarkTransport < Transport
3
- attr_accessor :events
4
-
5
- def initialize(*)
6
- super
7
- @events = []
8
- end
9
-
10
- def send_event(event)
11
- @events << encode(event.to_hash)
12
- end
13
- end
14
- end
@@ -1,25 +0,0 @@
1
- module Sentry
2
- class Breadcrumb
3
- attr_accessor :category, :data, :message, :level, :timestamp, :type
4
-
5
- def initialize(category: nil, data: nil, message: nil, timestamp: nil, level: nil, type: nil)
6
- @category = category
7
- @data = data || {}
8
- @level = level
9
- @message = message
10
- @timestamp = timestamp || Sentry.utc_now.to_i
11
- @type = type
12
- end
13
-
14
- def to_hash
15
- {
16
- :category => @category,
17
- :data => @data,
18
- :level => @level,
19
- :message => @message,
20
- :timestamp => @timestamp,
21
- :type => @type
22
- }
23
- end
24
- end
25
- end
@@ -1,87 +0,0 @@
1
- require 'logger'
2
-
3
- module Sentry
4
- class Breadcrumb
5
- module SentryLogger
6
- LEVELS = {
7
- ::Logger::DEBUG => 'debug',
8
- ::Logger::INFO => 'info',
9
- ::Logger::WARN => 'warn',
10
- ::Logger::ERROR => 'error',
11
- ::Logger::FATAL => 'fatal'
12
- }.freeze
13
-
14
- def add(*args, &block)
15
- super
16
- add_breadcrumb(*args, &block)
17
- end
18
-
19
- def add_breadcrumb(severity, message = nil, progname = nil)
20
- # because the breadcrumbs now belongs to different Hub's Scope in different threads
21
- # we need to make sure the current thread's Hub has been set before adding breadcrumbs
22
- return unless Sentry.get_current_hub
23
-
24
- category = "logger"
25
-
26
- # this is because the nature of Ruby Logger class:
27
- #
28
- # when given 1 argument, the argument will become both message and progname
29
- #
30
- # ```
31
- # logger.info("foo")
32
- # # message == progname == "foo"
33
- # ```
34
- #
35
- # and to specify progname with a different message,
36
- # we need to pass the progname as the argument and pass the message as a proc
37
- #
38
- # ```
39
- # logger.info("progname") { "the message" }
40
- # ```
41
- #
42
- # so the condition below is to replicate the similar behavior
43
- if message.nil?
44
- if block_given?
45
- message = yield
46
- category = progname
47
- else
48
- message = progname
49
- end
50
- end
51
-
52
- return if ignored_logger?(progname) || message.empty?
53
-
54
- # some loggers will add leading/trailing space as they (incorrectly, mind you)
55
- # think of logging as a shortcut to std{out,err}
56
- message = message.to_s.strip
57
-
58
- last_crumb = current_breadcrumbs.peek
59
- # try to avoid dupes from logger broadcasts
60
- if last_crumb.nil? || last_crumb.message != message
61
- level = Sentry::Breadcrumb::SentryLogger::LEVELS.fetch(severity, nil)
62
- crumb = Sentry::Breadcrumb.new(
63
- level: level,
64
- category: category,
65
- message: message,
66
- type: severity >= 3 ? "error" : level
67
- )
68
-
69
- Sentry.add_breadcrumb(crumb)
70
- end
71
- end
72
-
73
- private
74
-
75
- def ignored_logger?(progname)
76
- progname == LOGGER_PROGNAME ||
77
- Sentry.configuration.exclude_loggers.include?(progname)
78
- end
79
-
80
- def current_breadcrumbs
81
- Sentry.get_current_scope.breadcrumbs
82
- end
83
- end
84
- end
85
- end
86
-
87
- ::Logger.send(:prepend, Sentry::Breadcrumb::SentryLogger)
@@ -1,47 +0,0 @@
1
- require "sentry/breadcrumb"
2
-
3
- module Sentry
4
- class BreadcrumbBuffer
5
- include Enumerable
6
-
7
- attr_accessor :buffer
8
-
9
- def initialize(size = 100)
10
- @buffer = Array.new(size)
11
- end
12
-
13
- def record(crumb)
14
- yield(crumb) if block_given?
15
- @buffer.slice!(0)
16
- @buffer << crumb
17
- end
18
-
19
- def members
20
- @buffer.compact
21
- end
22
-
23
- def peek
24
- members.last
25
- end
26
-
27
- def each(&block)
28
- members.each(&block)
29
- end
30
-
31
- def empty?
32
- members.none?
33
- end
34
-
35
- def to_hash
36
- {
37
- :values => members.map(&:to_hash)
38
- }
39
- end
40
-
41
- def dup
42
- copy = super
43
- copy.buffer = buffer.deep_dup
44
- copy
45
- end
46
- end
47
- end
@@ -1,90 +0,0 @@
1
- require "sentry/transport"
2
-
3
- module Sentry
4
- class Client
5
- attr_reader :transport, :configuration
6
-
7
- def initialize(configuration)
8
- @configuration = configuration
9
-
10
- if transport_class = configuration.transport.transport_class
11
- @transport = transport_class.new(configuration)
12
- else
13
- @transport =
14
- case configuration.dsn&.scheme
15
- when 'http', 'https'
16
- HTTPTransport.new(configuration)
17
- else
18
- DummyTransport.new(configuration)
19
- end
20
- end
21
- end
22
-
23
- def capture_event(event, scope, hint = {})
24
- return unless configuration.sending_allowed?
25
-
26
- scope.apply_to_event(event, hint)
27
-
28
- if configuration.async?
29
- begin
30
- # We have to convert to a JSON-like hash, because background job
31
- # processors (esp ActiveJob) may not like weird types in the event hash
32
- configuration.async.call(event.to_json_compatible)
33
- rescue => e
34
- configuration.logger.error(LOGGER_PROGNAME) { "async event sending failed: #{e.message}" }
35
- send_event(event, hint)
36
- end
37
- else
38
- if hint.fetch(:background, true)
39
- Sentry.background_worker.perform do
40
- send_event(event, hint)
41
- end
42
- else
43
- send_event(event, hint)
44
- end
45
- end
46
-
47
- event
48
- end
49
-
50
- def event_from_exception(exception, hint = {})
51
- integration_meta = Sentry.integrations[hint[:integration]]
52
- return unless @configuration.exception_class_allowed?(exception)
53
-
54
- Event.new(configuration: configuration, integration_meta: integration_meta).tap do |event|
55
- event.add_exception_interface(exception)
56
- end
57
- end
58
-
59
- def event_from_message(message, hint = {})
60
- integration_meta = Sentry.integrations[hint[:integration]]
61
- Event.new(configuration: configuration, integration_meta: integration_meta, message: message)
62
- end
63
-
64
- def event_from_transaction(transaction)
65
- TransactionEvent.new(configuration: configuration).tap do |event|
66
- event.transaction = transaction.name
67
- event.contexts.merge!(trace: transaction.get_trace_context)
68
- event.timestamp = transaction.timestamp
69
- event.start_timestamp = transaction.start_timestamp
70
-
71
- finished_spans = transaction.span_recorder.spans.select { |span| span.timestamp && span != transaction }
72
- event.spans = finished_spans.map(&:to_hash)
73
- end
74
- end
75
-
76
- def send_event(event, hint = nil)
77
- event_type = event.is_a?(Event) ? event.type : event["type"]
78
- event = configuration.before_send.call(event, hint) if configuration.before_send && event_type == "event"
79
-
80
- if event.nil?
81
- configuration.logger.info(LOGGER_PROGNAME) { "Discarded event because before_send returned nil" }
82
- return
83
- end
84
-
85
- transport.send_event(event)
86
-
87
- event
88
- end
89
- end
90
- end
@@ -1,399 +0,0 @@
1
- require "concurrent/utility/processor_counter"
2
-
3
- require "sentry/utils/exception_cause_chain"
4
- require "sentry/dsn"
5
- require "sentry/transport/configuration"
6
- require "sentry/linecache"
7
-
8
- module Sentry
9
- class Configuration
10
- # Directories to be recognized as part of your app. e.g. if you
11
- # have an `engines` dir at the root of your project, you may want
12
- # to set this to something like /(app|config|engines|lib)/
13
- attr_accessor :app_dirs_pattern
14
-
15
- # Provide an object that responds to `call` to send events asynchronously.
16
- # E.g.: lambda { |event| Thread.new { Sentry.send_event(event) } }
17
- attr_reader :async
18
- alias async? async
19
-
20
- # to send events in a non-blocking way, sentry-ruby has its own background worker
21
- # by default, the worker holds a thread pool that has [the number of processors] threads
22
- # but you can configure it with this configuration option
23
- # E.g.: config.background_worker_threads = 5
24
- #
25
- # if you want to send events synchronously, set the value to 0
26
- # E.g.: config.background_worker_threads = 0
27
- attr_accessor :background_worker_threads
28
-
29
- # a proc/lambda that takes an array of stack traces
30
- # it'll be used to silence (reduce) backtrace of the exception
31
- #
32
- # for example:
33
- #
34
- # ```ruby
35
- # Sentry.configuration.backtrace_cleanup_callback = lambda do |backtrace|
36
- # Rails.backtrace_cleaner.clean(backtrace)
37
- # end
38
- # ```
39
- #
40
- attr_accessor :backtrace_cleanup_callback
41
-
42
- # Optional Proc, called before sending an event to the server/
43
- # E.g.: lambda { |event| event }
44
- # E.g.: lambda { |event| nil }
45
- # E.g.: lambda { |event|
46
- # event[:message] = 'a'
47
- # event
48
- # }
49
- attr_reader :before_send
50
-
51
- # An array of breadcrumbs loggers to be used. Available options are:
52
- # - :sentry_logger
53
- # - :active_support_logger
54
- attr_reader :breadcrumbs_logger
55
-
56
- # Number of lines of code context to capture, or nil for none
57
- attr_accessor :context_lines
58
-
59
- # RACK_ENV by default.
60
- attr_reader :environment
61
-
62
- # the dsn value, whether it's set via `config.dsn=` or `ENV["SENTRY_DSN"]`
63
- attr_reader :dsn
64
-
65
- # Whitelist of enabled_environments that will send notifications to Sentry. Array of Strings.
66
- attr_accessor :enabled_environments
67
-
68
- # Logger 'progname's to exclude from breadcrumbs
69
- attr_accessor :exclude_loggers
70
-
71
- # Array of exception classes that should never be sent. See IGNORE_DEFAULT.
72
- # You should probably append to this rather than overwrite it.
73
- attr_accessor :excluded_exceptions
74
-
75
- # Boolean to check nested exceptions when deciding if to exclude. Defaults to false
76
- attr_accessor :inspect_exception_causes_for_exclusion
77
- alias inspect_exception_causes_for_exclusion? inspect_exception_causes_for_exclusion
78
-
79
- # You may provide your own LineCache for matching paths with source files.
80
- # This may be useful if you need to get source code from places other than
81
- # the disk. See Sentry::LineCache for the required interface you must implement.
82
- attr_accessor :linecache
83
-
84
- # Logger used by Sentry. In Rails, this is the Rails logger, otherwise
85
- # Sentry provides its own Sentry::Logger.
86
- attr_accessor :logger
87
-
88
- # Project directory root for in_app detection. Could be Rails root, etc.
89
- # Set automatically for Rails.
90
- attr_reader :project_root
91
-
92
- # Array of rack env parameters to be included in the event sent to sentry.
93
- attr_accessor :rack_env_whitelist
94
-
95
- # Release tag to be passed with every event sent to Sentry.
96
- # We automatically try to set this to a git SHA or Capistrano release.
97
- attr_accessor :release
98
-
99
- # The sampling factor to apply to events. A value of 0.0 will not send
100
- # any events, and a value of 1.0 will send 100% of events.
101
- attr_accessor :sample_rate
102
-
103
- # Include module versions in reports - boolean.
104
- attr_accessor :send_modules
105
-
106
- # When send_default_pii's value is false (default), sensitive information like
107
- # - user ip
108
- # - user cookie
109
- # - request body
110
- # will not be sent to Sentry.
111
- attr_accessor :send_default_pii
112
-
113
- attr_accessor :server_name
114
-
115
- # Return a Transport::Configuration object for transport-related configurations.
116
- attr_reader :transport
117
-
118
- # Take a float between 0.0 and 1.0 as the sample rate for tracing events (transactions).
119
- attr_accessor :traces_sample_rate
120
-
121
- # Take a Proc that controls the sample rate for every tracing event, e.g.
122
- # ```
123
- # lambda do |tracing_context|
124
- # # tracing_context[:transaction_context] contains the information about the transaction
125
- # # tracing_context[:parent_sampled] contains the transaction's parent's sample decision
126
- # true # return value can be a boolean or a float between 0.0 and 1.0
127
- # end
128
- # ```
129
- attr_accessor :traces_sampler
130
-
131
- # these are not config options
132
- attr_reader :errors, :gem_specs
133
-
134
- # Most of these errors generate 4XX responses. In general, Sentry clients
135
- # only automatically report 5xx responses.
136
- IGNORE_DEFAULT = [
137
- 'CGI::Session::CookieStore::TamperedWithCookie',
138
- 'Mongoid::Errors::DocumentNotFound',
139
- 'Rack::QueryParser::InvalidParameterError',
140
- 'Rack::QueryParser::ParameterTypeError',
141
- 'Sinatra::NotFound'
142
- ].freeze
143
-
144
- RACK_ENV_WHITELIST_DEFAULT = %w(
145
- REMOTE_ADDR
146
- SERVER_NAME
147
- SERVER_PORT
148
- ).freeze
149
-
150
- HEROKU_DYNO_METADATA_MESSAGE = "You are running on Heroku but haven't enabled Dyno Metadata. For Sentry's "\
151
- "release detection to work correctly, please run `heroku labs:enable runtime-dyno-metadata`".freeze
152
-
153
- LOG_PREFIX = "** [Sentry] ".freeze
154
- MODULE_SEPARATOR = "::".freeze
155
-
156
- AVAILABLE_BREADCRUMBS_LOGGERS = [:sentry_logger, :active_support_logger].freeze
157
-
158
- def initialize
159
- self.async = false
160
- self.background_worker_threads = Concurrent.processor_count
161
- self.breadcrumbs_logger = []
162
- self.context_lines = 3
163
- self.environment = environment_from_env
164
- self.enabled_environments = []
165
- self.exclude_loggers = []
166
- self.excluded_exceptions = IGNORE_DEFAULT.dup
167
- self.inspect_exception_causes_for_exclusion = false
168
- self.linecache = ::Sentry::LineCache.new
169
- self.logger = ::Sentry::Logger.new(STDOUT)
170
- self.project_root = detect_project_root
171
-
172
- self.release = detect_release
173
- self.sample_rate = 1.0
174
- self.send_modules = true
175
- self.send_default_pii = false
176
- self.dsn = ENV['SENTRY_DSN']
177
- self.server_name = server_name_from_env
178
-
179
- self.before_send = false
180
- self.rack_env_whitelist = RACK_ENV_WHITELIST_DEFAULT
181
-
182
- @transport = Transport::Configuration.new
183
- @gem_specs = Hash[Gem::Specification.map { |spec| [spec.name, spec.version.to_s] }] if Gem::Specification.respond_to?(:map)
184
- post_initialization_callback
185
- end
186
-
187
- def dsn=(value)
188
- return if value.nil? || value.empty?
189
-
190
- @dsn = DSN.new(value)
191
- end
192
-
193
- alias server= dsn=
194
-
195
-
196
- def async=(value)
197
- unless value == false || value.respond_to?(:call)
198
- raise(ArgumentError, "async must be callable (or false to disable)")
199
- end
200
-
201
- @async = value
202
- end
203
-
204
- def breadcrumbs_logger=(logger)
205
- loggers =
206
- if logger.is_a?(Array)
207
- logger
208
- else
209
- unless AVAILABLE_BREADCRUMBS_LOGGERS.include?(logger)
210
- raise Sentry::Error, "Unsupported breadcrumbs logger. Supported loggers: #{AVAILABLE_BREADCRUMBS_LOGGERS}"
211
- end
212
-
213
- Array(logger)
214
- end
215
-
216
- require "sentry/breadcrumb/sentry_logger" if loggers.include?(:sentry_logger)
217
-
218
- @breadcrumbs_logger = logger
219
- end
220
-
221
- def before_send=(value)
222
- unless value == false || value.respond_to?(:call)
223
- raise ArgumentError, "before_send must be callable (or false to disable)"
224
- end
225
-
226
- @before_send = value
227
- end
228
-
229
- def environment=(environment)
230
- @environment = environment.to_s
231
- end
232
-
233
- def sending_allowed?
234
- @errors = []
235
-
236
- valid? &&
237
- capture_in_environment? &&
238
- sample_allowed?
239
- end
240
-
241
- def error_messages
242
- @errors = [@errors[0]] + @errors[1..-1].map(&:downcase) # fix case of all but first
243
- @errors.join(", ")
244
- end
245
-
246
- def project_root=(root_dir)
247
- @project_root = root_dir
248
- end
249
-
250
- def exception_class_allowed?(exc)
251
- if exc.is_a?(Sentry::Error)
252
- # Try to prevent error reporting loops
253
- logger.debug(LOGGER_PROGNAME) { "Refusing to capture Sentry error: #{exc.inspect}" }
254
- false
255
- elsif excluded_exception?(exc)
256
- logger.debug(LOGGER_PROGNAME) { "User excluded error: #{exc.inspect}" }
257
- false
258
- else
259
- true
260
- end
261
- end
262
-
263
- def enabled_in_current_env?
264
- enabled_environments.empty? || enabled_environments.include?(environment)
265
- end
266
-
267
- def tracing_enabled?
268
- !!((@traces_sample_rate && @traces_sample_rate > 0.0) || @traces_sampler)
269
- end
270
-
271
- private
272
-
273
- def detect_project_root
274
- if defined? Rails.root # we are in a Rails application
275
- Rails.root.to_s
276
- else
277
- Dir.pwd
278
- end
279
- end
280
-
281
- def detect_release
282
- detect_release_from_env ||
283
- detect_release_from_git ||
284
- detect_release_from_capistrano ||
285
- detect_release_from_heroku
286
- rescue => e
287
- logger.error(LOGGER_PROGNAME) { "Error detecting release: #{e.message}" }
288
- end
289
-
290
- def excluded_exception?(incoming_exception)
291
- excluded_exception_classes.any? do |excluded_exception|
292
- matches_exception?(excluded_exception, incoming_exception)
293
- end
294
- end
295
-
296
- def excluded_exception_classes
297
- @excluded_exception_classes ||= excluded_exceptions.map { |e| get_exception_class(e) }
298
- end
299
-
300
- def get_exception_class(x)
301
- x.is_a?(Module) ? x : safe_const_get(x)
302
- end
303
-
304
- def matches_exception?(excluded_exception_class, incoming_exception)
305
- if inspect_exception_causes_for_exclusion?
306
- Sentry::Utils::ExceptionCauseChain.exception_to_array(incoming_exception).any? { |cause| excluded_exception_class === cause }
307
- else
308
- excluded_exception_class === incoming_exception
309
- end
310
- end
311
-
312
- def safe_const_get(x)
313
- x = x.to_s unless x.is_a?(String)
314
- Object.const_get(x)
315
- rescue NameError # There's no way to safely ask if a constant exist for an unknown string
316
- nil
317
- end
318
-
319
- def detect_release_from_heroku
320
- return unless running_on_heroku?
321
- return if ENV['CI']
322
- logger.warn(LOGGER_PROGNAME) { HEROKU_DYNO_METADATA_MESSAGE } && return unless ENV['HEROKU_SLUG_COMMIT']
323
-
324
- ENV['HEROKU_SLUG_COMMIT']
325
- end
326
-
327
- def running_on_heroku?
328
- File.directory?("/etc/heroku")
329
- end
330
-
331
- def detect_release_from_capistrano
332
- revision_file = File.join(project_root, 'REVISION')
333
- revision_log = File.join(project_root, '..', 'revisions.log')
334
-
335
- if File.exist?(revision_file)
336
- File.read(revision_file).strip
337
- elsif File.exist?(revision_log)
338
- File.open(revision_log).to_a.last.strip.sub(/.*as release ([0-9]+).*/, '\1')
339
- end
340
- end
341
-
342
- def detect_release_from_git
343
- Sentry.sys_command("git rev-parse --short HEAD") if File.directory?(".git")
344
- end
345
-
346
- def detect_release_from_env
347
- ENV['SENTRY_RELEASE']
348
- end
349
-
350
- def capture_in_environment?
351
- return true if enabled_in_current_env?
352
-
353
- @errors << "Not configured to send/capture in environment '#{environment}'"
354
- false
355
- end
356
-
357
- def valid?
358
- if @dsn&.valid?
359
- true
360
- else
361
- @errors << "DSN not set or not valid"
362
- false
363
- end
364
- end
365
-
366
- def sample_allowed?
367
- return true if sample_rate == 1.0
368
-
369
- if Random::DEFAULT.rand >= sample_rate
370
- @errors << "Excluded by random sample"
371
- false
372
- else
373
- true
374
- end
375
- end
376
-
377
- # Try to resolve the hostname to an FQDN, but fall back to whatever
378
- # the load name is.
379
- def resolve_hostname
380
- Socket.gethostname ||
381
- Socket.gethostbyname(hostname).first rescue server_name
382
- end
383
-
384
- def environment_from_env
385
- ENV['SENTRY_CURRENT_ENV'] || ENV['SENTRY_ENVIRONMENT'] || ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'default'
386
- end
387
-
388
- def server_name_from_env
389
- if running_on_heroku?
390
- ENV['DYNO']
391
- else
392
- resolve_hostname
393
- end
394
- end
395
-
396
- # allow extensions to extend the Configuration class
397
- def post_initialization_callback; end
398
- end
399
- end