sentry-ruby 5.8.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/Gemfile +8 -2
- data/Rakefile +8 -1
- data/lib/sentry/backtrace.rb +1 -1
- data/lib/sentry/baggage.rb +1 -12
- data/lib/sentry/client.rb +4 -1
- data/lib/sentry/configuration.rb +68 -7
- data/lib/sentry/envelope.rb +1 -4
- data/lib/sentry/hub.rb +9 -2
- data/lib/sentry/net/http.rb +6 -6
- data/lib/sentry/profiler.rb +222 -0
- data/lib/sentry/puma.rb +25 -0
- data/lib/sentry/redis.rb +2 -6
- data/lib/sentry/scope.rb +6 -1
- data/lib/sentry/transaction.rb +15 -0
- data/lib/sentry/transaction_event.rb +30 -0
- data/lib/sentry/transport.rb +7 -0
- data/lib/sentry/utils/argument_checking_helper.rb +3 -3
- data/lib/sentry/version.rb +1 -1
- data/lib/sentry-ruby.rb +13 -2
- metadata +4 -3
- 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: 2373a9b8990fd62763c4d1b26001f953f95efdd8b51f803e5d59bdb1ba984e3e
|
4
|
+
data.tar.gz: d09371eb4bf3aaff6e7735f74cd5887b2e99f636a60f1dca3cf653bbb8ba9bb4
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4799b727ddaab0622be00e73b58a2e3f723779e1b46c7d5007d5711a8897022190ff9f87cc90df7411f32fd6b59d4f4637bcf26cc7eba8484cb04429871e9242
|
7
|
+
data.tar.gz: d97d9272ee815447ebdcbb72adb4e2255584475547e7878ed6c7af4f312d170bd37f3029acaaa6866eb04f2d89c1581c4854b849c2d57a1a51eb4b67e4ebeb0e
|
data/Gemfile
CHANGED
@@ -10,6 +10,8 @@ gem "rack", "~> #{Gem::Version.new(rack_version)}" unless rack_version == "0"
|
|
10
10
|
redis_rb_version = ENV.fetch("REDIS_RB_VERSION", "5.0")
|
11
11
|
gem "redis", "~> #{redis_rb_version}"
|
12
12
|
|
13
|
+
gem "puma"
|
14
|
+
|
13
15
|
gem "rake", "~> 12.0"
|
14
16
|
gem "rspec", "~> 3.0"
|
15
17
|
gem "rspec-retry"
|
@@ -17,9 +19,13 @@ gem "timecop"
|
|
17
19
|
gem "simplecov"
|
18
20
|
gem "simplecov-cobertura", "~> 1.4"
|
19
21
|
gem "rexml"
|
22
|
+
gem "stackprof" unless RUBY_PLATFORM == "java"
|
23
|
+
|
24
|
+
if RUBY_VERSION.to_f >= 2.6
|
25
|
+
gem "debug", github: "ruby/debug", platform: :ruby
|
26
|
+
gem "irb"
|
27
|
+
end
|
20
28
|
|
21
|
-
gem "object_tracer"
|
22
|
-
gem "debug", github: "ruby/debug", platform: :ruby if RUBY_VERSION.to_f >= 2.6
|
23
29
|
gem "pry"
|
24
30
|
|
25
31
|
gem "benchmark-ips"
|
data/Rakefile
CHANGED
@@ -8,6 +8,13 @@ require "rspec/core/rake_task"
|
|
8
8
|
|
9
9
|
RSpec::Core::RakeTask.new(:spec).tap do |task|
|
10
10
|
task.rspec_opts = "--order rand"
|
11
|
+
task.exclude_pattern = "spec/isolated/**/*_spec.rb"
|
11
12
|
end
|
12
13
|
|
13
|
-
task :
|
14
|
+
task :isolated_specs do
|
15
|
+
Dir["spec/isolated/*"].each do |file|
|
16
|
+
sh "bundle exec rspec #{file}"
|
17
|
+
end
|
18
|
+
end
|
19
|
+
|
20
|
+
task :default => [:spec, :isolated_specs]
|
data/lib/sentry/backtrace.rb
CHANGED
data/lib/sentry/baggage.rb
CHANGED
@@ -8,17 +8,6 @@ module Sentry
|
|
8
8
|
SENTRY_PREFIX = 'sentry-'
|
9
9
|
SENTRY_PREFIX_REGEX = /^sentry-/.freeze
|
10
10
|
|
11
|
-
DSC_KEYS = %w(
|
12
|
-
trace_id
|
13
|
-
public_key
|
14
|
-
sample_rate
|
15
|
-
release
|
16
|
-
environment
|
17
|
-
transaction
|
18
|
-
user_id
|
19
|
-
user_segment
|
20
|
-
).freeze
|
21
|
-
|
22
11
|
# @return [Hash]
|
23
12
|
attr_reader :items
|
24
13
|
|
@@ -68,7 +57,7 @@ module Sentry
|
|
68
57
|
# hash to be used in the trace envelope header.
|
69
58
|
# @return [Hash]
|
70
59
|
def dynamic_sampling_context
|
71
|
-
@items
|
60
|
+
@items
|
72
61
|
end
|
73
62
|
|
74
63
|
# Serialize the Baggage object back to a string.
|
data/lib/sentry/client.rb
CHANGED
@@ -76,7 +76,10 @@ module Sentry
|
|
76
76
|
# @param hint [Hash] the hint data that'll be passed to `before_send` callback and the scope's event processors.
|
77
77
|
# @return [Event, nil]
|
78
78
|
def event_from_exception(exception, hint = {})
|
79
|
-
return unless @configuration.sending_allowed?
|
79
|
+
return unless @configuration.sending_allowed?
|
80
|
+
|
81
|
+
ignore_exclusions = hint.delete(:ignore_exclusions) { false }
|
82
|
+
return if !ignore_exclusions && !@configuration.exception_class_allowed?(exception)
|
80
83
|
|
81
84
|
integration_meta = Sentry.integrations[hint[:integration]]
|
82
85
|
|
data/lib/sentry/configuration.rb
CHANGED
@@ -14,6 +14,8 @@ module Sentry
|
|
14
14
|
class Configuration
|
15
15
|
include CustomInspection
|
16
16
|
include LoggingHelper
|
17
|
+
include ArgumentCheckingHelper
|
18
|
+
|
17
19
|
# Directories to be recognized as part of your app. e.g. if you
|
18
20
|
# have an `engines` dir at the root of your project, you may want
|
19
21
|
# to set this to something like /(app|config|engines|lib)/
|
@@ -179,7 +181,7 @@ module Sentry
|
|
179
181
|
# Release tag to be passed with every event sent to Sentry.
|
180
182
|
# We automatically try to set this to a git SHA or Capistrano release.
|
181
183
|
# @return [String]
|
182
|
-
|
184
|
+
attr_reader :release
|
183
185
|
|
184
186
|
# The sampling factor to apply to events. A value of 0.0 will not send
|
185
187
|
# any events, and a value of 1.0 will send 100% of events.
|
@@ -214,8 +216,8 @@ module Sentry
|
|
214
216
|
attr_reader :transport
|
215
217
|
|
216
218
|
# Take a float between 0.0 and 1.0 as the sample rate for tracing events (transactions).
|
217
|
-
# @return [Float]
|
218
|
-
|
219
|
+
# @return [Float, nil]
|
220
|
+
attr_reader :traces_sample_rate
|
219
221
|
|
220
222
|
# Take a Proc that controls the sample rate for every tracing event, e.g.
|
221
223
|
# @example
|
@@ -227,6 +229,11 @@ module Sentry
|
|
227
229
|
# @return [Proc]
|
228
230
|
attr_accessor :traces_sampler
|
229
231
|
|
232
|
+
# Easier way to use performance tracing
|
233
|
+
# If set to true, will set traces_sample_rate to 1.0
|
234
|
+
# @return [Boolean, nil]
|
235
|
+
attr_reader :enable_tracing
|
236
|
+
|
230
237
|
# Send diagnostic client reports about dropped events, true by default
|
231
238
|
# tries to attach to an existing envelope max once every 30s
|
232
239
|
# @return [Boolean]
|
@@ -240,10 +247,25 @@ module Sentry
|
|
240
247
|
# @return [Symbol]
|
241
248
|
attr_reader :instrumenter
|
242
249
|
|
250
|
+
# Take a float between 0.0 and 1.0 as the sample rate for capturing profiles.
|
251
|
+
# Note that this rate is relative to traces_sample_rate / traces_sampler,
|
252
|
+
# i.e. the profile is sampled by this rate after the transaction is sampled.
|
253
|
+
# @return [Float, nil]
|
254
|
+
attr_reader :profiles_sample_rate
|
255
|
+
|
243
256
|
# these are not config options
|
244
257
|
# @!visibility private
|
245
258
|
attr_reader :errors, :gem_specs
|
246
259
|
|
260
|
+
# These exceptions could enter Puma's `lowlevel_error_handler` callback and the SDK's Puma integration
|
261
|
+
# But they are mostly considered as noise and should be ignored by default
|
262
|
+
# Please see https://github.com/getsentry/sentry-ruby/pull/2026 for more information
|
263
|
+
PUMA_IGNORE_DEFAULT = [
|
264
|
+
'Puma::MiniSSL::SSLError',
|
265
|
+
'Puma::HttpParserError',
|
266
|
+
'Puma::HttpParserError501'
|
267
|
+
].freeze
|
268
|
+
|
247
269
|
# Most of these errors generate 4XX responses. In general, Sentry clients
|
248
270
|
# only automatically report 5xx responses.
|
249
271
|
IGNORE_DEFAULT = [
|
@@ -293,7 +315,7 @@ module Sentry
|
|
293
315
|
self.environment = environment_from_env
|
294
316
|
self.enabled_environments = []
|
295
317
|
self.exclude_loggers = []
|
296
|
-
self.excluded_exceptions = IGNORE_DEFAULT
|
318
|
+
self.excluded_exceptions = IGNORE_DEFAULT + PUMA_IGNORE_DEFAULT
|
297
319
|
self.inspect_exception_causes_for_exclusion = true
|
298
320
|
self.linecache = ::Sentry::LineCache.new
|
299
321
|
self.logger = ::Sentry::Logger.new(STDOUT)
|
@@ -314,8 +336,8 @@ module Sentry
|
|
314
336
|
self.before_send = nil
|
315
337
|
self.before_send_transaction = nil
|
316
338
|
self.rack_env_whitelist = RACK_ENV_WHITELIST_DEFAULT
|
317
|
-
self.traces_sample_rate = nil
|
318
339
|
self.traces_sampler = nil
|
340
|
+
self.enable_tracing = nil
|
319
341
|
|
320
342
|
@transport = Transport::Configuration.new
|
321
343
|
@gem_specs = Hash[Gem::Specification.map { |spec| [spec.name, spec.version.to_s] }] if Gem::Specification.respond_to?(:map)
|
@@ -329,6 +351,12 @@ module Sentry
|
|
329
351
|
|
330
352
|
alias server= dsn=
|
331
353
|
|
354
|
+
def release=(value)
|
355
|
+
check_argument_type!(value, String, NilClass)
|
356
|
+
|
357
|
+
@release = value
|
358
|
+
end
|
359
|
+
|
332
360
|
def async=(value)
|
333
361
|
check_callable!("async", value)
|
334
362
|
|
@@ -384,6 +412,26 @@ module Sentry
|
|
384
412
|
@instrumenter = INSTRUMENTERS.include?(instrumenter) ? instrumenter : :sentry
|
385
413
|
end
|
386
414
|
|
415
|
+
def enable_tracing=(enable_tracing)
|
416
|
+
@enable_tracing = enable_tracing
|
417
|
+
@traces_sample_rate ||= 1.0 if enable_tracing
|
418
|
+
end
|
419
|
+
|
420
|
+
def is_numeric_or_nil?(value)
|
421
|
+
value.is_a?(Numeric) || value.nil?
|
422
|
+
end
|
423
|
+
|
424
|
+
def traces_sample_rate=(traces_sample_rate)
|
425
|
+
raise ArgumentError, "traces_sample_rate must be a Numeric or nil" unless is_numeric_or_nil?(traces_sample_rate)
|
426
|
+
@traces_sample_rate = traces_sample_rate
|
427
|
+
end
|
428
|
+
|
429
|
+
def profiles_sample_rate=(profiles_sample_rate)
|
430
|
+
raise ArgumentError, "profiles_sample_rate must be a Numeric or nil" unless is_numeric_or_nil?(profiles_sample_rate)
|
431
|
+
log_info("Please make sure to include the 'stackprof' gem in your Gemfile to use Profiling with Sentry.") unless defined?(StackProf)
|
432
|
+
@profiles_sample_rate = profiles_sample_rate
|
433
|
+
end
|
434
|
+
|
387
435
|
def sending_allowed?
|
388
436
|
@errors = []
|
389
437
|
|
@@ -413,8 +461,21 @@ module Sentry
|
|
413
461
|
enabled_environments.empty? || enabled_environments.include?(environment)
|
414
462
|
end
|
415
463
|
|
464
|
+
def valid_sample_rate?(sample_rate)
|
465
|
+
return false unless sample_rate.is_a?(Numeric)
|
466
|
+
sample_rate >= 0.0 && sample_rate <= 1.0
|
467
|
+
end
|
468
|
+
|
416
469
|
def tracing_enabled?
|
417
|
-
!!((@traces_sample_rate
|
470
|
+
valid_sampler = !!((valid_sample_rate?(@traces_sample_rate)) || @traces_sampler)
|
471
|
+
|
472
|
+
(@enable_tracing != false) && valid_sampler && sending_allowed?
|
473
|
+
end
|
474
|
+
|
475
|
+
def profiling_enabled?
|
476
|
+
valid_sampler = !!(valid_sample_rate?(@profiles_sample_rate))
|
477
|
+
|
478
|
+
tracing_enabled? && valid_sampler && sending_allowed?
|
418
479
|
end
|
419
480
|
|
420
481
|
# @return [String, nil]
|
@@ -442,7 +503,7 @@ module Sentry
|
|
442
503
|
def detect_release
|
443
504
|
return unless sending_allowed?
|
444
505
|
|
445
|
-
|
506
|
+
@release ||= ReleaseDetector.detect_release(project_root: project_root, running_on_heroku: running_on_heroku?)
|
446
507
|
|
447
508
|
if running_on_heroku? && release.nil?
|
448
509
|
log_warn(HEROKU_DYNO_METADATA_MESSAGE)
|
data/lib/sentry/envelope.rb
CHANGED
data/lib/sentry/hub.rb
CHANGED
@@ -88,8 +88,10 @@ module Sentry
|
|
88
88
|
}
|
89
89
|
|
90
90
|
sampling_context.merge!(custom_sampling_context)
|
91
|
-
|
92
91
|
transaction.set_initial_sample_decision(sampling_context: sampling_context)
|
92
|
+
|
93
|
+
transaction.start_profiler!
|
94
|
+
|
93
95
|
transaction
|
94
96
|
end
|
95
97
|
|
@@ -114,7 +116,11 @@ module Sentry
|
|
114
116
|
end
|
115
117
|
|
116
118
|
def capture_exception(exception, **options, &block)
|
117
|
-
|
119
|
+
if RUBY_PLATFORM == "java"
|
120
|
+
check_argument_type!(exception, ::Exception, ::Java::JavaLang::Throwable)
|
121
|
+
else
|
122
|
+
check_argument_type!(exception, ::Exception)
|
123
|
+
end
|
118
124
|
|
119
125
|
return if Sentry.exception_captured?(exception)
|
120
126
|
|
@@ -122,6 +128,7 @@ module Sentry
|
|
122
128
|
|
123
129
|
options[:hint] ||= {}
|
124
130
|
options[:hint][:exception] = exception
|
131
|
+
|
125
132
|
event = current_client.event_from_exception(exception, options[:hint])
|
126
133
|
|
127
134
|
return unless event
|
data/lib/sentry/net/http.rb
CHANGED
@@ -38,7 +38,10 @@ module Sentry
|
|
38
38
|
if sentry_span
|
39
39
|
request_info = extract_request_info(req)
|
40
40
|
sentry_span.set_description("#{request_info[:method]} #{request_info[:url]}")
|
41
|
-
sentry_span.set_data(
|
41
|
+
sentry_span.set_data('url', request_info[:url])
|
42
|
+
sentry_span.set_data('http.method', request_info[:method])
|
43
|
+
sentry_span.set_data('http.query', request_info[:query]) if request_info[:query]
|
44
|
+
sentry_span.set_data('status', res.code.to_i)
|
42
45
|
end
|
43
46
|
end
|
44
47
|
end
|
@@ -87,7 +90,7 @@ module Sentry
|
|
87
90
|
result = { method: req.method, url: url }
|
88
91
|
|
89
92
|
if Sentry.configuration.send_default_pii
|
90
|
-
result[:
|
93
|
+
result[:query] = uri.query
|
91
94
|
result[:body] = req.body
|
92
95
|
end
|
93
96
|
|
@@ -97,7 +100,4 @@ module Sentry
|
|
97
100
|
end
|
98
101
|
end
|
99
102
|
|
100
|
-
Sentry.register_patch
|
101
|
-
patch = Sentry::Net::HTTP
|
102
|
-
Net::HTTP.send(:prepend, patch) unless Net::HTTP.ancestors.include?(patch)
|
103
|
-
end
|
103
|
+
Sentry.register_patch(Sentry::Net::HTTP, Net::HTTP)
|
@@ -0,0 +1,222 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require 'securerandom'
|
4
|
+
|
5
|
+
module Sentry
|
6
|
+
class Profiler
|
7
|
+
VERSION = '1'
|
8
|
+
PLATFORM = 'ruby'
|
9
|
+
# 101 Hz in microseconds
|
10
|
+
DEFAULT_INTERVAL = 1e6 / 101
|
11
|
+
MICRO_TO_NANO_SECONDS = 1e3
|
12
|
+
|
13
|
+
attr_reader :sampled, :started, :event_id
|
14
|
+
|
15
|
+
def initialize(configuration)
|
16
|
+
@event_id = SecureRandom.uuid.delete('-')
|
17
|
+
@started = false
|
18
|
+
@sampled = nil
|
19
|
+
|
20
|
+
@profiling_enabled = defined?(StackProf) && configuration.profiling_enabled?
|
21
|
+
@profiles_sample_rate = configuration.profiles_sample_rate
|
22
|
+
@project_root = configuration.project_root
|
23
|
+
@app_dirs_pattern = configuration.app_dirs_pattern || Backtrace::APP_DIRS_PATTERN
|
24
|
+
@in_app_pattern = Regexp.new("^(#{@project_root}/)?#{@app_dirs_pattern}")
|
25
|
+
end
|
26
|
+
|
27
|
+
def start
|
28
|
+
return unless @sampled
|
29
|
+
|
30
|
+
@started = StackProf.start(interval: DEFAULT_INTERVAL,
|
31
|
+
mode: :wall,
|
32
|
+
raw: true,
|
33
|
+
aggregate: false)
|
34
|
+
|
35
|
+
@started ? log('Started') : log('Not started since running elsewhere')
|
36
|
+
end
|
37
|
+
|
38
|
+
def stop
|
39
|
+
return unless @sampled
|
40
|
+
return unless @started
|
41
|
+
|
42
|
+
StackProf.stop
|
43
|
+
log('Stopped')
|
44
|
+
end
|
45
|
+
|
46
|
+
# Sets initial sampling decision of the profile.
|
47
|
+
# @return [void]
|
48
|
+
def set_initial_sample_decision(transaction_sampled)
|
49
|
+
unless @profiling_enabled
|
50
|
+
@sampled = false
|
51
|
+
return
|
52
|
+
end
|
53
|
+
|
54
|
+
unless transaction_sampled
|
55
|
+
@sampled = false
|
56
|
+
log('Discarding profile because transaction not sampled')
|
57
|
+
return
|
58
|
+
end
|
59
|
+
|
60
|
+
case @profiles_sample_rate
|
61
|
+
when 0.0
|
62
|
+
@sampled = false
|
63
|
+
log('Discarding profile because sample_rate is 0')
|
64
|
+
return
|
65
|
+
when 1.0
|
66
|
+
@sampled = true
|
67
|
+
return
|
68
|
+
else
|
69
|
+
@sampled = Random.rand < @profiles_sample_rate
|
70
|
+
end
|
71
|
+
|
72
|
+
log('Discarding profile due to sampling decision') unless @sampled
|
73
|
+
end
|
74
|
+
|
75
|
+
def to_hash
|
76
|
+
return {} unless @sampled
|
77
|
+
return {} unless @started
|
78
|
+
|
79
|
+
results = StackProf.results
|
80
|
+
return {} unless results
|
81
|
+
return {} if results.empty?
|
82
|
+
return {} if results[:samples] == 0
|
83
|
+
return {} unless results[:raw]
|
84
|
+
|
85
|
+
frame_map = {}
|
86
|
+
|
87
|
+
frames = results[:frames].to_enum.with_index.map do |frame, idx|
|
88
|
+
frame_id, frame_data = frame
|
89
|
+
|
90
|
+
# need to map over stackprof frame ids to ours
|
91
|
+
frame_map[frame_id] = idx
|
92
|
+
|
93
|
+
file_path = frame_data[:file]
|
94
|
+
in_app = in_app?(file_path)
|
95
|
+
filename = compute_filename(file_path, in_app)
|
96
|
+
function, mod = split_module(frame_data[:name])
|
97
|
+
|
98
|
+
frame_hash = {
|
99
|
+
abs_path: file_path,
|
100
|
+
function: function,
|
101
|
+
filename: filename,
|
102
|
+
in_app: in_app
|
103
|
+
}
|
104
|
+
|
105
|
+
frame_hash[:module] = mod if mod
|
106
|
+
frame_hash[:lineno] = frame_data[:line] if frame_data[:line]
|
107
|
+
|
108
|
+
frame_hash
|
109
|
+
end
|
110
|
+
|
111
|
+
idx = 0
|
112
|
+
stacks = []
|
113
|
+
num_seen = []
|
114
|
+
|
115
|
+
# extract stacks from raw
|
116
|
+
# raw is a single array of [.., len_stack, *stack_frames(len_stack), num_stack_seen , ..]
|
117
|
+
while (len = results[:raw][idx])
|
118
|
+
idx += 1
|
119
|
+
|
120
|
+
# our call graph is reversed
|
121
|
+
stack = results[:raw].slice(idx, len).map { |id| frame_map[id] }.compact.reverse
|
122
|
+
stacks << stack
|
123
|
+
|
124
|
+
num_seen << results[:raw][idx + len]
|
125
|
+
idx += len + 1
|
126
|
+
|
127
|
+
log('Unknown frame in stack') if stack.size != len
|
128
|
+
end
|
129
|
+
|
130
|
+
idx = 0
|
131
|
+
elapsed_since_start_ns = 0
|
132
|
+
samples = []
|
133
|
+
|
134
|
+
num_seen.each_with_index do |n, i|
|
135
|
+
n.times do
|
136
|
+
# stackprof deltas are in microseconds
|
137
|
+
delta = results[:raw_timestamp_deltas][idx]
|
138
|
+
elapsed_since_start_ns += (delta * MICRO_TO_NANO_SECONDS).to_i
|
139
|
+
idx += 1
|
140
|
+
|
141
|
+
# Not sure why but some deltas are very small like 0/1 values,
|
142
|
+
# they pollute our flamegraph so just ignore them for now.
|
143
|
+
# Open issue at https://github.com/tmm1/stackprof/issues/201
|
144
|
+
next if delta < 10
|
145
|
+
|
146
|
+
samples << {
|
147
|
+
stack_id: i,
|
148
|
+
# TODO-neel-profiler we need to patch rb_profile_frames and write our own C extension to enable threading info.
|
149
|
+
# Till then, on multi-threaded servers like puma, we will get frames from other active threads when the one
|
150
|
+
# we're profiling is idle/sleeping/waiting for IO etc.
|
151
|
+
# https://bugs.ruby-lang.org/issues/10602
|
152
|
+
thread_id: '0',
|
153
|
+
elapsed_since_start_ns: elapsed_since_start_ns.to_s
|
154
|
+
}
|
155
|
+
end
|
156
|
+
end
|
157
|
+
|
158
|
+
log('Some samples thrown away') if samples.size != results[:samples]
|
159
|
+
|
160
|
+
if samples.size <= 2
|
161
|
+
log('Not enough samples, discarding profiler')
|
162
|
+
return {}
|
163
|
+
end
|
164
|
+
|
165
|
+
profile = {
|
166
|
+
frames: frames,
|
167
|
+
stacks: stacks,
|
168
|
+
samples: samples
|
169
|
+
}
|
170
|
+
|
171
|
+
{
|
172
|
+
event_id: @event_id,
|
173
|
+
platform: PLATFORM,
|
174
|
+
version: VERSION,
|
175
|
+
profile: profile
|
176
|
+
}
|
177
|
+
end
|
178
|
+
|
179
|
+
private
|
180
|
+
|
181
|
+
def log(message)
|
182
|
+
Sentry.logger.debug(LOGGER_PROGNAME) { "[Profiler] #{message}" }
|
183
|
+
end
|
184
|
+
|
185
|
+
def in_app?(abs_path)
|
186
|
+
abs_path.match?(@in_app_pattern)
|
187
|
+
end
|
188
|
+
|
189
|
+
# copied from stacktrace.rb since I don't want to touch existing code
|
190
|
+
# TODO-neel-profiler try to fetch this from stackprof once we patch
|
191
|
+
# the native extension
|
192
|
+
def compute_filename(abs_path, in_app)
|
193
|
+
return nil if abs_path.nil?
|
194
|
+
|
195
|
+
under_project_root = @project_root && abs_path.start_with?(@project_root)
|
196
|
+
|
197
|
+
prefix =
|
198
|
+
if under_project_root && in_app
|
199
|
+
@project_root
|
200
|
+
else
|
201
|
+
longest_load_path = $LOAD_PATH.select { |path| abs_path.start_with?(path.to_s) }.max_by(&:size)
|
202
|
+
|
203
|
+
if under_project_root
|
204
|
+
longest_load_path || @project_root
|
205
|
+
else
|
206
|
+
longest_load_path
|
207
|
+
end
|
208
|
+
end
|
209
|
+
|
210
|
+
prefix ? abs_path[prefix.to_s.chomp(File::SEPARATOR).length + 1..-1] : abs_path
|
211
|
+
end
|
212
|
+
|
213
|
+
def split_module(name)
|
214
|
+
# last module plus class/instance method
|
215
|
+
i = name.rindex('::')
|
216
|
+
function = i ? name[(i + 2)..-1] : name
|
217
|
+
mod = i ? name[0...i] : nil
|
218
|
+
|
219
|
+
[function, mod]
|
220
|
+
end
|
221
|
+
end
|
222
|
+
end
|
data/lib/sentry/puma.rb
ADDED
@@ -0,0 +1,25 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Sentry
|
4
|
+
module Puma
|
5
|
+
module Server
|
6
|
+
def lowlevel_error(e, env, status=500)
|
7
|
+
result = super
|
8
|
+
|
9
|
+
begin
|
10
|
+
Sentry.capture_exception(e) do |scope|
|
11
|
+
scope.set_rack_env(env)
|
12
|
+
end
|
13
|
+
rescue
|
14
|
+
# if anything happens, we don't want to break the app
|
15
|
+
end
|
16
|
+
|
17
|
+
result
|
18
|
+
end
|
19
|
+
end
|
20
|
+
end
|
21
|
+
end
|
22
|
+
|
23
|
+
if defined?(Puma::Server)
|
24
|
+
Sentry.register_patch(Sentry::Puma::Server, Puma::Server)
|
25
|
+
end
|
data/lib/sentry/redis.rb
CHANGED
@@ -30,6 +30,7 @@ module Sentry
|
|
30
30
|
attr_reader :commands, :host, :port, :db
|
31
31
|
|
32
32
|
def record_breadcrumb
|
33
|
+
return unless Sentry.initialized?
|
33
34
|
return unless Sentry.configuration.breadcrumbs_logger.include?(LOGGER_NAME)
|
34
35
|
|
35
36
|
Sentry.add_breadcrumb(
|
@@ -95,12 +96,7 @@ end
|
|
95
96
|
|
96
97
|
if defined?(::Redis::Client)
|
97
98
|
if Gem::Version.new(::Redis::VERSION) < Gem::Version.new("5.0")
|
98
|
-
Sentry.register_patch
|
99
|
-
patch = Sentry::Redis::OldClientPatch
|
100
|
-
unless Redis::Client.ancestors.include?(patch)
|
101
|
-
Redis::Client.prepend(patch)
|
102
|
-
end
|
103
|
-
end
|
99
|
+
Sentry.register_patch(Sentry::Redis::OldClientPatch, ::Redis::Client)
|
104
100
|
elsif defined?(RedisClient)
|
105
101
|
RedisClient.register(Sentry::Redis::GlobalRedisInstrumentation)
|
106
102
|
end
|
data/lib/sentry/scope.rb
CHANGED
@@ -192,6 +192,10 @@ module Sentry
|
|
192
192
|
# @return [Hash]
|
193
193
|
def set_contexts(contexts_hash)
|
194
194
|
check_argument_type!(contexts_hash, Hash)
|
195
|
+
contexts_hash.values.each do |val|
|
196
|
+
check_argument_type!(val, Hash)
|
197
|
+
end
|
198
|
+
|
195
199
|
@contexts.merge!(contexts_hash) do |key, old, new|
|
196
200
|
old.merge(new)
|
197
201
|
end
|
@@ -305,7 +309,8 @@ module Sentry
|
|
305
309
|
name: uname[:sysname] || RbConfig::CONFIG["host_os"],
|
306
310
|
version: uname[:version],
|
307
311
|
build: uname[:release],
|
308
|
-
kernel_version: uname[:version]
|
312
|
+
kernel_version: uname[:version],
|
313
|
+
machine: uname[:machine]
|
309
314
|
}
|
310
315
|
end
|
311
316
|
end
|
data/lib/sentry/transaction.rb
CHANGED
@@ -1,6 +1,7 @@
|
|
1
1
|
# frozen_string_literal: true
|
2
2
|
|
3
3
|
require "sentry/baggage"
|
4
|
+
require "sentry/profiler"
|
4
5
|
|
5
6
|
module Sentry
|
6
7
|
class Transaction < Span
|
@@ -58,6 +59,10 @@ module Sentry
|
|
58
59
|
# @return [Hash]
|
59
60
|
attr_reader :contexts
|
60
61
|
|
62
|
+
# The Profiler instance for this transaction.
|
63
|
+
# @return [Profiler]
|
64
|
+
attr_reader :profiler
|
65
|
+
|
61
66
|
def initialize(
|
62
67
|
hub:,
|
63
68
|
name: nil,
|
@@ -83,6 +88,7 @@ module Sentry
|
|
83
88
|
@effective_sample_rate = nil
|
84
89
|
@contexts = {}
|
85
90
|
@measurements = {}
|
91
|
+
@profiler = Profiler.new(@configuration)
|
86
92
|
init_span_recorder
|
87
93
|
end
|
88
94
|
|
@@ -254,6 +260,8 @@ module Sentry
|
|
254
260
|
@name = UNLABELD_NAME
|
255
261
|
end
|
256
262
|
|
263
|
+
@profiler.stop
|
264
|
+
|
257
265
|
if @sampled
|
258
266
|
event = hub.current_client.event_from_transaction(self)
|
259
267
|
hub.capture_event(event)
|
@@ -288,6 +296,13 @@ module Sentry
|
|
288
296
|
@contexts[key] = value
|
289
297
|
end
|
290
298
|
|
299
|
+
# Start the profiler.
|
300
|
+
# @return [void]
|
301
|
+
def start_profiler!
|
302
|
+
profiler.set_initial_sample_decision(sampled)
|
303
|
+
profiler.start
|
304
|
+
end
|
305
|
+
|
291
306
|
protected
|
292
307
|
|
293
308
|
def init_span_recorder(limit = 1000)
|
@@ -17,6 +17,9 @@ module Sentry
|
|
17
17
|
# @return [Float, nil]
|
18
18
|
attr_reader :start_timestamp
|
19
19
|
|
20
|
+
# @return [Hash, nil]
|
21
|
+
attr_accessor :profile
|
22
|
+
|
20
23
|
def initialize(transaction:, **options)
|
21
24
|
super(**options)
|
22
25
|
|
@@ -32,6 +35,8 @@ module Sentry
|
|
32
35
|
|
33
36
|
finished_spans = transaction.span_recorder.spans.select { |span| span.timestamp && span != transaction }
|
34
37
|
self.spans = finished_spans.map(&:to_hash)
|
38
|
+
|
39
|
+
populate_profile(transaction)
|
35
40
|
end
|
36
41
|
|
37
42
|
# Sets the event's start_timestamp.
|
@@ -49,5 +54,30 @@ module Sentry
|
|
49
54
|
data[:measurements] = @measurements
|
50
55
|
data
|
51
56
|
end
|
57
|
+
|
58
|
+
private
|
59
|
+
|
60
|
+
def populate_profile(transaction)
|
61
|
+
profile_hash = transaction.profiler.to_hash
|
62
|
+
return if profile_hash.empty?
|
63
|
+
|
64
|
+
profile_hash.merge!(
|
65
|
+
environment: environment,
|
66
|
+
release: release,
|
67
|
+
timestamp: Time.at(start_timestamp).iso8601,
|
68
|
+
device: { architecture: Scope.os_context[:machine] },
|
69
|
+
os: { name: Scope.os_context[:name], version: Scope.os_context[:version] },
|
70
|
+
runtime: Scope.runtime_context,
|
71
|
+
transaction: {
|
72
|
+
id: event_id,
|
73
|
+
name: transaction.name,
|
74
|
+
trace_id: transaction.trace_id,
|
75
|
+
# TODO-neel-profiler stubbed for now, see thread_id note in profiler.rb
|
76
|
+
active_thead_id: '0'
|
77
|
+
}
|
78
|
+
)
|
79
|
+
|
80
|
+
self.profile = profile_hash
|
81
|
+
end
|
52
82
|
end
|
53
83
|
end
|
data/lib/sentry/transport.rb
CHANGED
@@ -154,6 +154,13 @@ module Sentry
|
|
154
154
|
event_payload
|
155
155
|
)
|
156
156
|
|
157
|
+
if event.is_a?(TransactionEvent) && event.profile
|
158
|
+
envelope.add_item(
|
159
|
+
{ type: 'profile', content_type: 'application/json' },
|
160
|
+
event.profile
|
161
|
+
)
|
162
|
+
end
|
163
|
+
|
157
164
|
client_report_headers, client_report_payload = fetch_pending_client_report
|
158
165
|
envelope.add_item(client_report_headers, client_report_payload) if client_report_headers
|
159
166
|
|
@@ -4,9 +4,9 @@ module Sentry
|
|
4
4
|
module ArgumentCheckingHelper
|
5
5
|
private
|
6
6
|
|
7
|
-
def check_argument_type!(argument,
|
8
|
-
unless argument.is_a?(
|
9
|
-
raise ArgumentError, "expect the argument to be a #{
|
7
|
+
def check_argument_type!(argument, *expected_types)
|
8
|
+
unless expected_types.any? { |t| argument.is_a?(t) }
|
9
|
+
raise ArgumentError, "expect the argument to be a #{expected_types.join(' or ')}, got #{argument.class} (#{argument.inspect})"
|
10
10
|
end
|
11
11
|
end
|
12
12
|
end
|
data/lib/sentry/version.rb
CHANGED
data/lib/sentry-ruby.rb
CHANGED
@@ -73,8 +73,18 @@ module Sentry
|
|
73
73
|
##### Patch Registration #####
|
74
74
|
|
75
75
|
# @!visibility private
|
76
|
-
def register_patch(&block)
|
77
|
-
|
76
|
+
def register_patch(patch = nil, target = nil, &block)
|
77
|
+
if patch && block
|
78
|
+
raise ArgumentError.new("Please provide either a patch and its target OR a block, but not both")
|
79
|
+
end
|
80
|
+
|
81
|
+
if block
|
82
|
+
registered_patches << block
|
83
|
+
else
|
84
|
+
registered_patches << proc do
|
85
|
+
target.send(:prepend, patch) unless target.ancestors.include?(patch)
|
86
|
+
end
|
87
|
+
end
|
78
88
|
end
|
79
89
|
|
80
90
|
# @!visibility private
|
@@ -509,3 +519,4 @@ end
|
|
509
519
|
# patches
|
510
520
|
require "sentry/net/http"
|
511
521
|
require "sentry/redis"
|
522
|
+
require "sentry/puma"
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: sentry-ruby
|
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: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2023-
|
11
|
+
date: 2023-07-04 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: concurrent-ruby
|
@@ -42,7 +42,6 @@ files:
|
|
42
42
|
- ".rspec"
|
43
43
|
- ".yardopts"
|
44
44
|
- CHANGELOG.md
|
45
|
-
- CODE_OF_CONDUCT.md
|
46
45
|
- Gemfile
|
47
46
|
- LICENSE.txt
|
48
47
|
- Makefile
|
@@ -78,6 +77,8 @@ files:
|
|
78
77
|
- lib/sentry/linecache.rb
|
79
78
|
- lib/sentry/logger.rb
|
80
79
|
- lib/sentry/net/http.rb
|
80
|
+
- lib/sentry/profiler.rb
|
81
|
+
- lib/sentry/puma.rb
|
81
82
|
- lib/sentry/rack.rb
|
82
83
|
- lib/sentry/rack/capture_exceptions.rb
|
83
84
|
- lib/sentry/rake.rb
|
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/
|