sentry-ruby-core 5.2.0 → 5.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6a629d8aa998cef5638cd40e3dc9e0ad24770d0c31540b327c669e9fb84aedd
-  data.tar.gz: e373b601b401fddca9307a32ea1dda36bc4994209c68b19748e89f128a598e80
+  metadata.gz: d28ef3b3cde342fa483586f73025f48b729b9ee09bd9835589ffa2d2d62717ff
+  data.tar.gz: 46eb28e37a955cfa60ed8ab517ab4398a89a310af7897d1543dd817e010f125e
 SHA512:
-  metadata.gz: 2cfd2f1fe582578b74bc23610931d95bf7a86c35c696c658d55fb4f40ddfdd129c36bae415bc73efef20ecfb435f33ba72e3b46a96f536c0c61692d8c8cb34e2
-  data.tar.gz: f10f71edc8bef7a57426de73e0cf2a1aea855c89ec2900a065986d33f064216f7da74c0cf9f7dd41c08dcb18224a61c6c43bad67548a327ca593b73b526e3d8a
+  metadata.gz: 693b0955dc1dacb5ea6c087e0ec2d331f51c995dd8b2adfa886fbe9b7af33c1f0a0248e750b02a85899808c34cab688cffacf6951c29e06b60336dcffc354777
+  data.tar.gz: 92b40e64205151ef7f6d530ae27fe179678824dd7f5f4cf567a8671385df076f24b1576df5e7edfb5921a230605cb447349724872f791b8b84eb6d13c050413c

data/Gemfile

@@ -1,4 +1,5 @@
 source "https://rubygems.org"
+git_source(:github) { |name| "https://github.com/#{name}.git" }
 
 gem "sentry-ruby-core", path: "./"
 gem "sentry-ruby", path: "./"

data/README.md

@@ -1,8 +1,11 @@
 <p align="center">
-  <a href="https://sentry.io" target="_blank" align="center">
-    <img src="https://sentry-brand.storage.googleapis.com/sentry-logo-black.png" width="280">
+  <a href="https://sentry.io/?utm_source=github&utm_medium=logo" target="_blank">
+    <picture>
+      <source srcset="https://sentry-brand.storage.googleapis.com/sentry-logo-white.png" media="(prefers-color-scheme: dark)" />
+      <source srcset="https://sentry-brand.storage.googleapis.com/sentry-logo-black.png" media="(prefers-color-scheme: light), (prefers-color-scheme: no-preference)" />
+      <img src="https://sentry-brand.storage.googleapis.com/sentry-logo-black.png" alt="Sentry" width="280">
+    </picture>
   </a>
-  <br />
 </p>
 
 _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/)_
@@ -29,7 +32,7 @@ If you're using `sentry-raven`, we recommend you to migrate to this new SDK. You
 
 ## Requirements
 
-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.
+We test on Ruby 2.4, 2.5, 2.6, 2.7, 3.0, and 3.1 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`.
 
@@ -52,13 +55,11 @@ gem "sentry-resque"
 
 ### Configuration
 
-You can use `Sentry.init` to initialize and configure your SDK:
-
+You need to use Sentry.init to initialize and configure your SDK:
 ```ruby
 Sentry.init do |config|
   config.dsn = "MY_DSN"
 end
-
 ```
 
 To learn more about available configuration options, please visit the [official documentation](https://docs.sentry.io/platforms/ruby/configuration/options/).

data/lib/sentry/background_worker.rb

@@ -29,7 +29,7 @@ module Sentry
           log_debug("config.background_worker_threads is set to 0, all events will be sent synchronously")
           Concurrent::ImmediateExecutor.new
         else
-          log_debug("initialized a background worker with #{@number_of_threads} threads")
+          log_debug("Initializing the background worker with #{@number_of_threads} threads")
 
           executor = Concurrent::ThreadPoolExecutor.new(
             min_threads: 0,
@@ -59,6 +59,7 @@ module Sentry
     end
 
     def shutdown
+      log_debug("Shutting down background worker")
       @shutdown_callback&.call
     end
 

data/lib/sentry/client.rb

@@ -80,9 +80,10 @@ module Sentry
 
       integration_meta = Sentry.integrations[hint[:integration]]
 
-      Event.new(configuration: configuration, integration_meta: integration_meta).tap do |event|
+      ErrorEvent.new(configuration: configuration, integration_meta: integration_meta).tap do |event|
         event.add_exception_interface(exception)
         event.add_threads_interface(crashed: true)
+        event.level = :error
       end
     end
 
@@ -94,8 +95,9 @@ module Sentry
       return unless @configuration.sending_allowed?
 
       integration_meta = Sentry.integrations[hint[:integration]]
-      event = Event.new(configuration: configuration, integration_meta: integration_meta, message: message)
+      event = ErrorEvent.new(configuration: configuration, integration_meta: integration_meta, message: message)
       event.add_threads_interface(backtrace: backtrace || caller)
+      event.level = :error
       event
     end
 
@@ -133,7 +135,7 @@ module Sentry
 
       event
     rescue => e
-      loggable_event_type = (event_type || "event").capitalize
+      loggable_event_type = event_type.capitalize
       log_error("#{loggable_event_type} sending failed", e, debug: configuration.debug)
 
       event_info = Event.get_log_message(event.to_hash)
@@ -174,8 +176,7 @@ module Sentry
         async_block.call(event_hash)
       end
     rescue => e
-      loggable_event_type = event_hash["type"] || "event"
-      log_error("Async #{loggable_event_type} sending failed", e, debug: configuration.debug)
+      log_error("Async #{event_hash["type"]} sending failed", e, debug: configuration.debug)
       send_event(event, hint)
     end
   end

data/lib/sentry/configuration.rb

@@ -290,6 +290,16 @@ module Sentry
     def async=(value)
       check_callable!("async", value)
 
+      log_warn <<~MSG
+
+        sentry-ruby now sends events asynchronously by default with its background worker (supported since 4.1.0).
+        The `config.async` callback has become redundant while continuing to cause issues.
+        (The problems of `async` are detailed in https://github.com/getsentry/sentry-ruby/issues/1522)
+
+        Therefore, we encourage you to remove it and let the background worker take care of async job sending.
+      It's deprecation is planned in the next major release (6.0), which is scheduled around the 3rd quarter of 2022.
+      MSG
+
       @async = value
     end
 

data/lib/sentry/error_event.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Sentry
+  # ErrorEvent represents error or normal message events.
+  class ErrorEvent < Event
+    # @return [ExceptionInterface]
+    attr_reader :exception
+
+    # @return [ThreadsInterface]
+    attr_reader :threads
+
+    # @return [Hash]
+    def to_hash
+      data = super
+      data[:threads] = threads.to_hash if threads
+      data[:exception] = exception.to_hash if exception
+      data
+    end
+
+    # @!visibility private
+    def add_threads_interface(backtrace: nil, **options)
+      @threads = ThreadsInterface.build(
+        backtrace: backtrace,
+        stacktrace_builder: @stacktrace_builder,
+        **options
+      )
+    end
+
+    # @!visibility private
+    def add_exception_interface(exception)
+      if exception.respond_to?(:sentry_context)
+        @extra.merge!(exception.sentry_context)
+      end
+
+      @exception = Sentry::ExceptionInterface.build(exception: exception, stacktrace_builder: @stacktrace_builder)
+    end
+  end
+end

data/lib/sentry/event.rb

@@ -9,7 +9,10 @@ require 'sentry/utils/request_id'
 require 'sentry/utils/custom_inspection'
 
 module Sentry
+  # This is an abstract class that defines the shared attributes of an event.
+  # Please don't use it directly. The user-facing classes are its child classes.
   class Event
+    TYPE = "event"
     # These are readable attributes.
     SERIALIZEABLE_ATTRIBUTES = %i(
       event_id level timestamp
@@ -35,12 +38,6 @@ module Sentry
     # @return [RequestInterface]
     attr_reader :request
 
-    # @return [ExceptionInterface]
-    attr_reader :exception
-
-    # @return [ThreadsInterface]
-    attr_reader :threads
-
     # @param configuration [Configuration]
     # @param integration_meta [Hash, nil]
     # @param message [String, nil]
@@ -49,6 +46,7 @@ module Sentry
       @event_id      = SecureRandom.uuid.delete("-")
       @timestamp     = Sentry.utc_now.iso8601
       @platform      = :ruby
+      @type          = self.class::TYPE
       @sdk           = integration_meta || Sentry.sdk_meta
 
       @user          = {}
@@ -71,8 +69,6 @@ module Sentry
       @rack_env_whitelist = configuration.rack_env_whitelist
 
       @message = (message || "").byteslice(0..MAX_MESSAGE_SIZE_IN_BYTES)
-
-      self.level = :error
     end
 
     class << self
@@ -146,9 +142,6 @@ module Sentry
       data = serialize_attributes
       data[:breadcrumbs] = breadcrumbs.to_hash if breadcrumbs
       data[:request] = request.to_hash if request
-      data[:exception] = exception.to_hash if exception
-      data[:threads] = threads.to_hash if threads
-
       data
     end
 
@@ -157,24 +150,6 @@ module Sentry
       JSON.parse(JSON.generate(to_hash))
     end
 
-    # @!visibility private
-    def add_threads_interface(backtrace: nil, **options)
-      @threads = ThreadsInterface.build(
-        backtrace: backtrace,
-        stacktrace_builder: @stacktrace_builder,
-        **options
-      )
-    end
-
-    # @!visibility private
-    def add_exception_interface(exception)
-      if exception.respond_to?(:sentry_context)
-        @extra.merge!(exception.sentry_context)
-      end
-
-      @exception = Sentry::ExceptionInterface.build(exception: exception, stacktrace_builder: @stacktrace_builder)
-    end
-
     private
 
     def add_request_interface(env)

data/lib/sentry/hub.rb

@@ -150,7 +150,7 @@ module Sentry
         configuration.log_debug(event.to_json_compatible)
       end
 
-      @last_event_id = event&.event_id
+      @last_event_id = event&.event_id unless event.is_a?(Sentry::TransactionEvent)
       event
     end
 

data/lib/sentry/net/http.rb

@@ -74,11 +74,11 @@ module Sentry
       end
 
       def start_sentry_span
-        return unless Sentry.initialized? && transaction = Sentry.get_current_scope.get_transaction
+        return unless Sentry.initialized? && span = Sentry.get_current_scope.get_span
         return if from_sentry_sdk?
-        return if transaction.sampled == false
+        return if span.sampled == false
 
-        transaction.start_child(op: OP_NAME, start_timestamp: Sentry.utc_now.to_f)
+        span.start_child(op: OP_NAME, start_timestamp: Sentry.utc_now.to_f)
       end
 
       def finish_sentry_span(sentry_span)

data/lib/sentry/session_flusher.rb

@@ -39,6 +39,7 @@ module Sentry
     end
 
     def kill
+      log_debug("Killing session flusher")
       @thread&.kill
     end
 

data/lib/sentry/transaction_event.rb

@@ -1,31 +1,15 @@
 # frozen_string_literal: true
 
 module Sentry
+  # TransactionEvent represents events that carry transaction data (type: "transaction").
   class TransactionEvent < Event
     TYPE = "transaction"
 
-    SERIALIZEABLE_ATTRIBUTES = %i(
-      event_id level timestamp start_timestamp
-      release environment server_name modules
-      user tags contexts extra
-      transaction platform sdk type
-    )
-
-    WRITER_ATTRIBUTES = SERIALIZEABLE_ATTRIBUTES - %i(type timestamp start_timestamp level)
-
-    attr_writer(*WRITER_ATTRIBUTES)
-    attr_reader(*SERIALIZEABLE_ATTRIBUTES)
-
     # @return [<Array[Span]>]
     attr_accessor :spans
 
-    # @param configuration [Configuration]
-    # @param integration_meta [Hash, nil]
-    # @param message [String, nil]
-    def initialize(configuration:, integration_meta: nil, message: nil)
-      super
-      @type = TYPE
-    end
+    # @return [Float, nil]
+    attr_reader :start_timestamp
 
     # Sets the event's start_timestamp.
     # @param time [Time, Float]
@@ -38,6 +22,7 @@ module Sentry
     def to_hash
       data = super
       data[:spans] = @spans.map(&:to_hash) if @spans
+      data[:start_timestamp] = @start_timestamp
       data
     end
   end

data/lib/sentry/transport/http_transport.rb

@@ -130,7 +130,7 @@ module Sentry
       server = URI(@dsn.server)
 
       connection =
-        if proxy = @transport_configuration.proxy
+        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, nil)
@@ -148,6 +148,20 @@ module Sentry
       connection
     end
 
+    def normalize_proxy(proxy)
+      return proxy unless proxy
+
+      case proxy
+      when String
+        uri = URI(proxy)
+        { uri: uri, user: uri.user, password: uri.password }
+      when URI
+        { uri: proxy, user: proxy.user, password: proxy.password }
+      when Hash
+        proxy
+      end
+    end
+
     def ssl_configuration
       configuration = {
         verify: @transport_configuration.ssl_verification,

data/lib/sentry/transport.rb

@@ -73,7 +73,12 @@ module Sentry
         result = item.to_s
 
         if result.bytesize > Event::MAX_SERIALIZED_PAYLOAD_SIZE
-          item.payload.delete(:breadcrumbs)
+          if item.payload.key?(:breadcrumbs)
+            item.payload.delete(:breadcrumbs)
+          elsif item.payload.key?("breadcrumbs")
+            item.payload.delete("breadcrumbs")
+          end
+
           result = item.to_s
         end
 
@@ -143,7 +148,7 @@ module Sentry
       # Convert to hash
       event_payload = event.to_hash
       event_id = event_payload[:event_id] || event_payload["event_id"]
-      item_type = get_item_type(event_payload)
+      item_type = event_payload[:type] || event_payload["type"]
 
       envelope = Envelope.new(
         {
@@ -169,16 +174,11 @@ module Sentry
       return unless @send_client_reports
       return unless CLIENT_REPORT_REASONS.include?(reason)
 
-      item_type ||= 'event'
       @discarded_events[[reason, item_type]] += 1
     end
 
     private
 
-    def get_item_type(event_hash)
-      event_hash[:type] || event_hash["type"] || "event"
-    end
-
     def fetch_pending_client_report
       return nil unless @send_client_reports
       return nil if @last_client_report_sent > Time.now - CLIENT_REPORT_INTERVAL

data/lib/sentry/version.rb

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

data/lib/sentry-ruby.rb

@@ -12,6 +12,7 @@ require "sentry/utils/logging_helper"
 require "sentry/configuration"
 require "sentry/logger"
 require "sentry/event"
+require "sentry/error_event"
 require "sentry/transaction_event"
 require "sentry/span"
 require "sentry/transaction"
@@ -99,6 +100,14 @@ module Sentry
     # @param name [String] name of the integration
     # @param version [String] version of the integration
     def register_integration(name, version)
+      if initialized?
+        logger.warn(LOGGER_PROGNAME) do
+          <<~MSG
+            Integration '#{name}' is loaded after the SDK is initialized, which can cause unexpected behavior.  Please make sure all integrations are loaded before SDK initialization.
+          MSG
+        end
+      end
+
       meta = { name: "sentry.ruby.#{name}", version: version }.freeze
       integrations[name.to_s] = meta
     end
@@ -376,6 +385,38 @@ module Sentry
       get_current_hub.start_transaction(**options)
     end
 
+    # Records the block's execution as a child of the current span.
+    # If the current scope doesn't have a span, the block would still be executed but the yield param will be nil.
+    # @param attributes [Hash] attributes for the child span.
+    # @yieldparam child_span [Span, nil]
+    # @return yield result
+    #
+    # @example
+    #   Sentry.with_child_span(op: "my operation") do |child_span|
+    #     child_span.set_data(operation_data)
+    #     child_span.set_description(operation_detail)
+    #     # result will be returned
+    #   end
+    #
+    def with_child_span(**attributes, &block)
+      if Sentry.initialized? && current_span = get_current_scope.get_span
+        result = nil
+
+        begin
+          current_span.with_child_span(**attributes) do |child_span|
+            get_current_scope.set_span(child_span)
+            result = yield(child_span)
+          end
+        ensure
+          get_current_scope.set_span(current_span)
+        end
+
+        result
+      else
+        yield(nil)
+      end
+    end
+
     # Returns the id of the lastly reported Sentry::Event.
     #
     # @return [String, nil]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-ruby-core
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.3.1
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-08 00:00:00.000000000 Z
+date: 2022-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -56,6 +56,7 @@ files:
 - lib/sentry/core_ext/object/duplicable.rb
 - lib/sentry/dsn.rb
 - lib/sentry/envelope.rb
+- lib/sentry/error_event.rb
 - lib/sentry/event.rb
 - lib/sentry/exceptions.rb
 - lib/sentry/hub.rb