sentry-rails 5.1.0 → 5.10.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.gitignore +1 -1
- data/Gemfile +19 -7
- data/lib/sentry/rails/action_cable.rb +11 -6
- data/lib/sentry/rails/active_job.rb +63 -57
- data/lib/sentry/rails/background_worker.rb +6 -3
- data/lib/sentry/rails/breadcrumb/active_support_logger.rb +63 -7
- data/lib/sentry/rails/capture_exceptions.rb +27 -14
- data/lib/sentry/rails/configuration.rb +25 -1
- data/lib/sentry/rails/controller_transaction.rb +28 -2
- data/lib/sentry/rails/error_subscriber.rb +18 -12
- data/lib/sentry/rails/railtie.rb +9 -2
- data/lib/sentry/rails/tracing/abstract_subscriber.rb +6 -9
- data/lib/sentry/rails/tracing/action_controller_subscriber.rb +7 -1
- data/lib/sentry/rails/tracing/active_record_subscriber.rb +1 -0
- data/lib/sentry/rails/tracing/active_storage_subscriber.rb +1 -1
- data/lib/sentry/rails/tracing.rb +1 -1
- data/lib/sentry/rails/version.rb +1 -1
- data/sentry-rails.gemspec +1 -1
- metadata +5 -6
- data/CODE_OF_CONDUCT.md +0 -74
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 7eadae379dbfc72a3685f48b7379a52c1fea827eb4c57d1eba6565f87cad406f
|
4
|
+
data.tar.gz: 81a628792cffda07caed69c4fc5191c77f27da32cfe70226bfac3aeda3951c33
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0b8575d57dd6be491b3221c40a62864ac183a26274717f122a67d61300f093ff215e38ad182a301db9cc0f57e1d3a257e564bb845aca86429b96574baf901c2a
|
7
|
+
data.tar.gz: 68e82698caa67fb3d5d7643e86379015dde236ffd38de7a560af0e207d48928643becc8918b7f4aa48cf533c849b4b6f3496f3cc9513f61408545e80e8811212
|
data/.gitignore
CHANGED
data/Gemfile
CHANGED
@@ -1,28 +1,33 @@
|
|
1
1
|
source "https://rubygems.org"
|
2
|
+
git_source(:github) { |name| "https://github.com/#{name}.git" }
|
2
3
|
|
3
4
|
# Specify your gem's dependencies in sentry-ruby.gemspec
|
4
5
|
gemspec
|
5
6
|
gem "sentry-ruby", path: "../sentry-ruby"
|
6
7
|
|
8
|
+
platform :jruby do
|
9
|
+
gem 'activerecord-jdbcmysql-adapter'
|
10
|
+
gem "jdbc-sqlite3"
|
11
|
+
end
|
12
|
+
|
7
13
|
rails_version = ENV["RAILS_VERSION"]
|
8
14
|
rails_version = "7.0.0" if rails_version.nil?
|
9
15
|
rails_version = Gem::Version.new(rails_version)
|
10
16
|
|
11
|
-
gem 'activerecord-jdbcmysql-adapter', platform: :jruby
|
12
|
-
gem "jdbc-sqlite3", platform: :jruby
|
13
|
-
|
14
17
|
if rails_version < Gem::Version.new("6.0.0")
|
15
18
|
gem "sqlite3", "~> 1.3.0", platform: :ruby
|
16
19
|
else
|
17
20
|
gem "sqlite3", platform: :ruby
|
18
21
|
end
|
19
22
|
|
20
|
-
if rails_version
|
21
|
-
gem "rails", github: "rails/rails"
|
23
|
+
if rails_version > Gem::Version.new("7.0.0")
|
24
|
+
gem "rails", github: "rails/rails"
|
22
25
|
else
|
23
26
|
gem "rails", "~> #{rails_version}"
|
24
27
|
end
|
25
28
|
|
29
|
+
gem "mini_magick"
|
30
|
+
|
26
31
|
gem "sprockets-rails"
|
27
32
|
|
28
33
|
gem "sidekiq"
|
@@ -34,10 +39,17 @@ gem 'simplecov'
|
|
34
39
|
gem "simplecov-cobertura", "~> 1.4"
|
35
40
|
gem "rexml"
|
36
41
|
|
42
|
+
# https://github.com/flavorjones/loofah/pull/267
|
43
|
+
# loofah changed the required ruby version in a patch so we need to explicitly pin it
|
44
|
+
gem "loofah", "2.20.0" if RUBY_VERSION.to_f < 2.5
|
45
|
+
|
37
46
|
gem "rake", "~> 12.0"
|
38
47
|
|
39
|
-
|
40
|
-
gem "debug", github: "ruby/debug", platform: :ruby
|
48
|
+
if RUBY_VERSION.to_f >= 2.6
|
49
|
+
gem "debug", github: "ruby/debug", platform: :ruby
|
50
|
+
gem "irb"
|
51
|
+
end
|
52
|
+
|
41
53
|
gem "pry"
|
42
54
|
|
43
55
|
gem "benchmark-ips"
|
@@ -2,6 +2,8 @@ module Sentry
|
|
2
2
|
module Rails
|
3
3
|
module ActionCableExtensions
|
4
4
|
class ErrorHandler
|
5
|
+
OP_NAME = "websocket.server".freeze
|
6
|
+
|
5
7
|
class << self
|
6
8
|
def capture(connection, transaction_name:, extra_context: nil, &block)
|
7
9
|
return block.call unless Sentry.initialized?
|
@@ -13,13 +15,14 @@ module Sentry
|
|
13
15
|
Sentry.with_scope do |scope|
|
14
16
|
scope.set_rack_env(env)
|
15
17
|
scope.set_context("action_cable", extra_context) if extra_context
|
16
|
-
scope.set_transaction_name(transaction_name)
|
17
|
-
transaction = start_transaction(env, scope
|
18
|
+
scope.set_transaction_name(transaction_name, source: :view)
|
19
|
+
transaction = start_transaction(env, scope)
|
18
20
|
scope.set_span(transaction) if transaction
|
19
21
|
|
20
22
|
begin
|
21
|
-
block.call
|
23
|
+
result = block.call
|
22
24
|
finish_transaction(transaction, 200)
|
25
|
+
result
|
23
26
|
rescue Exception => e # rubocop:disable Lint/RescueException
|
24
27
|
Sentry::Rails.capture_exception(e)
|
25
28
|
finish_transaction(transaction, 500)
|
@@ -29,10 +32,12 @@ module Sentry
|
|
29
32
|
end
|
30
33
|
end
|
31
34
|
|
32
|
-
def start_transaction(env,
|
35
|
+
def start_transaction(env, scope)
|
33
36
|
sentry_trace = env["HTTP_SENTRY_TRACE"]
|
34
|
-
|
35
|
-
|
37
|
+
baggage = env["HTTP_BAGGAGE"]
|
38
|
+
|
39
|
+
options = { name: scope.transaction_name, source: scope.transaction_source, op: OP_NAME }
|
40
|
+
transaction = Sentry::Transaction.from_sentry_trace(sentry_trace, baggage: baggage, **options) if sentry_trace
|
36
41
|
Sentry.start_transaction(transaction: transaction, **options)
|
37
42
|
end
|
38
43
|
|
@@ -5,76 +5,82 @@ module Sentry
|
|
5
5
|
if !Sentry.initialized? || already_supported_by_sentry_integration?
|
6
6
|
super
|
7
7
|
else
|
8
|
-
|
9
|
-
|
10
|
-
super
|
11
|
-
end
|
8
|
+
SentryReporter.record(self) do
|
9
|
+
super
|
12
10
|
end
|
13
11
|
end
|
14
12
|
end
|
15
13
|
|
16
|
-
def
|
17
|
-
|
18
|
-
|
19
|
-
if is_a?(::Sentry::SendEventJob)
|
20
|
-
nil
|
21
|
-
else
|
22
|
-
Sentry.start_transaction(name: scope.transaction_name, op: "active_job")
|
23
|
-
end
|
24
|
-
|
25
|
-
scope.set_span(transaction) if transaction
|
14
|
+
def already_supported_by_sentry_integration?
|
15
|
+
Sentry.configuration.rails.skippable_job_adapters.include?(self.class.queue_adapter.class.to_s)
|
16
|
+
end
|
26
17
|
|
27
|
-
|
18
|
+
class SentryReporter
|
19
|
+
OP_NAME = "queue.active_job".freeze
|
28
20
|
|
29
|
-
|
21
|
+
class << self
|
22
|
+
def record(job, &block)
|
23
|
+
Sentry.with_scope do |scope|
|
24
|
+
begin
|
25
|
+
scope.set_transaction_name(job.class.name, source: :task)
|
26
|
+
transaction =
|
27
|
+
if job.is_a?(::Sentry::SendEventJob)
|
28
|
+
nil
|
29
|
+
else
|
30
|
+
Sentry.start_transaction(name: scope.transaction_name, source: scope.transaction_source, op: OP_NAME)
|
31
|
+
end
|
30
32
|
|
31
|
-
|
32
|
-
rescue Exception => e # rubocop:disable Lint/RescueException
|
33
|
-
finish_sentry_transaction(transaction, 500)
|
33
|
+
scope.set_span(transaction) if transaction
|
34
34
|
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
provider_job_id: provider_job_id
|
41
|
-
}
|
42
|
-
)
|
43
|
-
raise e
|
44
|
-
end
|
35
|
+
yield.tap do
|
36
|
+
finish_sentry_transaction(transaction, 200)
|
37
|
+
end
|
38
|
+
rescue Exception => e # rubocop:disable Lint/RescueException
|
39
|
+
finish_sentry_transaction(transaction, 500)
|
45
40
|
|
46
|
-
|
47
|
-
|
41
|
+
Sentry::Rails.capture_exception(
|
42
|
+
e,
|
43
|
+
extra: sentry_context(job),
|
44
|
+
tags: {
|
45
|
+
job_id: job.job_id,
|
46
|
+
provider_job_id: job.provider_job_id
|
47
|
+
}
|
48
|
+
)
|
49
|
+
raise
|
50
|
+
end
|
51
|
+
end
|
52
|
+
end
|
48
53
|
|
49
|
-
|
50
|
-
|
51
|
-
end
|
54
|
+
def finish_sentry_transaction(transaction, status)
|
55
|
+
return unless transaction
|
52
56
|
|
53
|
-
|
54
|
-
|
55
|
-
|
57
|
+
transaction.set_http_status(status)
|
58
|
+
transaction.finish
|
59
|
+
end
|
56
60
|
|
57
|
-
|
58
|
-
|
59
|
-
|
60
|
-
|
61
|
-
|
62
|
-
|
63
|
-
|
64
|
-
|
65
|
-
|
66
|
-
|
61
|
+
def sentry_context(job)
|
62
|
+
{
|
63
|
+
active_job: job.class.name,
|
64
|
+
arguments: sentry_serialize_arguments(job.arguments),
|
65
|
+
scheduled_at: job.scheduled_at,
|
66
|
+
job_id: job.job_id,
|
67
|
+
provider_job_id: job.provider_job_id,
|
68
|
+
locale: job.locale
|
69
|
+
}
|
70
|
+
end
|
67
71
|
|
68
|
-
|
69
|
-
|
70
|
-
|
71
|
-
|
72
|
-
|
73
|
-
|
74
|
-
|
75
|
-
|
76
|
-
|
77
|
-
|
72
|
+
def sentry_serialize_arguments(argument)
|
73
|
+
case argument
|
74
|
+
when Hash
|
75
|
+
argument.transform_values { |v| sentry_serialize_arguments(v) }
|
76
|
+
when Array, Enumerable
|
77
|
+
argument.map { |v| sentry_serialize_arguments(v) }
|
78
|
+
when ->(v) { v.respond_to?(:to_global_id) }
|
79
|
+
argument.to_global_id.to_s rescue argument
|
80
|
+
else
|
81
|
+
argument
|
82
|
+
end
|
83
|
+
end
|
78
84
|
end
|
79
85
|
end
|
80
86
|
end
|
@@ -1,9 +1,12 @@
|
|
1
1
|
module Sentry
|
2
2
|
class BackgroundWorker
|
3
3
|
def _perform(&block)
|
4
|
-
|
5
|
-
|
6
|
-
|
4
|
+
block.call
|
5
|
+
ensure
|
6
|
+
# some applications have partial or even no AR connection
|
7
|
+
if ActiveRecord::Base.connected?
|
8
|
+
# make sure the background worker returns AR connection if it accidentally acquire one during serialization
|
9
|
+
ActiveRecord::Base.connection_pool.release_connection
|
7
10
|
end
|
8
11
|
end
|
9
12
|
end
|
@@ -1,20 +1,76 @@
|
|
1
|
-
require "sentry/rails/instrument_payload_cleanup_helper"
|
2
|
-
|
3
1
|
module Sentry
|
4
2
|
module Rails
|
5
3
|
module Breadcrumb
|
6
4
|
module ActiveSupportLogger
|
7
|
-
|
8
|
-
|
5
|
+
ALLOWED_LIST = {
|
6
|
+
# action_controller
|
7
|
+
"write_fragment.action_controller" => %i[key],
|
8
|
+
"read_fragment.action_controller" => %i[key],
|
9
|
+
"exist_fragment?.action_controller" => %i[key],
|
10
|
+
"expire_fragment.action_controller" => %i[key],
|
11
|
+
"start_processing.action_controller" => %i[controller action params format method path],
|
12
|
+
"process_action.action_controller" => %i[controller action params format method path status view_runtime db_runtime],
|
13
|
+
"send_file.action_controller" => %i[path],
|
14
|
+
"redirect_to.action_controller" => %i[status location],
|
15
|
+
"halted_callback.action_controller" => %i[filter],
|
16
|
+
# action_dispatch
|
17
|
+
"process_middleware.action_dispatch" => %i[middleware],
|
18
|
+
# action_view
|
19
|
+
"render_template.action_view" => %i[identifier layout],
|
20
|
+
"render_partial.action_view" => %i[identifier],
|
21
|
+
"render_collection.action_view" => %i[identifier count cache_hits],
|
22
|
+
"render_layout.action_view" => %i[identifier],
|
23
|
+
# active_record
|
24
|
+
"sql.active_record" => %i[sql name statement_name cached],
|
25
|
+
"instantiation.active_record" => %i[record_count class_name],
|
26
|
+
# action_mailer
|
27
|
+
# not including to, from, or subject..etc. because of PII concern
|
28
|
+
"deliver.action_mailer" => %i[mailer date perform_deliveries],
|
29
|
+
"process.action_mailer" => %i[mailer action params],
|
30
|
+
# active_support
|
31
|
+
"cache_read.active_support" => %i[key store hit],
|
32
|
+
"cache_generate.active_support" => %i[key store],
|
33
|
+
"cache_fetch_hit.active_support" => %i[key store],
|
34
|
+
"cache_write.active_support" => %i[key store],
|
35
|
+
"cache_delete.active_support" => %i[key store],
|
36
|
+
"cache_exist?.active_support" => %i[key store],
|
37
|
+
# active_job
|
38
|
+
"enqueue_at.active_job" => %i[],
|
39
|
+
"enqueue.active_job" => %i[],
|
40
|
+
"enqueue_retry.active_job" => %i[],
|
41
|
+
"perform_start.active_job" => %i[],
|
42
|
+
"perform.active_job" => %i[],
|
43
|
+
"retry_stopped.active_job" => %i[],
|
44
|
+
"discard.active_job" => %i[],
|
45
|
+
# action_cable
|
46
|
+
"perform_action.action_cable" => %i[channel_class action],
|
47
|
+
"transmit.action_cable" => %i[channel_class],
|
48
|
+
"transmit_subscription_confirmation.action_cable" => %i[channel_class],
|
49
|
+
"transmit_subscription_rejection.action_cable" => %i[channel_class],
|
50
|
+
"broadcast.action_cable" => %i[broadcasting],
|
51
|
+
# active_storage
|
52
|
+
"service_upload.active_storage" => %i[service key checksum],
|
53
|
+
"service_streaming_download.active_storage" => %i[service key],
|
54
|
+
"service_download_chunk.active_storage" => %i[service key],
|
55
|
+
"service_download.active_storage" => %i[service key],
|
56
|
+
"service_delete.active_storage" => %i[service key],
|
57
|
+
"service_delete_prefixed.active_storage" => %i[service prefix],
|
58
|
+
"service_exist.active_storage" => %i[service key exist],
|
59
|
+
"service_url.active_storage" => %i[service key url],
|
60
|
+
"service_update_metadata.active_storage" => %i[service key],
|
61
|
+
"preview.active_storage" => %i[key],
|
62
|
+
"analyze.active_storage" => %i[analyzer],
|
63
|
+
}.freeze
|
9
64
|
|
65
|
+
class << self
|
10
66
|
def add(name, started, _finished, _unique_id, data)
|
11
67
|
# skip Rails' internal events
|
12
68
|
return if name.start_with?("!")
|
13
69
|
|
70
|
+
allowed_keys = ALLOWED_LIST[name]
|
71
|
+
|
14
72
|
if data.is_a?(Hash)
|
15
|
-
|
16
|
-
data = data.dup
|
17
|
-
cleanup_data(data)
|
73
|
+
data = data.slice(*allowed_keys)
|
18
74
|
end
|
19
75
|
|
20
76
|
crumb = Sentry::Breadcrumb.new(
|
@@ -1,11 +1,13 @@
|
|
1
1
|
module Sentry
|
2
2
|
module Rails
|
3
3
|
class CaptureExceptions < Sentry::Rack::CaptureExceptions
|
4
|
-
|
4
|
+
RAILS_7_1 = Gem::Version.new(::Rails.version) >= Gem::Version.new("7.1.0.alpha")
|
5
|
+
|
6
|
+
def initialize(_)
|
5
7
|
super
|
6
8
|
|
7
|
-
if
|
8
|
-
@
|
9
|
+
if Sentry.initialized?
|
10
|
+
@assets_regexp = Sentry.configuration.rails.assets_regexp
|
9
11
|
end
|
10
12
|
end
|
11
13
|
|
@@ -17,29 +19,40 @@ module Sentry
|
|
17
19
|
end
|
18
20
|
|
19
21
|
def transaction_op
|
20
|
-
"
|
22
|
+
"http.server".freeze
|
21
23
|
end
|
22
24
|
|
23
|
-
def capture_exception(exception)
|
24
|
-
|
25
|
+
def capture_exception(exception, env)
|
26
|
+
# the exception will be swallowed by ShowExceptions middleware
|
27
|
+
return if show_exceptions?(exception, env) && !Sentry.configuration.rails.report_rescued_exceptions
|
25
28
|
|
26
|
-
|
27
|
-
|
29
|
+
Sentry::Rails.capture_exception(exception).tap do |event|
|
30
|
+
env[ERROR_EVENT_ID_KEY] = event.event_id if event
|
28
31
|
end
|
29
|
-
|
30
|
-
Sentry::Rails.capture_exception(exception)
|
31
32
|
end
|
32
33
|
|
33
34
|
def start_transaction(env, scope)
|
34
35
|
sentry_trace = env["HTTP_SENTRY_TRACE"]
|
35
|
-
|
36
|
+
baggage = env["HTTP_BAGGAGE"]
|
36
37
|
|
37
|
-
|
38
|
+
options = { name: scope.transaction_name, source: scope.transaction_source, op: transaction_op }
|
39
|
+
|
40
|
+
if @assets_regexp && scope.transaction_name.match?(@assets_regexp)
|
38
41
|
options.merge!(sampled: false)
|
39
42
|
end
|
40
43
|
|
41
|
-
transaction = Sentry::Transaction.from_sentry_trace(sentry_trace, **options) if sentry_trace
|
42
|
-
Sentry.start_transaction(transaction: transaction, **options)
|
44
|
+
transaction = Sentry::Transaction.from_sentry_trace(sentry_trace, baggage: baggage, **options) if sentry_trace
|
45
|
+
Sentry.start_transaction(transaction: transaction, custom_sampling_context: { env: env }, **options)
|
46
|
+
end
|
47
|
+
|
48
|
+
def show_exceptions?(exception, env)
|
49
|
+
request = ActionDispatch::Request.new(env)
|
50
|
+
|
51
|
+
if RAILS_7_1
|
52
|
+
ActionDispatch::ExceptionWrapper.new(nil, exception).show?(request)
|
53
|
+
else
|
54
|
+
request.show_exceptions?
|
55
|
+
end
|
43
56
|
end
|
44
57
|
end
|
45
58
|
end
|
@@ -42,6 +42,12 @@ module Sentry
|
|
42
42
|
'ActiveRecord::RecordNotFound'
|
43
43
|
].freeze
|
44
44
|
class Configuration
|
45
|
+
# Rails 7.0 introduced a new error reporter feature, which the SDK once opted-in by default.
|
46
|
+
# But after receiving multiple issue reports, the integration seemed to cause serious troubles to some users.
|
47
|
+
# So the integration is now controlled by this configuration, which is disabled (false) by default.
|
48
|
+
# More information can be found from: https://github.com/rails/rails/pull/43625#issuecomment-1072514175
|
49
|
+
attr_accessor :register_error_subscriber
|
50
|
+
|
45
51
|
# Rails catches exceptions in the ActionDispatch::ShowExceptions or
|
46
52
|
# ActionDispatch::DebugExceptions middlewares, depending on the environment.
|
47
53
|
# When `rails_report_rescued_exceptions` is true (it is by default), Sentry
|
@@ -54,11 +60,29 @@ module Sentry
|
|
54
60
|
|
55
61
|
attr_accessor :tracing_subscribers
|
56
62
|
|
63
|
+
# sentry-rails by default skips asset request' transactions by checking if the path matches
|
64
|
+
#
|
65
|
+
# ```rb
|
66
|
+
# %r(\A/{0,2}#{::Rails.application.config.assets.prefix})
|
67
|
+
# ```
|
68
|
+
#
|
69
|
+
# If you want to use a different pattern, you can configure the `assets_regexp` option like:
|
70
|
+
#
|
71
|
+
# ```rb
|
72
|
+
# Sentry.init do |config|
|
73
|
+
# config.rails.assets_regexp = /my_regexp/
|
74
|
+
# end
|
75
|
+
# ```
|
76
|
+
attr_accessor :assets_regexp
|
77
|
+
|
57
78
|
def initialize
|
79
|
+
@register_error_subscriber = false
|
58
80
|
@report_rescued_exceptions = true
|
59
81
|
@skippable_job_adapters = []
|
82
|
+
@assets_regexp = if defined?(::Sprockets::Rails)
|
83
|
+
%r(\A/{0,2}#{::Rails.application.config.assets.prefix})
|
84
|
+
end
|
60
85
|
@tracing_subscribers = Set.new([
|
61
|
-
Sentry::Rails::Tracing::ActionControllerSubscriber,
|
62
86
|
Sentry::Rails::Tracing::ActionViewSubscriber,
|
63
87
|
Sentry::Rails::Tracing::ActiveRecordSubscriber,
|
64
88
|
Sentry::Rails::Tracing::ActiveStorageSubscriber
|
@@ -2,8 +2,34 @@ module Sentry
|
|
2
2
|
module Rails
|
3
3
|
module ControllerTransaction
|
4
4
|
def self.included(base)
|
5
|
-
base.
|
6
|
-
|
5
|
+
base.prepend_around_action(:sentry_around_action)
|
6
|
+
end
|
7
|
+
|
8
|
+
private
|
9
|
+
|
10
|
+
def sentry_around_action
|
11
|
+
if Sentry.initialized?
|
12
|
+
transaction_name = "#{self.class}##{action_name}"
|
13
|
+
Sentry.get_current_scope.set_transaction_name(transaction_name, source: :view)
|
14
|
+
Sentry.with_child_span(op: "view.process_action.action_controller", description: transaction_name) do |child_span|
|
15
|
+
if child_span
|
16
|
+
begin
|
17
|
+
result = yield
|
18
|
+
ensure
|
19
|
+
child_span.set_http_status(response.status)
|
20
|
+
child_span.set_data(:format, request.format)
|
21
|
+
child_span.set_data(:method, request.method)
|
22
|
+
child_span.set_data(:path, request.path)
|
23
|
+
child_span.set_data(:params, request.params)
|
24
|
+
end
|
25
|
+
|
26
|
+
result
|
27
|
+
else
|
28
|
+
yield
|
29
|
+
end
|
30
|
+
end
|
31
|
+
else
|
32
|
+
yield
|
7
33
|
end
|
8
34
|
end
|
9
35
|
end
|
@@ -1,19 +1,25 @@
|
|
1
1
|
module Sentry
|
2
2
|
module Rails
|
3
3
|
# This is not a user-facing class. You should use it with Rails 7.0's error reporter feature and its interfaces.
|
4
|
-
# See https://github.com/rails/rails/blob/main/activesupport/lib/active_support/error_reporter.rb
|
4
|
+
# See https://github.com/rails/rails/blob/main/activesupport/lib/active_support/error_reporter.rb to learn more about reporting APIs.
|
5
|
+
# If you want Sentry to subscribe to the error reporter, please set `config.rails.register_error_subscriber` to `true`.
|
5
6
|
class ErrorSubscriber
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
7
|
+
SKIP_SOURCES = Regexp.union([/.*_cache_store.active_support/])
|
8
|
+
|
9
|
+
def report(error, handled:, severity:, context:, source: nil)
|
10
|
+
tags = { handled: handled }
|
11
|
+
|
12
|
+
if source
|
13
|
+
return if SKIP_SOURCES.match?(source)
|
14
|
+
tags[:source] = source
|
15
|
+
end
|
16
|
+
|
17
|
+
if context[:tags].is_a?(Hash)
|
18
|
+
context = context.dup
|
19
|
+
tags.merge!(context.delete(:tags))
|
20
|
+
end
|
21
|
+
|
22
|
+
Sentry::Rails.capture_exception(error, level: severity, contexts: { "rails.error" => context }, tags: tags)
|
17
23
|
end
|
18
24
|
end
|
19
25
|
end
|
data/lib/sentry/rails/railtie.rb
CHANGED
@@ -47,12 +47,19 @@ module Sentry
|
|
47
47
|
inject_breadcrumbs_logger
|
48
48
|
activate_tracing
|
49
49
|
|
50
|
-
register_error_subscriber(app) if ::Rails.version.to_f >= 7.0
|
50
|
+
register_error_subscriber(app) if ::Rails.version.to_f >= 7.0 && Sentry.configuration.rails.register_error_subscriber
|
51
51
|
end
|
52
52
|
|
53
53
|
runner do
|
54
54
|
next unless Sentry.initialized?
|
55
55
|
Sentry.configuration.background_worker_threads = 0
|
56
|
+
|
57
|
+
at_exit do
|
58
|
+
# TODO: Add a condition for Rails 7.1 to avoid confliction with https://github.com/rails/rails/pull/44999
|
59
|
+
if $ERROR_INFO && !($ERROR_INFO.is_a?(SystemExit) && $ERROR_INFO.success?)
|
60
|
+
Sentry::Rails.capture_exception($ERROR_INFO, tags: { source: "runner" })
|
61
|
+
end
|
62
|
+
end
|
56
63
|
end
|
57
64
|
|
58
65
|
def configure_project_root
|
@@ -110,7 +117,7 @@ module Sentry
|
|
110
117
|
end
|
111
118
|
|
112
119
|
def activate_tracing
|
113
|
-
if Sentry.configuration.tracing_enabled?
|
120
|
+
if Sentry.configuration.tracing_enabled? && Sentry.configuration.instrumenter == :sentry
|
114
121
|
subscribers = Sentry.configuration.rails.tracing_subscribers
|
115
122
|
Sentry::Rails::Tracing.register_subscribers(subscribers)
|
116
123
|
Sentry::Rails::Tracing.subscribe_tracing_events
|
@@ -40,15 +40,12 @@ module Sentry
|
|
40
40
|
def record_on_current_span(duration:, **options)
|
41
41
|
return unless options[:start_timestamp]
|
42
42
|
|
43
|
-
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
# so we need to covert it as second before calculating the timestamp
|
50
|
-
span.set_timestamp(span.start_timestamp + duration / 1000)
|
51
|
-
yield(span) if block_given?
|
43
|
+
Sentry.with_child_span(**options) do |child_span|
|
44
|
+
# duration in ActiveSupport is computed in millisecond
|
45
|
+
# so we need to covert it as second before calculating the timestamp
|
46
|
+
child_span.set_timestamp(child_span.start_timestamp + duration / 1000)
|
47
|
+
yield(child_span) if block_given?
|
48
|
+
end
|
52
49
|
end
|
53
50
|
end
|
54
51
|
end
|
@@ -8,14 +8,20 @@ module Sentry
|
|
8
8
|
extend InstrumentPayloadCleanupHelper
|
9
9
|
|
10
10
|
EVENT_NAMES = ["process_action.action_controller"].freeze
|
11
|
+
OP_NAME = "view.process_action.action_controller".freeze
|
11
12
|
|
12
13
|
def self.subscribe!
|
14
|
+
Sentry.logger.warn <<~MSG
|
15
|
+
DEPRECATION WARNING: sentry-rails has changed its approach on controller span recording and #{self.name} is now depreacted.
|
16
|
+
Please stop using or referencing #{self.name} as it will be removed in the next major release.
|
17
|
+
MSG
|
18
|
+
|
13
19
|
subscribe_to_event(EVENT_NAMES) do |event_name, duration, payload|
|
14
20
|
controller = payload[:controller]
|
15
21
|
action = payload[:action]
|
16
22
|
|
17
23
|
record_on_current_span(
|
18
|
-
op:
|
24
|
+
op: OP_NAME,
|
19
25
|
start_timestamp: payload[START_TIMESTAMP_NAME],
|
20
26
|
description: "#{controller}##{action}",
|
21
27
|
duration: duration
|
@@ -14,6 +14,7 @@ module Sentry
|
|
14
14
|
|
15
15
|
record_on_current_span(op: SPAN_PREFIX + event_name, start_timestamp: payload[START_TIMESTAMP_NAME], description: payload[:sql], duration: duration) do |span|
|
16
16
|
span.set_data(:connection_id, payload[:connection_id])
|
17
|
+
span.set_tag(:cached, true) if payload.fetch(:cached, false) # cached key is only set for hits in the QueryCache, from Rails 5.1
|
17
18
|
end
|
18
19
|
end
|
19
20
|
end
|
@@ -21,7 +21,7 @@ module Sentry
|
|
21
21
|
|
22
22
|
def self.subscribe!
|
23
23
|
subscribe_to_event(EVENT_NAMES) do |event_name, duration, payload|
|
24
|
-
record_on_current_span(op: event_name, start_timestamp: payload[START_TIMESTAMP_NAME], description: payload[:service], duration: duration) do |span|
|
24
|
+
record_on_current_span(op: "file.#{event_name}".freeze, start_timestamp: payload[START_TIMESTAMP_NAME], description: payload[:service], duration: duration) do |span|
|
25
25
|
payload.each do |key, value|
|
26
26
|
span.set_data(key, value) unless key == START_TIMESTAMP_NAME
|
27
27
|
end
|
data/lib/sentry/rails/tracing.rb
CHANGED
data/lib/sentry/rails/version.rb
CHANGED
data/sentry-rails.gemspec
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: sentry-rails
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 5.
|
4
|
+
version: 5.10.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Sentry Team
|
8
8
|
autorequire:
|
9
9
|
bindir: exe
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2023-07-04 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: railties
|
@@ -25,19 +25,19 @@ dependencies:
|
|
25
25
|
- !ruby/object:Gem::Version
|
26
26
|
version: '5.0'
|
27
27
|
- !ruby/object:Gem::Dependency
|
28
|
-
name: sentry-ruby
|
28
|
+
name: sentry-ruby
|
29
29
|
requirement: !ruby/object:Gem::Requirement
|
30
30
|
requirements:
|
31
31
|
- - "~>"
|
32
32
|
- !ruby/object:Gem::Version
|
33
|
-
version: 5.
|
33
|
+
version: 5.10.0
|
34
34
|
type: :runtime
|
35
35
|
prerelease: false
|
36
36
|
version_requirements: !ruby/object:Gem::Requirement
|
37
37
|
requirements:
|
38
38
|
- - "~>"
|
39
39
|
- !ruby/object:Gem::Version
|
40
|
-
version: 5.
|
40
|
+
version: 5.10.0
|
41
41
|
description: A gem that provides Rails integration for the Sentry error logger
|
42
42
|
email: accounts@sentry.io
|
43
43
|
executables: []
|
@@ -49,7 +49,6 @@ files:
|
|
49
49
|
- ".gitignore"
|
50
50
|
- ".rspec"
|
51
51
|
- CHANGELOG.md
|
52
|
-
- CODE_OF_CONDUCT.md
|
53
52
|
- Gemfile
|
54
53
|
- LICENSE.txt
|
55
54
|
- Makefile
|
data/CODE_OF_CONDUCT.md
DELETED
@@ -1,74 +0,0 @@
|
|
1
|
-
# Contributor Covenant Code of Conduct
|
2
|
-
|
3
|
-
## Our Pledge
|
4
|
-
|
5
|
-
In the interest of fostering an open and welcoming environment, we as
|
6
|
-
contributors and maintainers pledge to making participation in our project and
|
7
|
-
our community a harassment-free experience for everyone, regardless of age, body
|
8
|
-
size, disability, ethnicity, gender identity and expression, level of experience,
|
9
|
-
nationality, personal appearance, race, religion, or sexual identity and
|
10
|
-
orientation.
|
11
|
-
|
12
|
-
## Our Standards
|
13
|
-
|
14
|
-
Examples of behavior that contributes to creating a positive environment
|
15
|
-
include:
|
16
|
-
|
17
|
-
* Using welcoming and inclusive language
|
18
|
-
* Being respectful of differing viewpoints and experiences
|
19
|
-
* Gracefully accepting constructive criticism
|
20
|
-
* Focusing on what is best for the community
|
21
|
-
* Showing empathy towards other community members
|
22
|
-
|
23
|
-
Examples of unacceptable behavior by participants include:
|
24
|
-
|
25
|
-
* The use of sexualized language or imagery and unwelcome sexual attention or
|
26
|
-
advances
|
27
|
-
* Trolling, insulting/derogatory comments, and personal or political attacks
|
28
|
-
* Public or private harassment
|
29
|
-
* Publishing others' private information, such as a physical or electronic
|
30
|
-
address, without explicit permission
|
31
|
-
* Other conduct which could reasonably be considered inappropriate in a
|
32
|
-
professional setting
|
33
|
-
|
34
|
-
## Our Responsibilities
|
35
|
-
|
36
|
-
Project maintainers are responsible for clarifying the standards of acceptable
|
37
|
-
behavior and are expected to take appropriate and fair corrective action in
|
38
|
-
response to any instances of unacceptable behavior.
|
39
|
-
|
40
|
-
Project maintainers have the right and responsibility to remove, edit, or
|
41
|
-
reject comments, commits, code, wiki edits, issues, and other contributions
|
42
|
-
that are not aligned to this Code of Conduct, or to ban temporarily or
|
43
|
-
permanently any contributor for other behaviors that they deem inappropriate,
|
44
|
-
threatening, offensive, or harmful.
|
45
|
-
|
46
|
-
## Scope
|
47
|
-
|
48
|
-
This Code of Conduct applies both within project spaces and in public spaces
|
49
|
-
when an individual is representing the project or its community. Examples of
|
50
|
-
representing a project or community include using an official project e-mail
|
51
|
-
address, posting via an official social media account, or acting as an appointed
|
52
|
-
representative at an online or offline event. Representation of a project may be
|
53
|
-
further defined and clarified by project maintainers.
|
54
|
-
|
55
|
-
## Enforcement
|
56
|
-
|
57
|
-
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
58
|
-
reported by contacting the project team at stan001212@gmail.com. All
|
59
|
-
complaints will be reviewed and investigated and will result in a response that
|
60
|
-
is deemed necessary and appropriate to the circumstances. The project team is
|
61
|
-
obligated to maintain confidentiality with regard to the reporter of an incident.
|
62
|
-
Further details of specific enforcement policies may be posted separately.
|
63
|
-
|
64
|
-
Project maintainers who do not follow or enforce the Code of Conduct in good
|
65
|
-
faith may face temporary or permanent repercussions as determined by other
|
66
|
-
members of the project's leadership.
|
67
|
-
|
68
|
-
## Attribution
|
69
|
-
|
70
|
-
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
71
|
-
available at [https://contributor-covenant.org/version/1/4][version]
|
72
|
-
|
73
|
-
[homepage]: https://contributor-covenant.org
|
74
|
-
[version]: https://contributor-covenant.org/version/1/4/
|