sentry-ruby-core 4.5.2 → 4.6.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +26 -174
- data/lib/sentry/dsn.rb +0 -1
- data/lib/sentry/hub.rb +11 -0
- data/lib/sentry/interfaces/request.rb +1 -0
- data/lib/sentry/rake.rb +13 -0
- data/lib/sentry/utils/real_ip.rb +7 -1
- data/lib/sentry/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 4d739cc418695f66cb3ff2d84276138d9ede10a4c56c5bb18f7b5e64d95f591b
|
|
4
|
+
data.tar.gz: bd81bdb989613b8a0a401f63a592723a5760bf3a96ec20698b69c3aca002120f
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: b28d8c9ab0c76944dfdaf68298077ebedaffa054a2119b8490c4161090d2eef0981fcb8ee1494d68833539d98635b1baec11613ac7f5c8b8fce0bd7268d8c698
|
|
7
|
+
data.tar.gz: 75bbf542edf0d15e1f55684d90566deab151114b6750ad59b9eb224ad998449817987b4d255125fc3316dc99dfb0670ae39783a28df6e539e4e3b3c7c862d65a
|
data/README.md
CHANGED
|
@@ -12,10 +12,11 @@ Sentry SDK for Ruby
|
|
|
12
12
|
|
|
13
13
|
| current version | build | coverage | downloads | semver stability |
|
|
14
14
|
| --- | ----- | -------- | --------- | ---------------- |
|
|
15
|
-
| [](https://
|
|
16
|
-
| [](https://
|
|
17
|
-
| [](https://
|
|
18
|
-
| [](https://
|
|
15
|
+
| [](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/) | [](https://dependabot.com/compatibility-score.html?dependency-name=sentry-ruby&package-manager=bundler&version-scheme=semver) |
|
|
16
|
+
| [](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/) | [](https://dependabot.com/compatibility-score.html?dependency-name=sentry-rails&package-manager=bundler&version-scheme=semver) |
|
|
17
|
+
| [](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/) | [](https://dependabot.com/compatibility-score.html?dependency-name=sentry-sidekiq&package-manager=bundler&version-scheme=semver) |
|
|
18
|
+
| [](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/) | [](https://dependabot.com/compatibility-score.html?dependency-name=sentry-delayed_job&package-manager=bundler&version-scheme=semver) |
|
|
19
|
+
| [](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/) | [](https://dependabot.com/compatibility-score.html?dependency-name=sentry-resque&package-manager=bundler&version-scheme=semver) |
|
|
19
20
|
|
|
20
21
|
|
|
21
22
|
|
|
@@ -46,200 +47,51 @@ and depends on the integrations you want to have, you might also want to install
|
|
|
46
47
|
gem "sentry-rails"
|
|
47
48
|
gem "sentry-sidekiq"
|
|
48
49
|
gem "sentry-delayed_job"
|
|
49
|
-
|
|
50
|
+
gem "sentry-resque"
|
|
50
51
|
```
|
|
51
52
|
|
|
52
|
-
###
|
|
53
|
+
### Configuration
|
|
53
54
|
|
|
54
|
-
|
|
55
|
+
You can use `Sentry.init` to initialize and configure your SDK:
|
|
55
56
|
|
|
56
|
-
```bash
|
|
57
|
-
# Set your SENTRY_DSN environment variable.
|
|
58
|
-
export SENTRY_DSN=http://public@example.com/project-id
|
|
59
|
-
```
|
|
60
57
|
```ruby
|
|
61
|
-
# Or you can configure the client in the code.
|
|
62
58
|
Sentry.init do |config|
|
|
63
|
-
config.dsn =
|
|
59
|
+
config.dsn = "MY_DSN"
|
|
64
60
|
end
|
|
65
|
-
```
|
|
66
|
-
|
|
67
|
-
### Sentry doesn't report some kinds of data by default
|
|
68
61
|
|
|
69
|
-
**Sentry ignores some exceptions by default** - most of these are related to 404s parameter parsing errors. [For a complete list, see the `IGNORE_DEFAULT` constant](https://github.com/getsentry/sentry-ruby/blob/master/sentry-ruby/lib/sentry/configuration.rb#L151) and the integration gems' `IGNORE_DEFAULT`, like [`sentry-rails`'s](https://github.com/getsentry/sentry-ruby/blob/master/sentry-rails/lib/sentry/rails/configuration.rb#L12)
|
|
70
|
-
|
|
71
|
-
Sentry doesn't send personally identifiable information (pii) by default, such as request body, user ip or cookies. If you want those information to be sent, you can use the `send_default_pii` config option:
|
|
72
|
-
|
|
73
|
-
```ruby
|
|
74
|
-
Sentry.init do |config|
|
|
75
|
-
# other configs
|
|
76
|
-
config.send_default_pii = true
|
|
77
|
-
end
|
|
78
62
|
```
|
|
79
63
|
|
|
64
|
+
To learn more about available configuration options, please visit the [official documentation](https://docs.sentry.io/platforms/ruby/configuration/options/).
|
|
65
|
+
|
|
80
66
|
### Performance Monitoring
|
|
81
67
|
|
|
82
|
-
You can activate performance monitoring by enabling traces sampling:
|
|
68
|
+
You can activate [performance monitoring](https://docs.sentry.io/platforms/ruby/performance) by enabling traces sampling:
|
|
83
69
|
|
|
84
70
|
```ruby
|
|
85
71
|
Sentry.init do |config|
|
|
86
72
|
# set a uniform sample rate between 0.0 and 1.0
|
|
87
73
|
config.traces_sample_rate = 0.2
|
|
88
|
-
|
|
89
|
-
#
|
|
90
|
-
config.traces_sampler = lambda do |sampling_context|
|
|
91
|
-
# sampling_context[:transaction_context] contains the information about the transaction
|
|
92
|
-
# sampling_context[:parent_sampled] contains the transaction's parent's sample decision
|
|
93
|
-
true # return value can be a boolean or a float between 0.0 and 1.0
|
|
94
|
-
end
|
|
74
|
+
# you can also use traces_sampler for more fine-grained sampling
|
|
75
|
+
# please click the link below to learn more
|
|
95
76
|
end
|
|
96
77
|
```
|
|
97
78
|
|
|
98
|
-
To learn more about
|
|
79
|
+
To learn more about sampling transactions, please visit the [official documentation](https://docs.sentry.io/platforms/ruby/configuration/sampling/#configuring-the-transaction-sample-rate).
|
|
99
80
|
|
|
100
|
-
###
|
|
81
|
+
### Integrations
|
|
101
82
|
|
|
102
|
-
|
|
83
|
+
- [Rack](https://docs.sentry.io/platforms/ruby/guides/rack/)
|
|
84
|
+
- [Rails](https://docs.sentry.io/platforms/ruby/guides/rails/)
|
|
85
|
+
- [Sidekiq](https://docs.sentry.io/platforms/ruby/guides/sidekiq/)
|
|
86
|
+
- [DelayedJob](https://docs.sentry.io/platforms/ruby/guides/delayed_job/)
|
|
87
|
+
- [Resque](https://docs.sentry.io/platforms/ruby/guides/resque/)
|
|
103
88
|
|
|
104
|
-
|
|
105
|
-
require 'sentry-ruby'
|
|
106
|
-
|
|
107
|
-
Sentry.init do |config|
|
|
108
|
-
config.dsn = 'https://examplePublicKey@o0.ingest.sentry.io/0'
|
|
109
|
-
|
|
110
|
-
# To activate performance monitoring, set one of these options.
|
|
111
|
-
# We recommend adjusting the value in production:
|
|
112
|
-
config.traces_sample_rate = 0.5
|
|
113
|
-
# or
|
|
114
|
-
config.traces_sampler = lambda do |context|
|
|
115
|
-
true
|
|
116
|
-
end
|
|
117
|
-
end
|
|
118
|
-
|
|
119
|
-
use Sentry::Rack::CaptureExceptions
|
|
120
|
-
```
|
|
121
|
-
|
|
122
|
-
Otherwise, Sentry you can always use the capture helpers manually
|
|
123
|
-
|
|
124
|
-
```ruby
|
|
125
|
-
Sentry.capture_message("hello world!")
|
|
126
|
-
|
|
127
|
-
begin
|
|
128
|
-
1 / 0
|
|
129
|
-
rescue ZeroDivisionError => exception
|
|
130
|
-
Sentry.capture_exception(exception)
|
|
131
|
-
end
|
|
132
|
-
```
|
|
133
|
-
|
|
134
|
-
We also provide integrations with popular frameworks/libraries with the related extensions:
|
|
135
|
-
|
|
136
|
-
- [sentry-rails](https://github.com/getsentry/sentry-ruby/tree/master/sentry-rails)
|
|
137
|
-
- [sentry-sidekiq](https://github.com/getsentry/sentry-ruby/tree/master/sentry-sidekiq)
|
|
138
|
-
- [sentry-delayed_job](https://github.com/getsentry/sentry-ruby/tree/master/sentry-delayed_job)
|
|
139
|
-
|
|
140
|
-
### More configuration
|
|
141
|
-
|
|
142
|
-
You're all set - but there's a few more settings you may want to know about too!
|
|
143
|
-
|
|
144
|
-
#### Blocking v.s. Non-blocking
|
|
145
|
-
|
|
146
|
-
`sentry-ruby` sends events asynchronously by default. The functionality works like this:
|
|
147
|
-
|
|
148
|
-
1. When the SDK is initialized, a `Sentry::BackgroundWorker` will be initialized too.
|
|
149
|
-
2. When an event is passed to `Client#capture_event`, instead of sending it directly with `Client#send_event`, we'll let the worker do it.
|
|
150
|
-
3. The worker will have a number of threads. And the one of the idle threads will pick the job and call `Client#send_event`.
|
|
151
|
-
- If all the threads are busy, new jobs will be put into a queue, which has a limit of 30.
|
|
152
|
-
- If the queue size is exceeded, new events will be dropped.
|
|
153
|
-
|
|
154
|
-
However, if you still prefer to use your own async approach, that's totally fine. If you have `config.async` set, the worker won't initialize a thread pool and won't be used either.
|
|
155
|
-
|
|
156
|
-
##### About `Sentry::BackgroundWorker`
|
|
157
|
-
|
|
158
|
-
- The worker is built on top of the [concurrent-ruby](https://github.com/ruby-concurrency/concurrent-ruby) gem's [ThreadPoolExecutor](http://ruby-concurrency.github.io/concurrent-ruby/master/Concurrent/ThreadPoolExecutor.html), which is also used by Rails ActiveJob's async adapter. This should minimize the risk of messing up client applications with our own thread pool implementaion.
|
|
159
|
-
|
|
160
|
-
This functionality also introduces a new `background_worker_threads` config option. It allows you to decide how many threads should the worker hold. By default, the value will be the number of the processors your machine has. For example, if your machine has 4 processors, the value would be 4.
|
|
161
|
-
|
|
162
|
-
Of course, you can always override the value to fit your use cases, like
|
|
163
|
-
|
|
164
|
-
```ruby
|
|
165
|
-
config.background_worker_threads = 5 # the worker will have 5 threads for sending events
|
|
166
|
-
```
|
|
167
|
-
|
|
168
|
-
You can also disable this new non-blocking behaviour by giving a `0` value:
|
|
169
|
-
|
|
170
|
-
```ruby
|
|
171
|
-
config.background_worker_threads = 0 # all events will be sent synchronously
|
|
172
|
-
```
|
|
89
|
+
### Enriching Events
|
|
173
90
|
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
```
|
|
179
|
-
|
|
180
|
-
##### `config.async`
|
|
181
|
-
|
|
182
|
-
You can also use `config.async` to send events with you own worker:
|
|
183
|
-
|
|
184
|
-
```ruby
|
|
185
|
-
config.async = lambda { |event, hint| SentryJob.perform_later(event, hint) }
|
|
186
|
-
```
|
|
187
|
-
|
|
188
|
-
And if you use `sentry-rails`, you can directly use the job we defined for you:
|
|
189
|
-
|
|
190
|
-
```ruby
|
|
191
|
-
config.async = lambda { |event, hint| Sentry::SendEventJob.perform_later(event, hint) }
|
|
192
|
-
```
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
#### Contexts
|
|
196
|
-
|
|
197
|
-
In sentry-ruby, every event will inherit their contextual data from the current scope. So you can enrich the event's data by configuring the current scope like:
|
|
198
|
-
|
|
199
|
-
```ruby
|
|
200
|
-
Sentry.configure_scope do |scope|
|
|
201
|
-
scope.set_user(id: 1, email: "test@example.com")
|
|
202
|
-
|
|
203
|
-
scope.set_tag(:tag, "foo")
|
|
204
|
-
scope.set_tags(tag_1: "foo", tag_2: "bar")
|
|
205
|
-
|
|
206
|
-
scope.set_extra(:order_number, 1234)
|
|
207
|
-
scope.set_extras(order_number: 1234, tickets_count: 4)
|
|
208
|
-
end
|
|
209
|
-
|
|
210
|
-
Sentry.capture_exception(exception) # the event will carry all those information now
|
|
211
|
-
```
|
|
212
|
-
|
|
213
|
-
Or use top-level setters
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
```ruby
|
|
217
|
-
Sentry.set_user(id: 1, email: "test@example.com")
|
|
218
|
-
Sentry.set_tags(tag_1: "foo", tag_2: "bar")
|
|
219
|
-
Sentry.set_extras(order_number: 1234, tickets_count: 4)
|
|
220
|
-
```
|
|
221
|
-
|
|
222
|
-
Or build up a temporary scope for local information:
|
|
223
|
-
|
|
224
|
-
```ruby
|
|
225
|
-
Sentry.configure_scope do |scope|
|
|
226
|
-
scope.set_tags(tag_1: "foo")
|
|
227
|
-
end
|
|
228
|
-
|
|
229
|
-
Sentry.with_scope do |scope|
|
|
230
|
-
scope.set_tags(tag_1: "bar", tag_2: "baz")
|
|
231
|
-
|
|
232
|
-
Sentry.capture_message("message") # this event will have 2 tags: tag_1 => "bar" and tag_2 => "baz"
|
|
233
|
-
end
|
|
234
|
-
|
|
235
|
-
Sentry.capture_message("another message") # this event will have 1 tag: tag_1 => "foo"
|
|
236
|
-
```
|
|
237
|
-
|
|
238
|
-
Of course, you can always assign the information on a per-event basis:
|
|
239
|
-
|
|
240
|
-
```ruby
|
|
241
|
-
Sentry.capture_exception(exception, tags: {foo: "bar"})
|
|
242
|
-
```
|
|
91
|
+
- [Add more data to the current scope](https://docs.sentry.io/platforms/ruby/guides/rack/enriching-events/scopes/)
|
|
92
|
+
- [Add custom breadcrumbs](https://docs.sentry.io/platforms/ruby/guides/rack/enriching-events/breadcrumbs/)
|
|
93
|
+
- [Add contextual data](https://docs.sentry.io/platforms/ruby/guides/rack/enriching-events/context/)
|
|
94
|
+
- [Add tags](https://docs.sentry.io/platforms/ruby/guides/rack/enriching-events/tags/)
|
|
243
95
|
|
|
244
96
|
## Resources
|
|
245
97
|
|
data/lib/sentry/dsn.rb
CHANGED
data/lib/sentry/hub.rb
CHANGED
|
@@ -144,6 +144,17 @@ module Sentry
|
|
|
144
144
|
current_scope.add_breadcrumb(breadcrumb)
|
|
145
145
|
end
|
|
146
146
|
|
|
147
|
+
# this doesn't do anything to the already initialized background worker
|
|
148
|
+
# but it temporarily disables dispatching events to it
|
|
149
|
+
def with_background_worker_disabled(&block)
|
|
150
|
+
original_background_worker_threads = configuration.background_worker_threads
|
|
151
|
+
configuration.background_worker_threads = 0
|
|
152
|
+
|
|
153
|
+
block.call
|
|
154
|
+
ensure
|
|
155
|
+
configuration.background_worker_threads = original_background_worker_threads
|
|
156
|
+
end
|
|
157
|
+
|
|
147
158
|
private
|
|
148
159
|
|
|
149
160
|
def current_layer
|
data/lib/sentry/rake.rb
CHANGED
|
@@ -3,6 +3,7 @@ require "rake/task"
|
|
|
3
3
|
|
|
4
4
|
module Rake
|
|
5
5
|
class Application
|
|
6
|
+
|
|
6
7
|
alias orig_display_error_messsage display_error_message
|
|
7
8
|
def display_error_message(ex)
|
|
8
9
|
Sentry.capture_exception(ex, hint: { background: false }) do |scope|
|
|
@@ -14,4 +15,16 @@ module Rake
|
|
|
14
15
|
orig_display_error_messsage(ex)
|
|
15
16
|
end
|
|
16
17
|
end
|
|
18
|
+
|
|
19
|
+
class Task
|
|
20
|
+
alias orig_execute execute
|
|
21
|
+
|
|
22
|
+
def execute(args=nil)
|
|
23
|
+
return orig_execute unless Sentry.initialized? && Sentry.get_current_hub
|
|
24
|
+
|
|
25
|
+
Sentry.get_current_hub.with_background_worker_disabled do
|
|
26
|
+
orig_execute
|
|
27
|
+
end
|
|
28
|
+
end
|
|
29
|
+
end
|
|
17
30
|
end
|
data/lib/sentry/utils/real_ip.rb
CHANGED
|
@@ -29,7 +29,13 @@ module Sentry
|
|
|
29
29
|
@client_ip = client_ip
|
|
30
30
|
@real_ip = real_ip
|
|
31
31
|
@forwarded_for = forwarded_for
|
|
32
|
-
@trusted_proxies = (LOCAL_ADDRESSES + Array(trusted_proxies)).map
|
|
32
|
+
@trusted_proxies = (LOCAL_ADDRESSES + Array(trusted_proxies)).map do |proxy|
|
|
33
|
+
if proxy.is_a?(IPAddr)
|
|
34
|
+
proxy
|
|
35
|
+
else
|
|
36
|
+
IPAddr.new(proxy.to_s)
|
|
37
|
+
end
|
|
38
|
+
end.uniq
|
|
33
39
|
end
|
|
34
40
|
|
|
35
41
|
def calculate_ip
|
data/lib/sentry/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: sentry-ruby-core
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 4.
|
|
4
|
+
version: 4.6.2
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Sentry Team
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: exe
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2021-
|
|
11
|
+
date: 2021-07-23 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: faraday
|