sentry-ruby 4.5.0 → 4.6.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (3) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +26 -174
  3. metadata +4 -4
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 90e69712e17e03c89595669d92c472c91d7467cb55c2a9f0091197be0c4fef60
4
- data.tar.gz: 0bf22c46bb57cba914e5ccbf8c0d5d92fb87bb6b45c0f629207395826bed92ec
3
+ metadata.gz: f3663e5ad30cec8b9ec7c2180f37e86c12d7bdf489f0d40cf7b193621a5e235f
4
+ data.tar.gz: 6c9a824a6cd4461a51dd31d10d545aca4be7c395f5391c08d55dac7184734df3
5
5
  SHA512:
6
- metadata.gz: 12dda802dda77e941cd5984f85f86e07b64f7835dc3c34b22d381ace86f0d8b633f4be2b9a1f65771065cc71b50a2ddf351510195ff200828a1f96bd870b440b
7
- data.tar.gz: f921b596aeeedef007a019c59836a79210e75c31187dfb47a496959288c4056c108c888d813673d201b7d270ef6809e8e645e9f65e44b25afc179083a4a3551b
6
+ metadata.gz: 325f098e332ec1bcb20c0fa248f656be1971963d1b033cc57ceb5e08da44c9d75d9823400a7d831c3c8c365a1aa2136451e96fa62849ad26ef7981ed84789d43
7
+ data.tar.gz: 1a5bb591222b2422d05d6e7a123a3628baefe34c42b68e6e46d5fd3336fa83ae1d8d9e267342852dfcc9f1cf5dbf621759ff1d854ce673b629a71b73bd436a68
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
- | [![Gem Version](https://img.shields.io/gem/v/sentry-ruby?label=sentry-ruby)](https://github.com/getsentry/sentry-ruby/blob/master/sentry-ruby/CHANGELOG.md) | ![Build Status](https://github.com/getsentry/sentry-ruby/workflows/sentry-ruby%20Test/badge.svg) | [![Coverage Status](https://img.shields.io/codecov/c/github/getsentry/sentry-ruby/master?logo=codecov)](https://codecov.io/gh/getsentry/sentry-ruby/branch/master) | [![Downloads](https://img.shields.io/gem/dt/sentry-ruby.svg)](https://rubygems.org/gems/sentry-ruby/) | [![SemVer stability](https://api.dependabot.com/badges/compatibility_score?dependency-name=sentry-ruby&package-manager=bundler&version-scheme=semver)](https://dependabot.com/compatibility-score.html?dependency-name=sentry-ruby&package-manager=bundler&version-scheme=semver) |
16
- | [![Gem Version](https://img.shields.io/gem/v/sentry-rails?label=sentry-rails)](https://github.com/getsentry/sentry-ruby/blob/master/sentry-rails/CHANGELOG.md) | ![Build Status](https://github.com/getsentry/sentry-ruby/workflows/sentry-rails%20Test/badge.svg) | [![Coverage Status](https://img.shields.io/codecov/c/github/getsentry/sentry-ruby/master?logo=codecov)](https://codecov.io/gh/getsentry/sentry-ruby/branch/master) | [![Downloads](https://img.shields.io/gem/dt/sentry-rails.svg)](https://rubygems.org/gems/sentry-rails/) | [![SemVer stability](https://api.dependabot.com/badges/compatibility_score?dependency-name=sentry-rails&package-manager=bundler&version-scheme=semver)](https://dependabot.com/compatibility-score.html?dependency-name=sentry-rails&package-manager=bundler&version-scheme=semver) |
17
- | [![Gem Version](https://img.shields.io/gem/v/sentry-sidekiq?label=sentry-sidekiq)](https://github.com/getsentry/sentry-ruby/blob/master/sentry-sidekiq/CHANGELOG.md) | ![Build Status](https://github.com/getsentry/sentry-ruby/workflows/sentry-sidekiq%20Test/badge.svg) | [![Coverage Status](https://img.shields.io/codecov/c/github/getsentry/sentry-ruby/master?logo=codecov)](https://codecov.io/gh/getsentry/sentry-ruby/branch/master) | [![Downloads](https://img.shields.io/gem/dt/sentry-sidekiq.svg)](https://rubygems.org/gems/sentry-sidekiq/) | [![SemVer stability](https://api.dependabot.com/badges/compatibility_score?dependency-name=sentry-sidekiq&package-manager=bundler&version-scheme=semver)](https://dependabot.com/compatibility-score.html?dependency-name=sentry-sidekiq&package-manager=bundler&version-scheme=semver) |
18
- | [![Gem Version](https://img.shields.io/gem/v/sentry-delayed_job?label=sentry-delayed_job)](https://github.com/getsentry/sentry-ruby/blob/master/sentry-delayed_job/CHANGELOG.md) | ![Build Status](https://github.com/getsentry/sentry-ruby/workflows/sentry-delayed_job%20Test/badge.svg) | [![Coverage Status](https://img.shields.io/codecov/c/github/getsentry/sentry-ruby/master?logo=codecov)](https://codecov.io/gh/getsentry/sentry-ruby/branch/master) | [![Downloads](https://img.shields.io/gem/dt/sentry-delayed_job.svg)](https://rubygems.org/gems/sentry-delayed_job/) | [![SemVer stability](https://api.dependabot.com/badges/compatibility_score?dependency-name=sentry-delayed_job&package-manager=bundler&version-scheme=semver)](https://dependabot.com/compatibility-score.html?dependency-name=sentry-delayed_job&package-manager=bundler&version-scheme=semver) |
15
+ | [![Gem Version](https://img.shields.io/gem/v/sentry-ruby?label=sentry-ruby)](https://rubygems.org/gems/sentry-ruby) | [![Build Status](https://github.com/getsentry/sentry-ruby/workflows/sentry-ruby%20Test/badge.svg)](https://github.com/getsentry/sentry-ruby/actions/workflows/sentry_ruby_test.yml) | [![Coverage Status](https://img.shields.io/codecov/c/github/getsentry/sentry-ruby/master?logo=codecov)](https://codecov.io/gh/getsentry/sentry-ruby/branch/master) | [![Downloads](https://img.shields.io/gem/dt/sentry-ruby.svg)](https://rubygems.org/gems/sentry-ruby/) | [![SemVer stability](https://api.dependabot.com/badges/compatibility_score?dependency-name=sentry-ruby&package-manager=bundler&version-scheme=semver)](https://dependabot.com/compatibility-score.html?dependency-name=sentry-ruby&package-manager=bundler&version-scheme=semver) |
16
+ | [![Gem Version](https://img.shields.io/gem/v/sentry-rails?label=sentry-rails)](https://rubygems.org/gems/sentry-rails) | [![Build Status](https://github.com/getsentry/sentry-ruby/workflows/sentry-rails%20Test/badge.svg)](https://github.com/getsentry/sentry-ruby/actions/workflows/sentry_rails_test.yml) | [![Coverage Status](https://img.shields.io/codecov/c/github/getsentry/sentry-ruby/master?logo=codecov)](https://codecov.io/gh/getsentry/sentry-ruby/branch/master) | [![Downloads](https://img.shields.io/gem/dt/sentry-rails.svg)](https://rubygems.org/gems/sentry-rails/) | [![SemVer stability](https://api.dependabot.com/badges/compatibility_score?dependency-name=sentry-rails&package-manager=bundler&version-scheme=semver)](https://dependabot.com/compatibility-score.html?dependency-name=sentry-rails&package-manager=bundler&version-scheme=semver) |
17
+ | [![Gem Version](https://img.shields.io/gem/v/sentry-sidekiq?label=sentry-sidekiq)](https://rubygems.org/gems/sentry-sidekiq) | [![Build Status](https://github.com/getsentry/sentry-ruby/workflows/sentry-sidekiq%20Test/badge.svg)](https://github.com/getsentry/sentry-ruby/actions/workflows/sentry_sidekiq_test.yml) | [![Coverage Status](https://img.shields.io/codecov/c/github/getsentry/sentry-ruby/master?logo=codecov)](https://codecov.io/gh/getsentry/sentry-ruby/branch/master) | [![Downloads](https://img.shields.io/gem/dt/sentry-sidekiq.svg)](https://rubygems.org/gems/sentry-sidekiq/) | [![SemVer stability](https://api.dependabot.com/badges/compatibility_score?dependency-name=sentry-sidekiq&package-manager=bundler&version-scheme=semver)](https://dependabot.com/compatibility-score.html?dependency-name=sentry-sidekiq&package-manager=bundler&version-scheme=semver) |
18
+ | [![Gem Version](https://img.shields.io/gem/v/sentry-delayed_job?label=sentry-delayed_job)](https://rubygems.org/gems/sentry-delayed_job) | [![Build Status](https://github.com/getsentry/sentry-ruby/workflows/sentry-delayed_job%20Test/badge.svg)](https://github.com/getsentry/sentry-ruby/actions/workflows/sentry_delayed_job_test.yml) | [![Coverage Status](https://img.shields.io/codecov/c/github/getsentry/sentry-ruby/master?logo=codecov)](https://codecov.io/gh/getsentry/sentry-ruby/branch/master) | [![Downloads](https://img.shields.io/gem/dt/sentry-delayed_job.svg)](https://rubygems.org/gems/sentry-delayed_job/) | [![SemVer stability](https://api.dependabot.com/badges/compatibility_score?dependency-name=sentry-delayed_job&package-manager=bundler&version-scheme=semver)](https://dependabot.com/compatibility-score.html?dependency-name=sentry-delayed_job&package-manager=bundler&version-scheme=semver) |
19
+ | [![Gem Version](https://img.shields.io/gem/v/sentry-resque?label=sentry-resque)](https://rubygems.org/gems/sentry-resque) | [![Build Status](https://github.com/getsentry/sentry-ruby/workflows/sentry-resque%20Test/badge.svg)](https://github.com/getsentry/sentry-ruby/actions/workflows/sentry_resque_test.yml) | [![Coverage Status](https://img.shields.io/codecov/c/github/getsentry/sentry-ruby/master?logo=codecov)](https://codecov.io/gh/getsentry/sentry-ruby/branch/master) | [![Downloads](https://img.shields.io/gem/dt/sentry-resque.svg)](https://rubygems.org/gems/sentry-resque/) | [![SemVer stability](https://api.dependabot.com/badges/compatibility_score?dependency-name=sentry-resque&package-manager=bundler&version-scheme=semver)](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
- # and mores to come in the future!
50
+ gem "sentry-resque"
50
51
  ```
51
52
 
52
- ### Sentry only runs when Sentry DSN is set
53
+ ### Configuration
53
54
 
54
- Sentry will capture and send exceptions to the Sentry server whenever its DSN is set. This makes environment-based configuration easy - if you don't want to send errors in a certain environment, just don't set the DSN in that environment!
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 = 'http://public@example.com/project-id'
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
- # or control sampling dynamically
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 performance monitoring, please visit the [official documentation](https://docs.sentry.io/platforms/ruby/performance).
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
- ### Usage
81
+ ### Integrations
101
82
 
102
- `sentry-ruby` has a default integration with `Rack`, so you only need to use the middleware in your application like:
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
- ```ruby
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
- If you want to send a particular event immediately, you can use event hints to do it:
175
-
176
- ```ruby
177
- Sentry.capture_message("send me now!", hint: { background: false })
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
 
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: 4.5.0
4
+ version: 4.6.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Sentry Team
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-05-27 00:00:00.000000000 Z
11
+ date: 2021-07-08 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: sentry-ruby-core
@@ -16,14 +16,14 @@ dependencies:
16
16
  requirements:
17
17
  - - '='
18
18
  - !ruby/object:Gem::Version
19
- version: 4.5.0
19
+ version: 4.6.1
20
20
  type: :runtime
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
24
  - - '='
25
25
  - !ruby/object:Gem::Version
26
- version: 4.5.0
26
+ version: 4.6.1
27
27
  - !ruby/object:Gem::Dependency
28
28
  name: faraday
29
29
  requirement: !ruby/object:Gem::Requirement