sentry-ruby 5.11.0 → 5.12.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +7 -1
- data/README.md +8 -8
- data/lib/sentry/check_in_event.rb +60 -0
- data/lib/sentry/client.rb +31 -0
- data/lib/sentry/cron/monitor_check_ins.rb +61 -0
- data/lib/sentry/cron/monitor_config.rb +53 -0
- data/lib/sentry/cron/monitor_schedule.rb +42 -0
- data/lib/sentry/envelope.rb +1 -1
- data/lib/sentry/hub.rb +25 -1
- data/lib/sentry/integrable.rb +6 -0
- data/lib/sentry/interfaces/single_exception.rb +2 -2
- data/lib/sentry/profiler.rb +17 -6
- data/lib/sentry/span.rb +1 -1
- data/lib/sentry/test_helper.rb +18 -12
- data/lib/sentry/transport.rb +4 -3
- data/lib/sentry/utils/argument_checking_helper.rb +6 -0
- data/lib/sentry/version.rb +1 -1
- data/lib/sentry-ruby.rb +20 -0
- metadata +6 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 857c6d99b1c5d9378a2522ffa1e466f91869500ae425f9d1add4aae399f1852c
|
|
4
|
+
data.tar.gz: 726793c0ae09ce3b137cdc7f48f6745c55176a83c8f651b8b493ee5d1290b522
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 13ccb78050835c829d738550bc9838347c71abc2139089c29ab466796059259740207d21504bee7cc6f4ca07dbcc982e12be05ebc0b955a4274a4a30bd0470ee
|
|
7
|
+
data.tar.gz: d6b4edd6c562b787b9fe652b6ba6ddb3bf16bca937bacbd22fcc44be746643a77e3595460263f72e3e76e73a7b92ff09577d7c665cfac2520886c3a62a62a2ab
|
data/Gemfile
CHANGED
|
@@ -21,9 +21,15 @@ gem "simplecov-cobertura", "~> 1.4"
|
|
|
21
21
|
gem "rexml"
|
|
22
22
|
gem "stackprof" unless RUBY_PLATFORM == "java"
|
|
23
23
|
|
|
24
|
-
|
|
24
|
+
ruby_version = Gem::Version.new(RUBY_VERSION)
|
|
25
|
+
|
|
26
|
+
if ruby_version >= Gem::Version.new("2.6.0")
|
|
25
27
|
gem "debug", github: "ruby/debug", platform: :ruby
|
|
26
28
|
gem "irb"
|
|
29
|
+
|
|
30
|
+
if ruby_version >= Gem::Version.new("3.0.0")
|
|
31
|
+
gem "ruby-lsp-rspec"
|
|
32
|
+
end
|
|
27
33
|
end
|
|
28
34
|
|
|
29
35
|
gem "pry"
|
data/README.md
CHANGED
|
@@ -13,14 +13,14 @@ _Bad software is everywhere, and we're tired of it. Sentry is on a mission to he
|
|
|
13
13
|
Sentry SDK for Ruby
|
|
14
14
|
===========
|
|
15
15
|
|
|
16
|
-
| current version
|
|
17
|
-
| ---
|
|
18
|
-
| [](https://rubygems.org/gems/sentry-ruby)
|
|
19
|
-
| [](https://rubygems.org/gems/sentry-rails)
|
|
20
|
-
| [](https://rubygems.org/gems/sentry-sidekiq)
|
|
21
|
-
| [](https://rubygems.org/gems/sentry-delayed_job)
|
|
22
|
-
| [](https://rubygems.org/gems/sentry-resque)
|
|
23
|
-
| [](https://rubygems.org/gems/sentry-opentelemetry) | [](https://rubygems.org/gems/sentry-ruby) | [](https://github.com/getsentry/sentry-ruby/actions/workflows/sentry_ruby_test.yml) | [](https://codecov.io/gh/getsentry/sentry-ruby/branch/master) | [](https://rubygems.org/gems/sentry-ruby/) |
|
|
19
|
+
| [](https://rubygems.org/gems/sentry-rails) | [](https://github.com/getsentry/sentry-ruby/actions/workflows/sentry_rails_test.yml) | [](https://codecov.io/gh/getsentry/sentry-ruby/branch/master) | [](https://rubygems.org/gems/sentry-rails/) |
|
|
20
|
+
| [](https://rubygems.org/gems/sentry-sidekiq) | [](https://github.com/getsentry/sentry-ruby/actions/workflows/sentry_sidekiq_test.yml) | [](https://codecov.io/gh/getsentry/sentry-ruby/branch/master) | [](https://rubygems.org/gems/sentry-sidekiq/) |
|
|
21
|
+
| [](https://rubygems.org/gems/sentry-delayed_job) | [](https://github.com/getsentry/sentry-ruby/actions/workflows/sentry_delayed_job_test.yml) | [](https://codecov.io/gh/getsentry/sentry-ruby/branch/master) | [](https://rubygems.org/gems/sentry-delayed_job/) |
|
|
22
|
+
| [](https://rubygems.org/gems/sentry-resque) | [](https://github.com/getsentry/sentry-ruby/actions/workflows/sentry_resque_test.yml) | [](https://codecov.io/gh/getsentry/sentry-ruby/branch/master) | [](https://rubygems.org/gems/sentry-resque/) |
|
|
23
|
+
| [](https://rubygems.org/gems/sentry-opentelemetry) | [](https://github.com/getsentry/sentry-ruby/actions/workflows/sentry_opentelemetry_test.yml) | [](https://codecov.io/gh/getsentry/sentry-ruby/branch/master) | [](https://rubygems.org/gems/sentry-opentelemetry/) |
|
|
24
24
|
|
|
25
25
|
|
|
26
26
|
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# frozen_string_literal
|
|
2
|
+
|
|
3
|
+
require 'securerandom'
|
|
4
|
+
require 'sentry/cron/monitor_config'
|
|
5
|
+
|
|
6
|
+
module Sentry
|
|
7
|
+
class CheckInEvent < Event
|
|
8
|
+
TYPE = 'check_in'
|
|
9
|
+
|
|
10
|
+
# uuid to identify this check-in.
|
|
11
|
+
# @return [String]
|
|
12
|
+
attr_accessor :check_in_id
|
|
13
|
+
|
|
14
|
+
# Identifier of the monitor for this check-in.
|
|
15
|
+
# @return [String]
|
|
16
|
+
attr_accessor :monitor_slug
|
|
17
|
+
|
|
18
|
+
# Duration of this check since it has started in seconds.
|
|
19
|
+
# @return [Integer, nil]
|
|
20
|
+
attr_accessor :duration
|
|
21
|
+
|
|
22
|
+
# Monitor configuration to support upserts.
|
|
23
|
+
# @return [Cron::MonitorConfig, nil]
|
|
24
|
+
attr_accessor :monitor_config
|
|
25
|
+
|
|
26
|
+
# Status of this check-in.
|
|
27
|
+
# @return [Symbol]
|
|
28
|
+
attr_accessor :status
|
|
29
|
+
|
|
30
|
+
VALID_STATUSES = %i(ok in_progress error)
|
|
31
|
+
|
|
32
|
+
def initialize(
|
|
33
|
+
slug:,
|
|
34
|
+
status:,
|
|
35
|
+
duration: nil,
|
|
36
|
+
monitor_config: nil,
|
|
37
|
+
check_in_id: nil,
|
|
38
|
+
**options
|
|
39
|
+
)
|
|
40
|
+
super(**options)
|
|
41
|
+
|
|
42
|
+
self.monitor_slug = slug
|
|
43
|
+
self.status = status
|
|
44
|
+
self.duration = duration
|
|
45
|
+
self.monitor_config = monitor_config
|
|
46
|
+
self.check_in_id = check_in_id || SecureRandom.uuid.delete('-')
|
|
47
|
+
end
|
|
48
|
+
|
|
49
|
+
# @return [Hash]
|
|
50
|
+
def to_hash
|
|
51
|
+
data = super
|
|
52
|
+
data[:check_in_id] = check_in_id
|
|
53
|
+
data[:monitor_slug] = monitor_slug
|
|
54
|
+
data[:status] = status
|
|
55
|
+
data[:duration] = duration if duration
|
|
56
|
+
data[:monitor_config] = monitor_config.to_hash if monitor_config
|
|
57
|
+
data
|
|
58
|
+
end
|
|
59
|
+
end
|
|
60
|
+
end
|
data/lib/sentry/client.rb
CHANGED
|
@@ -104,6 +104,37 @@ module Sentry
|
|
|
104
104
|
event
|
|
105
105
|
end
|
|
106
106
|
|
|
107
|
+
# Initializes a CheckInEvent object with the given options.
|
|
108
|
+
#
|
|
109
|
+
# @param slug [String] identifier of this monitor
|
|
110
|
+
# @param status [Symbol] status of this check-in, one of {CheckInEvent::VALID_STATUSES}
|
|
111
|
+
# @param hint [Hash] the hint data that'll be passed to `before_send` callback and the scope's event processors.
|
|
112
|
+
# @param duration [Integer, nil] seconds elapsed since this monitor started
|
|
113
|
+
# @param monitor_config [Cron::MonitorConfig, nil] configuration for this monitor
|
|
114
|
+
# @param check_in_id [String, nil] for updating the status of an existing monitor
|
|
115
|
+
#
|
|
116
|
+
# @return [Event]
|
|
117
|
+
def event_from_check_in(
|
|
118
|
+
slug,
|
|
119
|
+
status,
|
|
120
|
+
hint = {},
|
|
121
|
+
duration: nil,
|
|
122
|
+
monitor_config: nil,
|
|
123
|
+
check_in_id: nil
|
|
124
|
+
)
|
|
125
|
+
return unless configuration.sending_allowed?
|
|
126
|
+
|
|
127
|
+
CheckInEvent.new(
|
|
128
|
+
configuration: configuration,
|
|
129
|
+
integration_meta: Sentry.integrations[hint[:integration]],
|
|
130
|
+
slug: slug,
|
|
131
|
+
status: status,
|
|
132
|
+
duration: duration,
|
|
133
|
+
monitor_config: monitor_config,
|
|
134
|
+
check_in_id: check_in_id
|
|
135
|
+
)
|
|
136
|
+
end
|
|
137
|
+
|
|
107
138
|
# Initializes an Event object with the given Transaction object.
|
|
108
139
|
# @param transaction [Transaction] the transaction to be recorded.
|
|
109
140
|
# @return [TransactionEvent]
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
module Sentry
|
|
2
|
+
module Cron
|
|
3
|
+
module MonitorCheckIns
|
|
4
|
+
module Patch
|
|
5
|
+
def perform(*args)
|
|
6
|
+
slug = self.class.sentry_monitor_slug || self.class.name
|
|
7
|
+
monitor_config = self.class.sentry_monitor_config
|
|
8
|
+
|
|
9
|
+
check_in_id = Sentry.capture_check_in(slug,
|
|
10
|
+
:in_progress,
|
|
11
|
+
monitor_config: monitor_config)
|
|
12
|
+
|
|
13
|
+
start = Sentry.utc_now.to_i
|
|
14
|
+
ret = super
|
|
15
|
+
duration = Sentry.utc_now.to_i - start
|
|
16
|
+
|
|
17
|
+
Sentry.capture_check_in(slug,
|
|
18
|
+
:ok,
|
|
19
|
+
check_in_id: check_in_id,
|
|
20
|
+
duration: duration,
|
|
21
|
+
monitor_config: monitor_config)
|
|
22
|
+
|
|
23
|
+
ret
|
|
24
|
+
rescue Exception
|
|
25
|
+
duration = Sentry.utc_now.to_i - start
|
|
26
|
+
|
|
27
|
+
Sentry.capture_check_in(slug,
|
|
28
|
+
:error,
|
|
29
|
+
check_in_id: check_in_id,
|
|
30
|
+
duration: duration,
|
|
31
|
+
monitor_config: monitor_config)
|
|
32
|
+
|
|
33
|
+
raise
|
|
34
|
+
end
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
module ClassMethods
|
|
38
|
+
def sentry_monitor_check_ins(slug: nil, monitor_config: nil)
|
|
39
|
+
@sentry_monitor_slug = slug
|
|
40
|
+
@sentry_monitor_config = monitor_config
|
|
41
|
+
|
|
42
|
+
prepend Patch
|
|
43
|
+
end
|
|
44
|
+
|
|
45
|
+
def sentry_monitor_slug
|
|
46
|
+
@sentry_monitor_slug
|
|
47
|
+
end
|
|
48
|
+
|
|
49
|
+
def sentry_monitor_config
|
|
50
|
+
@sentry_monitor_config
|
|
51
|
+
end
|
|
52
|
+
end
|
|
53
|
+
|
|
54
|
+
extend ClassMethods
|
|
55
|
+
|
|
56
|
+
def self.included(base)
|
|
57
|
+
base.extend(ClassMethods)
|
|
58
|
+
end
|
|
59
|
+
end
|
|
60
|
+
end
|
|
61
|
+
end
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
# frozen_string_literal
|
|
2
|
+
|
|
3
|
+
require 'sentry/cron/monitor_schedule'
|
|
4
|
+
|
|
5
|
+
module Sentry
|
|
6
|
+
module Cron
|
|
7
|
+
class MonitorConfig
|
|
8
|
+
# The monitor schedule configuration
|
|
9
|
+
# @return [MonitorSchedule::Crontab, MonitorSchedule::Interval]
|
|
10
|
+
attr_accessor :schedule
|
|
11
|
+
|
|
12
|
+
# How long (in minutes) after the expected checkin time will we wait
|
|
13
|
+
# until we consider the checkin to have been missed.
|
|
14
|
+
# @return [Integer, nil]
|
|
15
|
+
attr_accessor :checkin_margin
|
|
16
|
+
|
|
17
|
+
# How long (in minutes) is the checkin allowed to run for in in_progress
|
|
18
|
+
# before it is considered failed.
|
|
19
|
+
# @return [Integer, nil]
|
|
20
|
+
attr_accessor :max_runtime
|
|
21
|
+
|
|
22
|
+
# tz database style timezone string
|
|
23
|
+
# @return [String, nil]
|
|
24
|
+
attr_accessor :timezone
|
|
25
|
+
|
|
26
|
+
def initialize(schedule, checkin_margin: nil, max_runtime: nil, timezone: nil)
|
|
27
|
+
@schedule = schedule
|
|
28
|
+
@checkin_margin = checkin_margin
|
|
29
|
+
@max_runtime = max_runtime
|
|
30
|
+
@timezone = timezone
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
def self.from_crontab(crontab, **options)
|
|
34
|
+
new(MonitorSchedule::Crontab.new(crontab), **options)
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
def self.from_interval(num, unit, **options)
|
|
38
|
+
return nil unless MonitorSchedule::Interval::VALID_UNITS.include?(unit)
|
|
39
|
+
|
|
40
|
+
new(MonitorSchedule::Interval.new(num, unit), **options)
|
|
41
|
+
end
|
|
42
|
+
|
|
43
|
+
def to_hash
|
|
44
|
+
{
|
|
45
|
+
schedule: schedule.to_hash,
|
|
46
|
+
checkin_margin: checkin_margin,
|
|
47
|
+
max_runtime: max_runtime,
|
|
48
|
+
timezone: timezone
|
|
49
|
+
}.compact
|
|
50
|
+
end
|
|
51
|
+
end
|
|
52
|
+
end
|
|
53
|
+
end
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# frozen_string_literal
|
|
2
|
+
|
|
3
|
+
module Sentry
|
|
4
|
+
module Cron
|
|
5
|
+
module MonitorSchedule
|
|
6
|
+
class Crontab
|
|
7
|
+
# A crontab formatted string such as "0 * * * *".
|
|
8
|
+
# @return [String]
|
|
9
|
+
attr_accessor :value
|
|
10
|
+
|
|
11
|
+
def initialize(value)
|
|
12
|
+
@value = value
|
|
13
|
+
end
|
|
14
|
+
|
|
15
|
+
def to_hash
|
|
16
|
+
{ type: :crontab, value: value }
|
|
17
|
+
end
|
|
18
|
+
end
|
|
19
|
+
|
|
20
|
+
class Interval
|
|
21
|
+
# The number representing duration of the interval.
|
|
22
|
+
# @return [Integer]
|
|
23
|
+
attr_accessor :value
|
|
24
|
+
|
|
25
|
+
# The unit representing duration of the interval.
|
|
26
|
+
# @return [Symbol]
|
|
27
|
+
attr_accessor :unit
|
|
28
|
+
|
|
29
|
+
VALID_UNITS = %i(year month week day hour minute)
|
|
30
|
+
|
|
31
|
+
def initialize(value, unit)
|
|
32
|
+
@value = value
|
|
33
|
+
@unit = unit
|
|
34
|
+
end
|
|
35
|
+
|
|
36
|
+
def to_hash
|
|
37
|
+
{ type: :interval, value: value, unit: unit }
|
|
38
|
+
end
|
|
39
|
+
end
|
|
40
|
+
end
|
|
41
|
+
end
|
|
42
|
+
end
|
data/lib/sentry/envelope.rb
CHANGED
data/lib/sentry/hub.rb
CHANGED
|
@@ -156,6 +156,30 @@ module Sentry
|
|
|
156
156
|
capture_event(event, **options, &block)
|
|
157
157
|
end
|
|
158
158
|
|
|
159
|
+
def capture_check_in(slug, status, **options, &block)
|
|
160
|
+
check_argument_type!(slug, ::String)
|
|
161
|
+
check_argument_includes!(status, Sentry::CheckInEvent::VALID_STATUSES)
|
|
162
|
+
|
|
163
|
+
return unless current_client
|
|
164
|
+
|
|
165
|
+
options[:hint] ||= {}
|
|
166
|
+
options[:hint][:slug] = slug
|
|
167
|
+
|
|
168
|
+
event = current_client.event_from_check_in(
|
|
169
|
+
slug,
|
|
170
|
+
status,
|
|
171
|
+
options[:hint],
|
|
172
|
+
duration: options.delete(:duration),
|
|
173
|
+
monitor_config: options.delete(:monitor_config),
|
|
174
|
+
check_in_id: options.delete(:check_in_id)
|
|
175
|
+
)
|
|
176
|
+
|
|
177
|
+
return unless event
|
|
178
|
+
|
|
179
|
+
capture_event(event, **options, &block)
|
|
180
|
+
event.check_in_id
|
|
181
|
+
end
|
|
182
|
+
|
|
159
183
|
def capture_event(event, **options, &block)
|
|
160
184
|
check_argument_type!(event, Sentry::Event)
|
|
161
185
|
|
|
@@ -178,7 +202,7 @@ module Sentry
|
|
|
178
202
|
configuration.log_debug(event.to_json_compatible)
|
|
179
203
|
end
|
|
180
204
|
|
|
181
|
-
@last_event_id = event&.event_id
|
|
205
|
+
@last_event_id = event&.event_id if event.is_a?(Sentry::ErrorEvent)
|
|
182
206
|
event
|
|
183
207
|
end
|
|
184
208
|
|
data/lib/sentry/integrable.rb
CHANGED
|
@@ -22,5 +22,11 @@ module Sentry
|
|
|
22
22
|
options[:hint][:integration] = integration_name
|
|
23
23
|
Sentry.capture_message(message, **options, &block)
|
|
24
24
|
end
|
|
25
|
+
|
|
26
|
+
def capture_check_in(slug, status, **options, &block)
|
|
27
|
+
options[:hint] ||= {}
|
|
28
|
+
options[:hint][:integration] = integration_name
|
|
29
|
+
Sentry.capture_check_in(slug, status, **options, &block)
|
|
30
|
+
end
|
|
25
31
|
end
|
|
26
32
|
end
|
|
@@ -23,7 +23,7 @@ module Sentry
|
|
|
23
23
|
exception.message || ""
|
|
24
24
|
end
|
|
25
25
|
|
|
26
|
-
@value = exception_message.byteslice(0..Event::MAX_MESSAGE_SIZE_IN_BYTES)
|
|
26
|
+
@value = Utils::EncodingHelper.encode_to_utf_8(exception_message.byteslice(0..Event::MAX_MESSAGE_SIZE_IN_BYTES))
|
|
27
27
|
|
|
28
28
|
@module = exception.class.to_s.split('::')[0...-1].join('::')
|
|
29
29
|
@thread_id = Thread.current.object_id
|
|
@@ -51,7 +51,7 @@ module Sentry
|
|
|
51
51
|
v = v.byteslice(0..MAX_LOCAL_BYTES - 1) + OMISSION_MARK
|
|
52
52
|
end
|
|
53
53
|
|
|
54
|
-
v
|
|
54
|
+
Utils::EncodingHelper.encode_to_utf_8(v)
|
|
55
55
|
rescue StandardError
|
|
56
56
|
PROBLEMATIC_LOCAL_VALUE_REPLACEMENT
|
|
57
57
|
end
|
data/lib/sentry/profiler.rb
CHANGED
|
@@ -9,6 +9,7 @@ module Sentry
|
|
|
9
9
|
# 101 Hz in microseconds
|
|
10
10
|
DEFAULT_INTERVAL = 1e6 / 101
|
|
11
11
|
MICRO_TO_NANO_SECONDS = 1e3
|
|
12
|
+
MIN_SAMPLES_REQUIRED = 2
|
|
12
13
|
|
|
13
14
|
attr_reader :sampled, :started, :event_id
|
|
14
15
|
|
|
@@ -73,14 +74,19 @@ module Sentry
|
|
|
73
74
|
end
|
|
74
75
|
|
|
75
76
|
def to_hash
|
|
76
|
-
|
|
77
|
+
unless @sampled
|
|
78
|
+
record_lost_event(:sample_rate)
|
|
79
|
+
return {}
|
|
80
|
+
end
|
|
81
|
+
|
|
77
82
|
return {} unless @started
|
|
78
83
|
|
|
79
84
|
results = StackProf.results
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
85
|
+
|
|
86
|
+
if !results || results.empty? || results[:samples] == 0 || !results[:raw]
|
|
87
|
+
record_lost_event(:insufficient_data)
|
|
88
|
+
return {}
|
|
89
|
+
end
|
|
84
90
|
|
|
85
91
|
frame_map = {}
|
|
86
92
|
|
|
@@ -157,8 +163,9 @@ module Sentry
|
|
|
157
163
|
|
|
158
164
|
log('Some samples thrown away') if samples.size != results[:samples]
|
|
159
165
|
|
|
160
|
-
if samples.size <=
|
|
166
|
+
if samples.size <= MIN_SAMPLES_REQUIRED
|
|
161
167
|
log('Not enough samples, discarding profiler')
|
|
168
|
+
record_lost_event(:insufficient_data)
|
|
162
169
|
return {}
|
|
163
170
|
end
|
|
164
171
|
|
|
@@ -218,5 +225,9 @@ module Sentry
|
|
|
218
225
|
|
|
219
226
|
[function, mod]
|
|
220
227
|
end
|
|
228
|
+
|
|
229
|
+
def record_lost_event(reason)
|
|
230
|
+
Sentry.get_current_client&.transport&.record_lost_event(reason, 'profile')
|
|
231
|
+
end
|
|
221
232
|
end
|
|
222
233
|
end
|
data/lib/sentry/span.rb
CHANGED
|
@@ -11,7 +11,7 @@ module Sentry
|
|
|
11
11
|
URL = "url"
|
|
12
12
|
HTTP_STATUS_CODE = "http.response.status_code"
|
|
13
13
|
HTTP_QUERY = "http.query"
|
|
14
|
-
HTTP_METHOD = "http.method"
|
|
14
|
+
HTTP_METHOD = "http.request.method"
|
|
15
15
|
|
|
16
16
|
# An identifier for the database management system (DBMS) product being used.
|
|
17
17
|
# Example: postgresql
|
data/lib/sentry/test_helper.rb
CHANGED
|
@@ -14,24 +14,28 @@ module Sentry
|
|
|
14
14
|
# @return [void]
|
|
15
15
|
def setup_sentry_test(&block)
|
|
16
16
|
raise "please make sure the SDK is initialized for testing" unless Sentry.initialized?
|
|
17
|
-
|
|
17
|
+
dummy_config = Sentry.configuration.dup
|
|
18
18
|
# configure dummy DSN, so the events will not be sent to the actual service
|
|
19
|
-
|
|
19
|
+
dummy_config.dsn = DUMMY_DSN
|
|
20
20
|
# set transport to DummyTransport, so we can easily intercept the captured events
|
|
21
|
-
|
|
21
|
+
dummy_config.transport.transport_class = Sentry::DummyTransport
|
|
22
22
|
# make sure SDK allows sending under the current environment
|
|
23
|
-
|
|
23
|
+
dummy_config.enabled_environments << dummy_config.environment unless dummy_config.enabled_environments.include?(dummy_config.environment)
|
|
24
24
|
# disble async event sending
|
|
25
|
-
|
|
25
|
+
dummy_config.background_worker_threads = 0
|
|
26
26
|
|
|
27
27
|
# user can overwrite some of the configs, with a few exceptions like:
|
|
28
28
|
# - include_local_variables
|
|
29
29
|
# - auto_session_tracking
|
|
30
|
-
block&.call(
|
|
30
|
+
block&.call(dummy_config)
|
|
31
31
|
|
|
32
|
-
|
|
32
|
+
# the base layer's client should already use the dummy config so nothing will be sent by accident
|
|
33
|
+
base_client = Sentry::Client.new(dummy_config)
|
|
34
|
+
Sentry.get_current_hub.bind_client(base_client)
|
|
35
|
+
# create a new layer so mutations made to the testing scope or configuration could be simply popped later
|
|
36
|
+
Sentry.get_current_hub.push_scope
|
|
37
|
+
test_client = Sentry::Client.new(dummy_config.dup)
|
|
33
38
|
Sentry.get_current_hub.bind_client(test_client)
|
|
34
|
-
Sentry.get_current_scope.clear
|
|
35
39
|
end
|
|
36
40
|
|
|
37
41
|
# Clears all stored events and envelopes.
|
|
@@ -40,9 +44,12 @@ module Sentry
|
|
|
40
44
|
def teardown_sentry_test
|
|
41
45
|
return unless Sentry.initialized?
|
|
42
46
|
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
47
|
+
# pop testing layer created by `setup_sentry_test`
|
|
48
|
+
# but keep the base layer to avoid nil-pointer errors
|
|
49
|
+
# TODO: find a way to notify users if they somehow popped the test layer before calling this method
|
|
50
|
+
if Sentry.get_current_hub.instance_variable_get(:@stack).size > 1
|
|
51
|
+
Sentry.get_current_hub.pop_scope
|
|
52
|
+
end
|
|
46
53
|
end
|
|
47
54
|
|
|
48
55
|
# @return [Transport]
|
|
@@ -75,4 +82,3 @@ module Sentry
|
|
|
75
82
|
end
|
|
76
83
|
end
|
|
77
84
|
end
|
|
78
|
-
|
data/lib/sentry/transport.rb
CHANGED
|
@@ -18,7 +18,8 @@ module Sentry
|
|
|
18
18
|
:network_error,
|
|
19
19
|
:sample_rate,
|
|
20
20
|
:before_send,
|
|
21
|
-
:event_processor
|
|
21
|
+
:event_processor,
|
|
22
|
+
:insufficient_data
|
|
22
23
|
]
|
|
23
24
|
|
|
24
25
|
include LoggingHelper
|
|
@@ -143,7 +144,7 @@ module Sentry
|
|
|
143
144
|
sent_at: Sentry.utc_now.iso8601
|
|
144
145
|
}
|
|
145
146
|
|
|
146
|
-
if event.is_a?(
|
|
147
|
+
if event.is_a?(Event) && event.dynamic_sampling_context
|
|
147
148
|
envelope_headers[:trace] = event.dynamic_sampling_context
|
|
148
149
|
end
|
|
149
150
|
|
|
@@ -185,7 +186,7 @@ module Sentry
|
|
|
185
186
|
reason, type = key
|
|
186
187
|
|
|
187
188
|
# 'event' has to be mapped to 'error'
|
|
188
|
-
category = type == '
|
|
189
|
+
category = type == 'event' ? 'error' : type
|
|
189
190
|
|
|
190
191
|
{ reason: reason, category: category, quantity: val }
|
|
191
192
|
end
|
|
@@ -9,5 +9,11 @@ module Sentry
|
|
|
9
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
|
+
|
|
13
|
+
def check_argument_includes!(argument, values)
|
|
14
|
+
unless values.include?(argument)
|
|
15
|
+
raise ArgumentError, "expect the argument to be one of #{values.map(&:inspect).join(' or ')}, got #{argument.inspect}"
|
|
16
|
+
end
|
|
17
|
+
end
|
|
12
18
|
end
|
|
13
19
|
end
|
data/lib/sentry/version.rb
CHANGED
data/lib/sentry-ruby.rb
CHANGED
|
@@ -15,11 +15,13 @@ require "sentry/logger"
|
|
|
15
15
|
require "sentry/event"
|
|
16
16
|
require "sentry/error_event"
|
|
17
17
|
require "sentry/transaction_event"
|
|
18
|
+
require "sentry/check_in_event"
|
|
18
19
|
require "sentry/span"
|
|
19
20
|
require "sentry/transaction"
|
|
20
21
|
require "sentry/hub"
|
|
21
22
|
require "sentry/background_worker"
|
|
22
23
|
require "sentry/session_flusher"
|
|
24
|
+
require "sentry/cron/monitor_check_ins"
|
|
23
25
|
|
|
24
26
|
[
|
|
25
27
|
"sentry/rake",
|
|
@@ -430,6 +432,24 @@ module Sentry
|
|
|
430
432
|
get_current_hub.capture_event(event)
|
|
431
433
|
end
|
|
432
434
|
|
|
435
|
+
# Captures a check-in and sends it to Sentry via the currently active hub.
|
|
436
|
+
#
|
|
437
|
+
# @param slug [String] identifier of this monitor
|
|
438
|
+
# @param status [Symbol] status of this check-in, one of {CheckInEvent::VALID_STATUSES}
|
|
439
|
+
#
|
|
440
|
+
# @param [Hash] options extra check-in options
|
|
441
|
+
# @option options [String] check_in_id for updating the status of an existing monitor
|
|
442
|
+
# @option options [Integer] duration seconds elapsed since this monitor started
|
|
443
|
+
# @option options [Cron::MonitorConfig] monitor_config configuration for this monitor
|
|
444
|
+
#
|
|
445
|
+
# @yieldparam scope [Scope]
|
|
446
|
+
#
|
|
447
|
+
# @return [String, nil] The {CheckInEvent#check_in_id} to use for later updates on the same slug
|
|
448
|
+
def capture_check_in(slug, status, **options, &block)
|
|
449
|
+
return unless initialized?
|
|
450
|
+
get_current_hub.capture_check_in(slug, status, **options, &block)
|
|
451
|
+
end
|
|
452
|
+
|
|
433
453
|
# Takes or initializes a new Sentry::Transaction and makes a sampling decision for it.
|
|
434
454
|
#
|
|
435
455
|
# @return [Transaction, nil]
|
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.12.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-10-10 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: concurrent-ruby
|
|
@@ -56,10 +56,14 @@ files:
|
|
|
56
56
|
- lib/sentry/breadcrumb.rb
|
|
57
57
|
- lib/sentry/breadcrumb/sentry_logger.rb
|
|
58
58
|
- lib/sentry/breadcrumb_buffer.rb
|
|
59
|
+
- lib/sentry/check_in_event.rb
|
|
59
60
|
- lib/sentry/client.rb
|
|
60
61
|
- lib/sentry/configuration.rb
|
|
61
62
|
- lib/sentry/core_ext/object/deep_dup.rb
|
|
62
63
|
- lib/sentry/core_ext/object/duplicable.rb
|
|
64
|
+
- lib/sentry/cron/monitor_check_ins.rb
|
|
65
|
+
- lib/sentry/cron/monitor_config.rb
|
|
66
|
+
- lib/sentry/cron/monitor_schedule.rb
|
|
63
67
|
- lib/sentry/dsn.rb
|
|
64
68
|
- lib/sentry/envelope.rb
|
|
65
69
|
- lib/sentry/error_event.rb
|