sentry-ruby-core 4.1.6 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 584f6d4758f8c7756443aa2f242e0c8c8d8f34b49089863714ae52b76b18c4af
-  data.tar.gz: 4a0c8fc92d430a1b8b0726d2cee9c96d4ddc918f99702081c93b5af9b75a53a3
+  metadata.gz: f228cdc7c08c8c6de173c997a1e21b28008026280c9d4680b786be20c9d8590e
+  data.tar.gz: 871d6e1ba2c6799e18ee4c2c89ce0807ebc79a6018e074f5007e955fc2a5dd78
 SHA512:
-  metadata.gz: d1ebaf29b9c6712e7f23ef91cad67e0ddb50fcd2849b45e1fba31e7e7e58acdacbf1f64cb6abb50c1269aa4dedf0e8dd1bd5df7cc8ea83a0be223c2124ab2652
-  data.tar.gz: 3f2e9ff72da83a8644de0e2ca6cc85b3febaa7a3bd9b84abf10e91047207debfcf83e446ee63216dbfc097947b874cd605ffa89947e162331f33f103b599ae36
+  metadata.gz: 4155d1944e86ed17387643ce2325f0fae3c2ea8a9dfd9a020b4bb68e36390b5ef3b5fd74c2b79e68847bc5f7c636e59310d57d8819eaf0a62059e8663358821c
+  data.tar.gz: 7d09d5d45d2eb284fc9539d956db09dcf38a42546ccdf1e047872ec7eafdfa052656b13d4ea2cdc523dd1ff069a749f1f3963ab76398587378f2020f995e0c7c

data/CHANGELOG.md

@@ -1,5 +1,39 @@
 # Changelog
 
+## 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)
@@ -140,4 +174,3 @@ Fix require reference
 ## 0.1.0
 
 First version
-

data/README.md

@@ -160,6 +160,7 @@ config.async = lambda { |event, hint| SentryJob.perform_later(event, hint) }
 
 class SentryJob < ActiveJob::Base
   queue_as :default
+  discard_on ActiveJob::DeserializationError # this will prevent infinite loop when there's an issue deserializing SentryJob
 
   def perform(event, hint)
     Sentry.send_event(event, hint)
@@ -167,8 +168,13 @@ class SentryJob < ActiveJob::Base
 end
 ```
 
+If you also use `sentry-rails`, you can directly use the job we defined for you:
 
-**After version 4.1.0**, `sentry-ruby` sends events asynchronously by default. The functionality works like this: 
+```ruby
+config.async = lambda { |event, hint| Sentry::SendEventJob.perform_later(event, hint) }
+```
+
+**After version 4.1.0**, `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.

data/lib/sentry/client.rb

@@ -60,12 +60,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)

data/lib/sentry/configuration.rb

@@ -38,10 +38,19 @@ module Sentry
     #
     attr_accessor :backtrace_cleanup_callback
 
+    # Optional Proc, called before adding the breadcrumb to the current scope
+    # E.g.: lambda { |breadcrumb, hint| breadcrumb }
+    # E.g.: lambda { |breadcrumb, hint| nil }
+    # E.g.: lambda { |breadcrumb, hint|
+    #   breadcrumb.message = 'a'
+    #   breadcrumb
+    # }
+    attr_reader :before_breadcrumb
+
     # Optional Proc, called before sending an event to the server/
-    # E.g.: lambda { |event| event }
-    # E.g.: lambda { |event| nil }
-    # E.g.: lambda { |event|
+    # E.g.: lambda { |event, hint| event }
+    # E.g.: lambda { |event, hint| nil }
+    # E.g.: lambda { |event, hint|
     #   event[:message] = 'a'
     #   event
     # }
@@ -109,6 +118,9 @@ module Sentry
     # will not be sent to Sentry.
     attr_accessor :send_default_pii
 
+    # IP ranges for trusted proxies that will be skipped when calculating IP address.
+    attr_accessor :trusted_proxies
+
     attr_accessor :server_name
 
     # Return a Transport::Configuration object for transport-related configurations.
@@ -153,6 +165,10 @@ module Sentry
 
     AVAILABLE_BREADCRUMBS_LOGGERS = [:sentry_logger, :active_support_logger].freeze
 
+    # Post initialization callbacks are called at the end of initialization process
+    # allowing extending the configuration of sentry-ruby by multiple extensions
+    @@post_initialization_callbacks = []
+
     def initialize
       self.background_worker_threads = Concurrent.processor_count
       self.breadcrumbs_logger = []
@@ -161,7 +177,7 @@ module Sentry
       self.enabled_environments = []
       self.exclude_loggers = []
       self.excluded_exceptions = IGNORE_DEFAULT.dup
-      self.inspect_exception_causes_for_exclusion = false
+      self.inspect_exception_causes_for_exclusion = true
       self.linecache = ::Sentry::LineCache.new
       self.logger = ::Sentry::Logger.new(STDOUT)
       self.project_root = Dir.pwd
@@ -170,6 +186,7 @@ module Sentry
       self.sample_rate = 1.0
       self.send_modules = true
       self.send_default_pii = false
+      self.trusted_proxies = []
       self.dsn = ENV['SENTRY_DSN']
       self.server_name = server_name_from_env
 
@@ -178,7 +195,7 @@ module Sentry
 
       @transport = Transport::Configuration.new
       @gem_specs = Hash[Gem::Specification.map { |spec| [spec.name, spec.version.to_s] }] if Gem::Specification.respond_to?(:map)
-      post_initialization_callback
+      run_post_initialization_callbacks
     end
 
     def dsn=(value)
@@ -223,6 +240,14 @@ module Sentry
       @before_send = value
     end
 
+    def before_breadcrumb=(value)
+      unless value.nil? || value.respond_to?(:call)
+        raise ArgumentError, "before_breadcrumb must be callable (or nil to disable)"
+      end
+
+      @before_breadcrumb = value
+    end
+
     def environment=(environment)
       @environment = environment.to_s
     end
@@ -382,7 +407,21 @@ module Sentry
       end
     end
 
-    # allow extensions to extend the Configuration class
-    def post_initialization_callback; end
+    def run_post_initialization_callbacks
+      self.class.post_initialization_callbacks.each do |hook|
+        instance_eval(&hook)
+      end
+    end
+
+    # allow extensions to add their hooks to the Configuration class
+    def self.add_post_initialization_callback(&block)
+      self.post_initialization_callbacks << block
+    end
+
+    protected
+
+    def self.post_initialization_callbacks
+      @@post_initialization_callbacks
+    end
   end
 end

data/lib/sentry/event.rb

@@ -20,7 +20,7 @@ module Sentry
     MAX_MESSAGE_SIZE_IN_BYTES = 1024 * 8
 
     attr_accessor(*ATTRIBUTES)
-    attr_reader :configuration, :request, :exception, :stacktrace
+    attr_reader :configuration, :request, :exception, :stacktrace, :threads
 
     def initialize(configuration:, integration_meta: nil, message: nil)
       # this needs to go first because some setters rely on configuration
@@ -102,6 +102,7 @@ module Sentry
       data[:stacktrace] = stacktrace.to_hash if stacktrace
       data[:request] = request.to_hash if request
       data[:exception] = exception.to_hash if exception
+      data[:threads] = threads.to_hash if threads
 
       data
     end
@@ -114,6 +115,11 @@ module Sentry
       @request = Sentry::RequestInterface.from_rack(env)
     end
 
+    def add_threads_interface(backtrace: nil, **options)
+      @threads = ThreadsInterface.new(**options)
+      @threads.stacktrace = initialize_stacktrace_interface(backtrace) if backtrace
+    end
+
     def add_exception_interface(exc)
       if exc.respond_to?(:sentry_context)
         @extra.merge!(exc.sentry_context)
@@ -166,7 +172,8 @@ module Sentry
         :remote_addr => env["REMOTE_ADDR"],
         :client_ip => env["HTTP_CLIENT_IP"],
         :real_ip => env["HTTP_X_REAL_IP"],
-        :forwarded_for => env["HTTP_X_FORWARDED_FOR"]
+        :forwarded_for => env["HTTP_X_FORWARDED_FOR"],
+        :trusted_proxies => configuration.trusted_proxies
       ).calculate_ip
     end
   end

data/lib/sentry/hub.rb

@@ -120,7 +120,13 @@ module Sentry
       event
     end
 
-    def add_breadcrumb(breadcrumb)
+    def add_breadcrumb(breadcrumb, hint: {})
+      if before_breadcrumb = current_client.configuration.before_breadcrumb
+        breadcrumb = before_breadcrumb.call(breadcrumb, hint)
+      end
+
+      return unless breadcrumb
+
       current_scope.add_breadcrumb(breadcrumb)
     end
 

data/lib/sentry/interface.rb

@@ -20,3 +20,4 @@ require "sentry/interfaces/exception"
 require "sentry/interfaces/request"
 require "sentry/interfaces/single_exception"
 require "sentry/interfaces/stacktrace"
+require "sentry/interfaces/threads"

data/lib/sentry/interfaces/threads.rb

@@ -0,0 +1,26 @@
+module Sentry
+  class ThreadsInterface
+    attr_accessor :stacktrace
+
+    def initialize(crashed: false)
+      @id = Thread.current.object_id
+      @name = Thread.current.name
+      @current = true
+      @crashed = crashed
+    end
+
+    def to_hash
+      {
+        values: [
+          {
+            id: @id,
+            name: @name,
+            crashed: @crashed,
+            current: @current,
+            stacktrace: @stacktrace&.to_hash
+          }
+        ]
+      }
+    end
+  end
+end

data/lib/sentry/utils/real_ip.rb

@@ -13,8 +13,8 @@ module Sentry
         "fc00::/7",       # private IPv6 range fc00::/7
         "10.0.0.0/8",     # private IPv4 range 10.x.x.x
         "172.16.0.0/12",  # private IPv4 range 172.16.0.0 .. 172.31.255.255
-        "192.168.0.0/16" # private IPv4 range 192.168.x.x
-      ].map { |proxy| IPAddr.new(proxy) }
+        "192.168.0.0/16", # private IPv4 range 192.168.x.x
+      ]
 
       attr_reader :ip
 
@@ -22,12 +22,14 @@ module Sentry
         remote_addr: nil,
         client_ip: nil,
         real_ip: nil,
-        forwarded_for: nil
+        forwarded_for: nil,
+        trusted_proxies: []
       )
         @remote_addr = remote_addr
         @client_ip = client_ip
         @real_ip = real_ip
         @forwarded_for = forwarded_for
+        @trusted_proxies = (LOCAL_ADDRESSES + Array(trusted_proxies)).map { |proxy| IPAddr.new(proxy) }.uniq
       end
 
       def calculate_ip
@@ -37,12 +39,16 @@ module Sentry
         # Could be a CSV list and/or repeated headers that were concatenated.
         client_ips    = ips_from(@client_ip)
         real_ips      = ips_from(@real_ip)
-        forwarded_ips = ips_from(@forwarded_for)
+
+        # The first address in this list is the original client, followed by
+        # the IPs of successive proxies. We want to search starting from the end
+        # until we find the first proxy that we do not trust.
+        forwarded_ips = ips_from(@forwarded_for).reverse
 
         ips = [client_ips, real_ips, forwarded_ips, remote_addr].flatten.compact
 
         # If every single IP option is in the trusted list, just return REMOTE_ADDR
-        @ip = filter_local_addresses(ips).first || remote_addr
+        @ip = filter_trusted_proxy_addresses(ips).first || remote_addr
       end
 
       protected
@@ -62,8 +68,8 @@ module Sentry
         end
       end
 
-      def filter_local_addresses(ips)
-        ips.reject { |ip| LOCAL_ADDRESSES.any? { |proxy| proxy === ip } }
+      def filter_trusted_proxy_addresses(ips)
+        ips.reject { |ip| @trusted_proxies.any? { |proxy| proxy === ip } }
       end
     end
   end

data/lib/sentry/version.rb

@@ -1,3 +1,3 @@
 module Sentry
-  VERSION = "4.1.6"
+  VERSION = "4.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-ruby-core
 version: !ruby/object:Gem::Version
-  version: 4.1.6
+  version: 4.2.0
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-02 00:00:00.000000000 Z
+date: 2021-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -78,6 +78,7 @@ files:
 - lib/sentry/interfaces/request.rb
 - lib/sentry/interfaces/single_exception.rb
 - lib/sentry/interfaces/stacktrace.rb
+- lib/sentry/interfaces/threads.rb
 - lib/sentry/linecache.rb
 - lib/sentry/logger.rb
 - lib/sentry/rack.rb