sentry-ruby 5.14.0 → 5.15.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95fd53222ce5360d32645f0bc7577792bdef0a02b9e4b8de27555eabd2ef1844
-  data.tar.gz: e5eb696315a22747051e5bbdeac314c5ae103cabd59d3fb266b16b0b22345611
+  metadata.gz: 76add924de8ccd4132764766cf92d057a7e4ee9554790688e2c2597b569097c2
+  data.tar.gz: 856d0936cb2ad123b3ca632e63cb8cf951e13f90755386dcb67b3cc63760ee69
 SHA512:
-  metadata.gz: f18df0d05208c0a03352501b4b746f6ccc74799b234198b67b35e709539fde52aa36c56a6297510e8e9e1dc8a62658ac5d81e0023c5935de455effc16ee824fe
-  data.tar.gz: 47f5db68454ab971d92df8c7fbd95846830edfe09b6b2ea40fef1f5ab39a9db922a5564abe45b29fb55df729bdf53bb1632c566c93b8b7f0d1c96e00c441d0dc
+  metadata.gz: 245ee7955da8f38b12db8e2ed18802fbb63a74efd5853968a91fe5e45551f17aa0dd95e8dd07458e1374817b33b3cfc6ab752406fea9f16f55a4027d204d622b
+  data.tar.gz: 7fd7cadec651b7464409154ed26eb41852bb2cfbf89bb3f57cecc102058a9b8498bf9f29670ebcd6c25048a1a353878adaadc8a8c1b816baf5b08baf0c380e54

data/Gemfile

@@ -12,28 +12,9 @@ gem "redis", "~> #{redis_rb_version}"
 
 gem "puma"
 
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"
-gem "rspec-retry"
 gem "timecop"
-gem "simplecov"
-gem "simplecov-cobertura", "~> 1.4"
-gem "rexml"
 gem "stackprof" unless RUBY_PLATFORM == "java"
 
-ruby_version = Gem::Version.new(RUBY_VERSION)
-
-if ruby_version >= Gem::Version.new("2.6.0")
-  gem "debug", github: "ruby/debug", platform: :ruby
-  gem "irb"
-
-  if ruby_version >= Gem::Version.new("3.0.0")
-    gem "ruby-lsp-rspec"
-  end
-end
-
-gem "pry"
-
 gem "benchmark-ips"
 gem "benchmark_driver"
 gem "benchmark-ipsa"
@@ -41,3 +22,5 @@ gem "benchmark-memory"
 
 gem "yard", github: "lsegal/yard"
 gem "webrick"
+
+eval_gemfile File.expand_path("../Gemfile", __dir__)

data/lib/sentry/background_worker.rb

@@ -13,10 +13,12 @@ module Sentry
     attr_reader :logger
     attr_accessor :shutdown_timeout
 
+    DEFAULT_MAX_QUEUE = 30
+
     def initialize(configuration)
-      @max_queue = 30
       @shutdown_timeout = 1
       @number_of_threads = configuration.background_worker_threads
+      @max_queue = configuration.background_worker_max_queue
       @logger = configuration.logger
       @debug = configuration.debug
       @shutdown_callback = nil

data/lib/sentry/client.rb

@@ -10,6 +10,10 @@ module Sentry
     # @return [Transport]
     attr_reader :transport
 
+    # The Transport object that'll send events for the client.
+    # @return [SpotlightTransport, nil]
+    attr_reader :spotlight_transport
+
     # @!macro configuration
     attr_reader :configuration
 
@@ -32,6 +36,8 @@ module Sentry
             DummyTransport.new(configuration)
           end
       end
+
+      @spotlight_transport = SpotlightTransport.new(configuration) if configuration.spotlight
     end
 
     # Applies the given scope's data to the event and sends it to Sentry.
@@ -167,6 +173,7 @@ module Sentry
       end
 
       transport.send_event(event)
+      spotlight_transport&.send_event(event)
 
       event
     rescue => e

data/lib/sentry/configuration.rb

@@ -40,6 +40,13 @@ module Sentry
     # @return [Integer]
     attr_accessor :background_worker_threads
 
+    # The maximum queue size for the background worker.
+    # Jobs will be rejected above this limit.
+    #
+    # Default is {BackgroundWorker::DEFAULT_MAX_QUEUE}.
+    # @return [Integer]
+    attr_accessor :background_worker_max_queue
+
     # a proc/lambda that takes an array of stack traces
     # it'll be used to silence (reduce) backtrace of the exception
     #
@@ -142,6 +149,14 @@ module Sentry
     # @return [Boolean]
     attr_accessor :include_local_variables
 
+    # Whether to capture events and traces into Spotlight. Default is false.
+    # If you set this to true, Sentry will send events and traces to the local
+    # Sidecar proxy at http://localhost:8969/stream.
+    # If you want to use a different Sidecar proxy address, set this to String
+    # with the proxy URL.
+    # @return [Boolean, String]
+    attr_accessor :spotlight
+
     # @deprecated Use {#include_local_variables} instead.
     alias_method :capture_exception_frame_locals, :include_local_variables
 
@@ -321,6 +336,7 @@ module Sentry
       self.app_dirs_pattern = nil
       self.debug = false
       self.background_worker_threads = Concurrent.processor_count
+      self.background_worker_max_queue = BackgroundWorker::DEFAULT_MAX_QUEUE
       self.backtrace_cleanup_callback = nil
       self.max_breadcrumbs = BreadcrumbBuffer::DEFAULT_SIZE
       self.breadcrumbs_logger = []
@@ -344,6 +360,7 @@ module Sentry
       self.auto_session_tracking = true
       self.trusted_proxies = []
       self.dsn = ENV['SENTRY_DSN']
+      self.spotlight = false
       self.server_name = server_name_from_env
       self.instrumenter = :sentry
       self.trace_propagation_targets = [PROPAGATION_TARGETS_MATCH_ALL]
@@ -451,7 +468,7 @@ module Sentry
     def sending_allowed?
       @errors = []
 
-      valid? && capture_in_environment?
+      spotlight || (valid? && capture_in_environment?)
     end
 
     def sample_allowed?

data/lib/sentry/cron/monitor_check_ins.rb

@@ -4,7 +4,7 @@ module Sentry
       MAX_SLUG_LENGTH = 50
 
       module Patch
-        def perform(*args)
+        def perform(*args, **opts)
           slug = self.class.sentry_monitor_slug
           monitor_config = self.class.sentry_monitor_config
 
@@ -13,7 +13,8 @@ module Sentry
                                                 monitor_config: monitor_config)
 
           start = Sentry.utc_now.to_i
-          ret = super
+          # need to do this on ruby <= 2.6 sadly
+          ret = method(:perform).super_method.arity == 0 ? super() : super
           duration = Sentry.utc_now.to_i - start
 
           Sentry.capture_check_in(slug,
@@ -44,7 +45,7 @@ module Sentry
           prepend Patch
         end
 
-        def sentry_monitor_slug
+        def sentry_monitor_slug(name: self.name)
           @sentry_monitor_slug ||= begin
             slug = name.gsub('::', '-').downcase
             slug[-MAX_SLUG_LENGTH..-1] || slug

data/lib/sentry/transport/http_transport.rb

@@ -14,11 +14,19 @@ module Sentry
     RATE_LIMIT_HEADER = "x-sentry-rate-limits"
     USER_AGENT = "sentry-ruby/#{Sentry::VERSION}"
 
+    # The list of errors ::Net::HTTP is known to raise
+    # See https://github.com/ruby/ruby/blob/b0c639f249165d759596f9579fa985cb30533de6/lib/bundler/fetcher.rb#L281-L286
+    HTTP_ERRORS = [
+      Timeout::Error, EOFError, SocketError, Errno::ENETDOWN, Errno::ENETUNREACH,
+      Errno::EINVAL, Errno::ECONNRESET, Errno::ETIMEDOUT, Errno::EAGAIN,
+      Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError,
+      Zlib::BufError, Errno::EHOSTUNREACH, Errno::ECONNREFUSED
+    ].freeze
+
+
     def initialize(*args)
       super
-      @endpoint = @dsn.envelope_endpoint
-
-      log_debug("Sentry HTTP Transport will connect to #{@dsn.server}")
+      log_debug("Sentry HTTP Transport will connect to #{@dsn.server}") if @dsn
     end
 
     def send_data(data)
@@ -32,12 +40,14 @@ module Sentry
       headers = {
         'Content-Type' => CONTENT_TYPE,
         'Content-Encoding' => encoding,
-        'X-Sentry-Auth' => generate_auth_header,
         'User-Agent' => USER_AGENT
       }
 
+      auth_header = generate_auth_header
+      headers['X-Sentry-Auth'] = auth_header if auth_header
+
       response = conn.start do |http|
-        request = ::Net::HTTP::Post.new(@endpoint, headers)
+        request = ::Net::HTTP::Post.new(endpoint, headers)
         request.body = data
         http.request(request)
       end
@@ -58,8 +68,52 @@ module Sentry
 
         raise Sentry::ExternalError, error_info
       end
-    rescue SocketError => e
-      raise Sentry::ExternalError.new(e.message)
+    rescue SocketError, *HTTP_ERRORS => e
+      on_error if respond_to?(:on_error)
+      raise Sentry::ExternalError.new(e&.message)
+    end
+
+    def endpoint
+      @dsn.envelope_endpoint
+    end
+
+    def generate_auth_header
+      return nil unless @dsn
+
+      now = Sentry.utc_now.to_i
+      fields = {
+        'sentry_version' => PROTOCOL_VERSION,
+        'sentry_client' => USER_AGENT,
+        'sentry_timestamp' => now,
+        'sentry_key' => @dsn.public_key
+      }
+      fields['sentry_secret'] = @dsn.secret_key if @dsn.secret_key
+      'Sentry ' + fields.map { |key, value| "#{key}=#{value}" }.join(', ')
+    end
+
+    def conn
+      server = URI(@dsn.server)
+
+      # connection respects proxy setting from @transport_configuration, or environment variables (HTTP_PROXY, HTTPS_PROXY, NO_PROXY)
+      # Net::HTTP will automatically read the env vars.
+      # See https://ruby-doc.org/3.2.2/stdlibs/net/Net/HTTP.html#class-Net::HTTP-label-Proxies
+      connection =
+        if proxy = normalize_proxy(@transport_configuration.proxy)
+          ::Net::HTTP.new(server.hostname, server.port, proxy[:uri].hostname, proxy[:uri].port, proxy[:user], proxy[:password])
+        else
+          ::Net::HTTP.new(server.hostname, server.port)
+        end
+
+      connection.use_ssl = server.scheme == "https"
+      connection.read_timeout = @transport_configuration.timeout
+      connection.write_timeout = @transport_configuration.timeout if connection.respond_to?(:write_timeout)
+      connection.open_timeout = @transport_configuration.open_timeout
+
+      ssl_configuration.each do |key, value|
+        connection.send("#{key}=", value)
+      end
+
+      connection
     end
 
     private
@@ -126,31 +180,6 @@ module Sentry
       @transport_configuration.encoding == GZIP_ENCODING && data.bytesize >= GZIP_THRESHOLD
     end
 
-    def conn
-      server = URI(@dsn.server)
-      
-      # connection respects proxy setting from @transport_configuration, or environment variables (HTTP_PROXY, HTTPS_PROXY, NO_PROXY)
-      # Net::HTTP will automatically read the env vars.
-      # See https://ruby-doc.org/3.2.2/stdlibs/net/Net/HTTP.html#class-Net::HTTP-label-Proxies
-      connection =
-        if proxy = normalize_proxy(@transport_configuration.proxy)
-          ::Net::HTTP.new(server.hostname, server.port, proxy[:uri].hostname, proxy[:uri].port, proxy[:user], proxy[:password])
-        else
-          ::Net::HTTP.new(server.hostname, server.port)
-        end
-
-      connection.use_ssl = server.scheme == "https"
-      connection.read_timeout = @transport_configuration.timeout
-      connection.write_timeout = @transport_configuration.timeout if connection.respond_to?(:write_timeout)
-      connection.open_timeout = @transport_configuration.open_timeout
-
-      ssl_configuration.each do |key, value|
-        connection.send("#{key}=", value)
-      end
-
-      connection
-    end
-
     # @param proxy [String, URI, Hash] Proxy config value passed into `config.transport`.
     #   Accepts either a URI formatted string, URI, or a hash with the `uri`, `user`, and `password` keys.
     # @return [Hash] Normalized proxy config that will be passed into `Net::HTTP`

data/lib/sentry/transport/spotlight_transport.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "zlib"
+
+module Sentry
+  # Designed to just report events to Spotlight in development.
+  class SpotlightTransport < HTTPTransport
+    DEFAULT_SIDECAR_URL = "http://localhost:8969/stream"
+    MAX_FAILED_REQUESTS = 3
+
+    def initialize(configuration)
+      super
+      @sidecar_url = configuration.spotlight.is_a?(String) ? configuration.spotlight : DEFAULT_SIDECAR_URL
+      @failed = 0
+      @logged = false
+
+      log_debug("[Spotlight] initialized for url #{@sidecar_url}")
+    end
+
+    def endpoint
+      "/stream"
+    end
+
+    def send_data(data)
+      if @failed >= MAX_FAILED_REQUESTS
+        unless @logged
+          log_debug("[Spotlight] disabling because of too many request failures")
+          @logged = true
+        end
+
+        return
+      end
+
+      super
+    end
+
+    def on_error
+      @failed += 1
+    end
+
+    # Similar to HTTPTransport connection, but does not support Proxy and SSL
+    def conn
+      sidecar = URI(@sidecar_url)
+      connection = ::Net::HTTP.new(sidecar.hostname, sidecar.port, nil)
+      connection.use_ssl = false
+      connection
+    end
+  end
+end

data/lib/sentry/transport.rb

@@ -119,18 +119,6 @@ module Sentry
       !!delay && delay > Time.now
     end
 
-    def generate_auth_header
-      now = Sentry.utc_now.to_i
-      fields = {
-        'sentry_version' => PROTOCOL_VERSION,
-        'sentry_client' => USER_AGENT,
-        'sentry_timestamp' => now,
-        'sentry_key' => @dsn.public_key
-      }
-      fields['sentry_secret'] = @dsn.secret_key if @dsn.secret_key
-      'Sentry ' + fields.map { |key, value| "#{key}=#{value}" }.join(', ')
-    end
-
     def envelope_from_event(event)
       # Convert to hash
       event_payload = event.to_hash
@@ -220,3 +208,4 @@ end
 
 require "sentry/transport/dummy_transport"
 require "sentry/transport/http_transport"
+require "sentry/transport/spotlight_transport"

data/lib/sentry/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sentry
-  VERSION = "5.14.0"
+  VERSION = "5.15.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-ruby
 version: !ruby/object:Gem::Version
-  version: 5.14.0
+  version: 5.15.1
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-27 00:00:00.000000000 Z
+date: 2023-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -100,6 +100,7 @@ files:
 - lib/sentry/transport/configuration.rb
 - lib/sentry/transport/dummy_transport.rb
 - lib/sentry/transport/http_transport.rb
+- lib/sentry/transport/spotlight_transport.rb
 - lib/sentry/utils/argument_checking_helper.rb
 - lib/sentry/utils/custom_inspection.rb
 - lib/sentry/utils/encoding_helper.rb