sentry-ruby-core 4.1.5 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7862b3ddbb49c77b2c47c1a9509cce1efa4c193d459d0b3bd07bebd6aa9b62e
-  data.tar.gz: faca1cc6efce70d3f64e1266c2e32fc2d67352544f8bfc2b2a278bcbefca1a61
+  metadata.gz: 66ef212c06425a29b56b64935c1fb662633fa80fb9f58b9680b1d95220ee8b5d
+  data.tar.gz: 18e211d0c93d18717795b23290c2cb7da503b0dcd1690c1c8b51861c3a37ef98
 SHA512:
-  metadata.gz: 76dbfe0e360744126dcfdfce35d1563fb14387bafb1196c315fd1ef5e9d57c09d4d627f5a5386610a031a4909fab28a659bdfcd66e96d00a2e56c8737c130358
-  data.tar.gz: e4c26db4e8bcaa1c6a32c4acadc9d385356b3617b8d5e76ffeda773b9deb4da291a77eafef27aa7bb98539cca187f27d174a7d0cc16c1ef8204c380e46fd54fc
+  metadata.gz: e334875a26a04e45a78c37e7bb0014604cd2b400b89eb01faa3ae21adc1f9072e46227ce880c1406148e32d6a125504dc08ffab5e1ac61c0b3befbd31e5352ea
+  data.tar.gz: 4c01fb8d489a3d143a738180f3f68ba62d3882267ecf17b82c3cf0e509ab36a8b458699d022d5d55699baacaccd2acc3bfede0d332ae5b50776128ac5c164a2a

data/CHANGELOG.md

@@ -1,5 +1,90 @@
 # Changelog
 
+## 4.3.0
+
+### Features
+
+- Allow configuring BreadcrumbBuffer's size limit [#1310](https://github.com/getsentry/sentry-ruby/pull/1310)
+
+```ruby
+# the SDK will only store 10 breadcrumbs (default is 100)
+config.max_breadcrumbs = 10
+```
+
+- Compress event payload by default [#1314](https://github.com/getsentry/sentry-ruby/pull/1314)
+
+### Refatorings
+
+- Refactor interface construction [#1296](https://github.com/getsentry/sentry-ruby/pull/1296)
+- Refactor tracing implementation [#1309](https://github.com/getsentry/sentry-ruby/pull/1309)
+
+### Bug Fixes
+- Improve SDK's error handling [#1298](https://github.com/getsentry/sentry-ruby/pull/1298)
+  - Fixes [#1246](https://github.com/getsentry/sentry-ruby/issues/1246) and [#1289](https://github.com/getsentry/sentry-ruby/issues/1289)
+  - Please read [#1290](https://github.com/getsentry/sentry-ruby/issues/1290) to see the full specification
+- Treat query string as pii too [#1302](https://github.com/getsentry/sentry-ruby/pull/1302)
+  - Fixes [#1301](https://github.com/getsentry/sentry-ruby/issues/1301)
+- Ignore sentry-trace when tracing is not enabled [#1308](https://github.com/getsentry/sentry-ruby/pull/1308)
+  - Fixes [#1307](https://github.com/getsentry/sentry-ruby/issues/1307)
+- Return nil from logger methods instead of breadcrumb buffer [#1299](https://github.com/getsentry/sentry-ruby/pull/1299)
+- Exceptions with nil message shouldn't cause issues [#1327](https://github.com/getsentry/sentry-ruby/pull/1327)
+  - Fixes [#1323](https://github.com/getsentry/sentry-ruby/issues/1323)
+- Fix sampling decision with sentry-trace and add more tests [#1326](https://github.com/getsentry/sentry-ruby/pull/1326)
+
+## 4.2.2
+
+- Add thread_id to Exception interface [#1291](https://github.com/getsentry/sentry-ruby/pull/1291)
+- always convert trusted proxies to string [#1288](https://github.com/getsentry/sentry-ruby/pull/1288)
+  - fixes [#1274](https://github.com/getsentry/sentry-ruby/issues/1274)
+
+## 4.2.1
+
+### Bug Fixes
+
+- Ignore invalid values for sentry-trace header that don't match the required format [#1265](https://github.com/getsentry/sentry-ruby/pull/1265)
+- Transaction created by `.from_sentry_trace` should inherit sampling decision [#1269](https://github.com/getsentry/sentry-ruby/pull/1269)
+- Transaction's sample rate should accept any numeric value [#1278](https://github.com/getsentry/sentry-ruby/pull/1278)
+
+## 4.2.0
+
+### Features
+
+- Add configuration option for trusted proxies [#1126](https://github.com/getsentry/sentry-ruby/pull/1126)
+
+```ruby
+config.trusted_proxies = ["2.2.2.2"] # this ip address will be skipped when computing users' ip addresses
+```
+
+- Add ThreadsInterface [#1178](https://github.com/getsentry/sentry-ruby/pull/1178)
+
+<img width="1029" alt="an exception event that has the new threads interface" src="https://user-images.githubusercontent.com/5079556/103459223-98b64c00-4d48-11eb-9ebb-ee58f15e647e.png">
+
+- Support `config.before_breadcrumb` [#1253](https://github.com/getsentry/sentry-ruby/pull/1253)
+
+```ruby
+# this will be called before every breadcrumb is added to the breadcrumb buffer
+# you can use it to
+# - remove the data you don't want to send
+# - add additional info to the data
+config.before_breadcrumb = lambda do |breadcrumb, hint|
+  breadcrumb.message = "foo"
+  breadcrumb
+end
+```
+
+- Add ability to have many post initialization callbacks [#1261](https://github.com/getsentry/sentry-ruby/pull/1261)
+
+### Bug Fixes
+
+- Inspect exception cause by default & don't exclude ActiveJob::DeserializationError [#1180](https://github.com/getsentry/sentry-ruby/pull/1180)
+  - Fixes [#1071](https://github.com/getsentry/sentry-ruby/issues/1071)
+
+## 4.1.6
+
+- Don't detect project root for Rails apps [#1243](https://github.com/getsentry/sentry-ruby/pull/1243)
+- Separate individual breadcrumb's data serialization [#1250](https://github.com/getsentry/sentry-ruby/pull/1250)
+- Capture sentry-trace with the correct http header key [#1260](https://github.com/getsentry/sentry-ruby/pull/1260)
+
 ## 4.1.5
 
 - Serialize event hint before passing it to the async block [#1231](https://github.com/getsentry/sentry-ruby/pull/1231)
@@ -134,4 +219,3 @@ Fix require reference
 ## 0.1.0
 
 First version
-

data/Gemfile

@@ -3,6 +3,9 @@ source "https://rubygems.org"
 gem "sentry-ruby-core", path: "./"
 gem "sentry-ruby", path: "./"
 
+# TODO: Remove this if https://github.com/jruby/jruby/issues/6547 is addressed
+gem "i18n", "<= 1.8.7"
+
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"
 gem "codecov", "0.2.12"

data/Makefile

@@ -0,0 +1,4 @@
+build:
+	bundle install
+	gem build sentry-ruby-core.gemspec
+	gem build sentry-ruby.gemspec

data/README.md

@@ -2,10 +2,14 @@
   <a href="https://sentry.io" target="_blank" align="center">
     <img src="https://sentry-brand.storage.googleapis.com/sentry-logo-black.png" width="280">
   </a>
-  <br>
+  <br />
 </p>
 
-# sentry-ruby, the Ruby Client for Sentry
+_Bad software is everywhere, and we're tired of it. Sentry is on a mission to help developers write better software faster, so we can get back to enjoying technology. If you want to join us [<kbd>**Check out our open positions**</kbd>](https://sentry.io/careers/)_
+
+Sentry SDK for Ruby
+===========
+
 
 **The old `sentry-raven` client has entered maintenance mode and was moved to [here](https://github.com/getsentry/sentry-ruby/tree/master/sentry-raven).**
 
@@ -26,7 +30,7 @@ The official Ruby-language client and integration layer for the [Sentry](https:/
 
 ## Requirements
 
-We test on Ruby 2.4, 2.5, 2.6 and 2.7 at the latest patchlevel/teeny version. We also support JRuby 9.0.
+We test on Ruby 2.4, 2.5, 2.6, 2.7, and 3.0 at the latest patchlevel/teeny version. We also support JRuby 9.0.
 
 If you use self-hosted Sentry, please also make sure its version is above `20.6.0`.
 
@@ -47,6 +51,7 @@ and depends on the integrations you want to have, you might also want to install
 ```ruby
 gem "sentry-rails"
 gem "sentry-sidekiq"
+gem "sentry-delayed_job"
 # and mores to come in the future!
 ```
 
@@ -136,6 +141,7 @@ We also provide integrations with popular frameworks/libraries with the related
 
 - [sentry-rails](https://github.com/getsentry/sentry-ruby/tree/master/sentry-rails)
 - [sentry-sidekiq](https://github.com/getsentry/sentry-ruby/tree/master/sentry-sidekiq)
+- [sentry-delayed_job](https://github.com/getsentry/sentry-ruby/tree/master/sentry-delayed_job)
 
 ### More configuration
 
@@ -143,32 +149,7 @@ You're all set - but there's a few more settings you may want to know about too!
 
 #### Blocking v.s. Non-blocking
 
-**Before version 4.1.0**, `sentry-ruby` sends every event immediately. But it can be configured to send asynchronously:
-
-```ruby
-config.async = lambda { |event, hint|
-  Thread.new { Sentry.send_event(event, hint) }
-}
-```
-
-Using a thread to send events will be adequate for truly parallel Ruby platforms such as JRuby, though the benefit on MRI/CRuby will be limited. If the async callback raises an exception, Sentry will attempt to send synchronously.
-
-Note that the naive example implementation has a major drawback - it can create an infinite number of threads. We recommend creating a background job, using your background job processor, that will send Sentry notifications in the background.
-
-```ruby
-config.async = lambda { |event, hint| SentryJob.perform_later(event, hint) }
-
-class SentryJob < ActiveJob::Base
-  queue_as :default
-
-  def perform(event, hint)
-    Sentry.send_event(event, hint)
-  end
-end
-```
-
-
-**After version 4.1.0**, `sentry-ruby` sends events asynchronously by default. The functionality works like this: 
+`sentry-ruby` sends events asynchronously by default. The functionality works like this:
 
 1. When the SDK is initialized, a `Sentry::BackgroundWorker` will be initialized too.
 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.
@@ -202,6 +183,21 @@ If you want to send a particular event immediately, you can use event hints to d
 Sentry.capture_message("send me now!", hint: { background: false })
 ```
 
+##### `config.async`
+
+You can also use `config.async` to send events with you own worker:
+
+```ruby
+config.async = lambda { |event, hint| SentryJob.perform_later(event, hint) }
+```
+
+And if you use `sentry-rails`, you can directly use the job we defined for you:
+
+```ruby
+config.async = lambda { |event, hint| Sentry::SendEventJob.perform_later(event, hint) }
+```
+
+
 #### Contexts
 
 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:

data/lib/sentry-ruby.rb

@@ -3,6 +3,7 @@ require "forwardable"
 require "time"
 
 require "sentry/version"
+require "sentry/exceptions"
 require "sentry/core_ext/object/deep_dup"
 require "sentry/utils/argument_checking_helper"
 require "sentry/configuration"
@@ -26,9 +27,6 @@ require "sentry/background_worker"
 end
 
 module Sentry
-  class Error < StandardError
-  end
-
   META = { "name" => "sentry.ruby", "version" => Sentry::VERSION }.freeze
 
   LOGGER_PROGNAME = "sentry".freeze
@@ -68,7 +66,7 @@ module Sentry
       config = Configuration.new
       yield(config) if block_given?
       client = Client.new(config)
-      scope = Scope.new
+      scope = Scope.new(max_breadcrumbs: config.max_breadcrumbs)
       hub = Hub.new(client, scope)
       Thread.current[THREAD_LOCAL] = hub
       @main_hub = hub

data/lib/sentry/background_worker.rb

@@ -1,5 +1,6 @@
 require "concurrent/executor/thread_pool_executor"
 require "concurrent/executor/immediate_executor"
+require "concurrent/configuration"
 
 module Sentry
   class BackgroundWorker

data/lib/sentry/breadcrumb.rb

@@ -1,5 +1,7 @@
 module Sentry
   class Breadcrumb
+    DATA_SERIALIZATION_ERROR_MESSAGE = "[data were removed due to serialization issues]"
+
     attr_accessor :category, :data, :message, :level, :timestamp, :type
 
     def initialize(category: nil, data: nil, message: nil, timestamp: nil, level: nil, type: nil)
@@ -13,13 +15,30 @@ module Sentry
 
     def to_hash
       {
-        :category => @category,
-        :data => @data,
-        :level => @level,
-        :message => @message,
-        :timestamp => @timestamp,
-        :type => @type
+        category: @category,
+        data: serialized_data,
+        level: @level,
+        message: @message,
+        timestamp: @timestamp,
+        type: @type
       }
     end
+
+    private
+
+    def serialized_data
+      begin
+        ::JSON.parse(::JSON.generate(@data))
+      rescue Exception => e
+        Sentry.logger.debug(LOGGER_PROGNAME) do
+          <<~MSG
+can't serialize breadcrumb data because of error: #{e}
+data: #{@data}
+          MSG
+        end
+
+        DATA_SERIALIZATION_ERROR_MESSAGE
+      end
+    end
   end
 end

data/lib/sentry/breadcrumb/sentry_logger.rb

@@ -14,6 +14,7 @@ module Sentry
       def add(*args, &block)
         super
         add_breadcrumb(*args, &block)
+        nil
       end
 
       def add_breadcrumb(severity, message = nil, progname = nil)

data/lib/sentry/breadcrumb_buffer.rb

@@ -2,12 +2,13 @@ require "sentry/breadcrumb"
 
 module Sentry
   class BreadcrumbBuffer
+    DEFAULT_SIZE = 100
     include Enumerable
 
     attr_accessor :buffer
 
-    def initialize(size = 100)
-      @buffer = Array.new(size)
+    def initialize(size = nil)
+      @buffer = Array.new(size || DEFAULT_SIZE)
     end
 
     def record(crumb)
@@ -34,7 +35,7 @@ module Sentry
 
     def to_hash
       {
-        :values => members.map(&:to_hash)
+        values: members.map(&:to_hash)
       }
     end
 

data/lib/sentry/client.rb

@@ -2,10 +2,11 @@ require "sentry/transport"
 
 module Sentry
   class Client
-    attr_reader :transport, :configuration
+    attr_reader :transport, :configuration, :logger
 
     def initialize(configuration)
       @configuration = configuration
+      @logger = configuration.logger
 
       if transport_class = configuration.transport.transport_class
         @transport = transport_class.new(configuration)
@@ -26,32 +27,17 @@ module Sentry
       scope.apply_to_event(event, hint)
 
       if async_block = configuration.async
-        begin
-          # We have to convert to a JSON-like hash, because background job
-          # processors (esp ActiveJob) may not like weird types in the event hash
-          event_hash = event.to_json_compatible
-
-          if async_block.arity == 2
-            hint = JSON.parse(JSON.generate(hint))
-            async_block.call(event_hash, hint)
-          else
-            async_block.call(event_hash)
-          end
-        rescue => e
-          configuration.logger.error(LOGGER_PROGNAME) { "async event sending failed: #{e.message}" }
-          send_event(event, hint)
-        end
+        dispatch_async_event(async_block, event, hint)
+      elsif hint.fetch(:background, true)
+        dispatch_background_event(event, hint)
       else
-        if hint.fetch(:background, true)
-          Sentry.background_worker.perform do
-            send_event(event, hint)
-          end
-        else
-          send_event(event, hint)
-        end
+        send_event(event, hint)
       end
 
       event
+    rescue => e
+      logger.error(LOGGER_PROGNAME) { "Event capturing failed: #{e.message}" }
+      nil
     end
 
     def event_from_exception(exception, hint = {})
@@ -60,12 +46,15 @@ module Sentry
 
       Event.new(configuration: configuration, integration_meta: integration_meta).tap do |event|
         event.add_exception_interface(exception)
+        event.add_threads_interface(crashed: true)
       end
     end
 
     def event_from_message(message, hint = {})
       integration_meta = Sentry.integrations[hint[:integration]]
-      Event.new(configuration: configuration, integration_meta: integration_meta, message: message)
+      event = Event.new(configuration: configuration, integration_meta: integration_meta, message: message)
+      event.add_threads_interface(backtrace: caller)
+      event
     end
 
     def event_from_transaction(transaction)
@@ -82,16 +71,49 @@ module Sentry
 
     def send_event(event, hint = nil)
       event_type = event.is_a?(Event) ? event.type : event["type"]
-      event = configuration.before_send.call(event, hint) if configuration.before_send && event_type == "event"
 
-      if event.nil?
-        configuration.logger.info(LOGGER_PROGNAME) { "Discarded event because before_send returned nil" }
-        return
+      if event_type == "event" && configuration.before_send
+        event = configuration.before_send.call(event, hint)
+
+        if event.nil?
+          logger.info(LOGGER_PROGNAME) { "Discarded event because before_send returned nil" }
+          return
+        end
       end
 
       transport.send_event(event)
 
       event
+    rescue => e
+      logger.error(LOGGER_PROGNAME) { "#{event_type.capitalize} sending failed: #{e.message}" }
+      logger.error(LOGGER_PROGNAME) { "Unreported #{event_type.capitalize}: #{Event.get_log_message(event.to_hash)}" }
+      raise
+    end
+
+    private
+
+    def dispatch_background_event(event, hint)
+      Sentry.background_worker.perform do
+        send_event(event, hint)
+      end
     end
+
+    def dispatch_async_event(async_block, event, hint)
+      # We have to convert to a JSON-like hash, because background job
+      # processors (esp ActiveJob) may not like weird types in the event hash
+      event_hash = event.to_json_compatible
+
+      if async_block.arity == 2
+        hint = JSON.parse(JSON.generate(hint))
+        async_block.call(event_hash, hint)
+      else
+        async_block.call(event_hash)
+      end
+    rescue => e
+      event_type = event_hash["type"]
+      logger.error(LOGGER_PROGNAME) { "Async #{event_type} sending failed: #{e.message}" }
+      send_event(event, hint)
+    end
+
   end
 end