sentry-ruby 6.6.2 → 6.7.0

data/lib/sentry/scope.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "set"
 require "sentry/breadcrumb_buffer"
 require "sentry/propagation_context"
 require "sentry/attachment"
@@ -24,7 +25,8 @@ module Sentry
       :span,
       :session,
       :attachments,
-      :propagation_context
+      :propagation_context,
+      :attributes
     ]
 
     attr_reader(*ATTRIBUTES)
@@ -84,7 +86,15 @@ module Sentry
     # @param telemetry [MetricEvent, LogEvent] the telemetry event to apply scope context to
     # @return [MetricEvent, LogEvent] the telemetry event with scope context applied
     def apply_to_telemetry(telemetry)
-      # TODO-neel when new scope set_attribute api is added: add them here
+      # Compare as strings since String and Symbol keys serialize to the same wire key.
+      existing_keys = telemetry.attributes.keys.map(&:to_s).to_set
+
+      attributes.each do |key, value|
+        next if existing_keys.include?(key)
+
+        telemetry.attributes[key] = value
+      end
+
       trace_context = get_trace_context
       telemetry.trace_id = trace_context[:trace_id]
       telemetry.span_id = trace_context[:span_id]
@@ -136,6 +146,7 @@ module Sentry
       copy.propagation_context = propagation_context.deep_dup
       copy.attachments = attachments.dup
       copy.event_processors = event_processors.dup
+      copy.attributes = attributes.deep_dup
       copy
     end
 
@@ -154,11 +165,12 @@ module Sentry
       self.span = scope.span
       self.propagation_context = scope.propagation_context
       self.attachments = scope.attachments
+      self.attributes = scope.attributes
     end
 
     # Updates the scope's data from the given options.
     # @param contexts [Hash]
-    # @param extras [Hash]
+    # @param extra [Hash]
     # @param tags [Hash]
     # @param user [Hash]
     # @param level [String, Symbol]
@@ -256,6 +268,32 @@ module Sentry
       set_contexts(key => value)
     end
 
+    # Updates the scope's attributes by merging with the old value.
+    # @param attributes_hash [Hash]
+    # @return [Hash]
+    def set_attributes(attributes_hash)
+      check_argument_type!(attributes_hash, Hash)
+      attributes_hash.each { |key, value| @attributes[key.to_s] = value }
+      @attributes
+    end
+
+    # Sets a single attribute on the scope.
+    # @param key [String, Symbol]
+    # @param value [Object]
+    # @param unit [String, Symbol, nil] an optional measurement unit for the value
+    # @return [Hash]
+    def set_attribute(key, value, unit: nil)
+      value = { value: value, unit: unit } unless unit.nil?
+      set_attributes(key => value)
+    end
+
+    # Removes a single attribute from the scope. No-op if the attribute is not set.
+    # @param key [String, Symbol]
+    # @return [void]
+    def remove_attribute(key)
+      @attributes.delete(key.to_s)
+    end
+
     # Sets the scope's level attribute.
     # @param level [String, Symbol]
     # @return [void]
@@ -361,6 +399,7 @@ module Sentry
       @span = nil
       @session = nil
       @attachments = []
+      @attributes = {}
       generate_propagation_context
       set_new_breadcrumb_buffer
     end

data/lib/sentry/span.rb

@@ -45,6 +45,7 @@ module Sentry
       FUNCTION = "code.function"
       NAMESPACE = "code.namespace"
 
+      MESSAGING_SYSTEM = "messaging.system"
       MESSAGING_MESSAGE_ID = "messaging.message.id"
       MESSAGING_DESTINATION_NAME = "messaging.destination.name"
       MESSAGING_MESSAGE_RECEIVE_LATENCY = "messaging.message.receive.latency"

data/lib/sentry/telemetry_event_buffer.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "json"
 require "sentry/threaded_periodic_worker"
 require "sentry/envelope"
 
@@ -58,7 +59,11 @@ module Sentry
 
         if size >= @max_items_before_drop
           log_debug("[#{self.class}] exceeded max capacity, dropping event")
-          @client.transport.record_lost_event(:queue_overflow, @data_category)
+          @client.transport.record_lost_event(
+            :queue_overflow,
+            @data_category,
+            num_bytes: JSON.generate(item.to_h).bytesize
+          )
         else
           @pending_items << item
         end
@@ -92,6 +97,7 @@ module Sentry
       )
 
       discarded_count = 0
+      discarded_bytes = 0
       envelope_items = []
 
       if @before_send
@@ -102,6 +108,7 @@ module Sentry
             envelope_items << processed_item.to_h
           else
             discarded_count += 1
+            discarded_bytes += JSON.generate(item.to_h).bytesize
           end
         end
       else
@@ -109,7 +116,7 @@ module Sentry
       end
 
       unless discarded_count.zero?
-        @client.transport.record_lost_event(:before_send, @data_category, num: discarded_count)
+        @client.transport.record_lost_event(:before_send, @data_category, num: discarded_count, num_bytes: discarded_bytes)
       end
 
       return if envelope_items.empty?

data/lib/sentry/test_helper.rb

@@ -52,10 +52,10 @@ module Sentry
       test_client = Sentry::Client.new(dummy_config.dup)
       main_hub.bind_client(test_client)
 
-      # Realign the current thread's hub with the main hub so direct
+      # Realign the current execution context's hub with the main hub so direct
       # `sentry_events` reads and any hub the Rack middleware clones from the
       # main hub all observe the same DummyTransport.
-      Thread.current.thread_variable_set(Sentry::THREAD_LOCAL, main_hub)
+      Sentry.set_current_hub_internal(main_hub)
     end
 
     # Clears all stored events and envelopes.
@@ -159,10 +159,13 @@ module Sentry
         # Don't check initialized? because sometimes we stub it in tests
         if Sentry.instance_variable_defined?(:@main_hub)
           Sentry::GLOBALS.each do |var|
+            worker = Sentry.instance_variable_get(:"@#{var}")
+            worker.kill if worker.respond_to?(:kill)
+
             Sentry.instance_variable_set(:"@#{var}", nil)
           end
 
-          Thread.current.thread_variable_set(Sentry::THREAD_LOCAL, nil)
+          Sentry.set_current_hub_internal(nil)
         end
       end
     end

data/lib/sentry/threaded_periodic_worker.rb

@@ -30,10 +30,15 @@ module Sentry
     end
 
     def kill
-      log_debug("[#{self.class.name}] thread killed")
-
       @exited = true
-      @thread&.kill
+
+      # Only a started worker has a thread to kill (and to log about).
+      # Guarding here keeps a never-started worker's teardown silent, so
+      # killing one during test reset can't emit a stray debug line.
+      return unless @thread
+
+      log_debug("[#{self.class.name}] thread killed")
+      @thread.kill
     end
   end
 end

data/lib/sentry/transport.rb

@@ -64,7 +64,7 @@ module Sentry
       end
     rescue Sentry::SizeExceededError
       serialized_items&.each do |item|
-        record_lost_event(:send_error, item.data_category)
+        record_lost_event(:send_error, item.data_category, num: item.item_count, num_bytes: item.lost_event_byte_size)
       end
     end
 
@@ -167,11 +167,16 @@ module Sentry
       envelope
     end
 
-    def record_lost_event(reason, data_category, num: 1)
+    def record_lost_event(reason, data_category, num: 1, num_bytes: nil)
       return unless @send_client_reports
       return unless CLIENT_REPORT_REASONS.include?(reason)
 
       @discarded_events[[reason, data_category]] += num
+
+      return unless num_bytes
+
+      byte_category = Envelope::Item.byte_data_category(data_category)
+      @discarded_events[[reason, byte_category]] += num_bytes if byte_category
     end
 
     def flush
@@ -211,7 +216,13 @@ module Sentry
       envelope.items.reject! do |item|
         if is_rate_limited?(item.data_category)
           log_debug("[Transport] Envelope item [#{item.type}] not sent: rate limiting")
-          record_lost_event(:ratelimit_backoff, item.data_category)
+
+          record_lost_event(
+            :ratelimit_backoff,
+            item.data_category,
+            num: item.item_count,
+            num_bytes: item.lost_event_byte_size
+          )
 
           true
         else

data/lib/sentry/utils/telemetry_attributes.rb

@@ -7,23 +7,35 @@ module Sentry
     module TelemetryAttributes
       private
 
-      def attribute_hash(value)
-        case value
-        when String
-          { value: value, type: "string" }
-        when TrueClass, FalseClass
-          { value: value, type: "boolean" }
-        when Integer
-          { value: value, type: "integer" }
-        when Float
-          { value: value, type: "double" }
+      def attribute_hash(raw_value)
+        if raw_value.is_a?(Hash) && (raw_value.key?(:value) || raw_value.key?("value"))
+          value = raw_value.key?(:value) ? raw_value[:value] : raw_value["value"]
+          unit = raw_value.key?(:unit) ? raw_value[:unit] : raw_value["unit"]
         else
-          begin
-            { value: JSON.generate(value), type: "string" }
-          rescue
+          value = raw_value
+          unit = nil
+        end
+
+        result =
+          case value
+          when String
             { value: value, type: "string" }
+          when TrueClass, FalseClass
+            { value: value, type: "boolean" }
+          when Integer
+            { value: value, type: "integer" }
+          when Float
+            { value: value, type: "double" }
+          else
+            begin
+              { value: JSON.generate(value), type: "string" }
+            rescue
+              { value: value, type: "string" }
+            end
           end
-        end
+
+        result[:unit] = unit.to_s if unit.is_a?(String) || unit.is_a?(Symbol)
+        result
       end
     end
   end

data/lib/sentry/version.rb

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

data/lib/sentry-ruby.rb

@@ -220,6 +220,35 @@ module Sentry
       get_current_scope.set_context(*args)
     end
 
+    # @!method set_attributes
+    #   Updates the current scope's attributes by merging with the old value.
+    #   @param attributes_hash [Hash]
+    #   @return [Hash]
+    def set_attributes(attributes_hash)
+      return unless initialized?
+      get_current_scope.set_attributes(attributes_hash)
+    end
+
+    # @!method set_attribute
+    #   Sets a single attribute on the current scope.
+    #   @param key [String, Symbol]
+    #   @param value [Object]
+    #   @param unit [String, Symbol, nil] an optional measurement unit for the value
+    #   @return [Hash]
+    def set_attribute(key, value, unit: nil)
+      return unless initialized?
+      get_current_scope.set_attribute(key, value, unit: unit)
+    end
+
+    # @!method remove_attribute
+    #   Removes a single attribute from the current scope.
+    #   @param key [String, Symbol]
+    #   @return [void]
+    def remove_attribute(key)
+      return unless initialized?
+      get_current_scope.remove_attribute(key)
+    end
+
     # @!method add_attachment
     #   @!macro add_attachment
     def add_attachment(**opts)
@@ -242,7 +271,8 @@ module Sentry
       client = Client.new(config)
       scope = Scope.new(max_breadcrumbs: config.max_breadcrumbs)
       hub = Hub.new(client, scope)
-      Thread.current.thread_variable_set(THREAD_LOCAL, hub)
+      @hub_isolation_level = config.hub_isolation_level
+      set_current_hub_internal(hub)
       @main_hub = hub
       @background_worker = Sentry::BackgroundWorker.new(config)
       @session_flusher = config.session_tracking? ? Sentry::SessionFlusher.new(config, client) : nil
@@ -280,7 +310,7 @@ module Sentry
 
       MUTEX.synchronize do
         @main_hub = nil
-        Thread.current.thread_variable_set(THREAD_LOCAL, nil)
+        set_current_hub_internal(nil)
       end
     end
 
@@ -333,7 +363,7 @@ module Sentry
       # ideally, we should do this proactively whenever a new thread is created
       # but it's impossible for the SDK to keep track every new thread
       # so we need to use this rather passive way to make sure the app doesn't crash
-      Thread.current.thread_variable_get(THREAD_LOCAL) || clone_hub_to_current_thread
+      get_current_hub_internal || clone_hub_to_current_thread
     end
 
     # Returns the current active client.
@@ -351,12 +381,14 @@ module Sentry
       get_current_hub.current_scope
     end
 
-    # Clones the main thread's active hub and stores it to the current thread.
+    # Clones the main hub and stores it for the current execution context
+    # (the current thread, or the current fiber when +config.hub_isolation_level+
+    # is +:fiber+).
     #
     # @return [void]
     def clone_hub_to_current_thread
       return unless initialized?
-      Thread.current.thread_variable_set(THREAD_LOCAL, get_main_hub.clone)
+      set_current_hub_internal(get_main_hub.clone)
     end
 
     # Takes a block and yields the current active scope.
@@ -708,6 +740,59 @@ module Sentry
     def dependency_installed?(name)
       Object.const_defined?(name)
     end
+
+    # Reads the hub stored for the current execution context. The active
+    # isolation level (cached from +config.hub_isolation_level+ at init) decides
+    # whether that context is the current thread or the current fiber. Reads the
+    # cached level rather than the configuration to avoid recursing back through
+    # hub resolution.
+    #
+    # @!visibility private
+    # @return [Hub, nil]
+    def get_current_hub_internal
+      if @hub_isolation_level == :fiber
+        owner, hub = ::Fiber[THREAD_LOCAL]
+
+        # Child fibers, and threads started from them, inherit fiber storage
+        # holding the same Hub object rather than a copy.
+        if owner.equal?(::Fiber.current)
+          hub
+        elsif hub
+          set_current_hub_internal(fork_hub(hub))
+        end
+      else
+        ::Thread.current.thread_variable_get(THREAD_LOCAL)
+      end
+    end
+
+    # Copies +hub+ for a context that inherited it. The span is re-attached
+    # because Scope#dup deep-copies it, and spans recorded on a detached
+    # transaction copy are never sent.
+    #
+    # @!visibility private
+    # @param hub [Hub]
+    # @return [Hub]
+    def fork_hub(hub)
+      span = hub.current_scope.span
+      forked = hub.clone
+      forked.current_scope.set_span(span) if span
+
+      forked
+    end
+
+    # Stores +hub+ for the current execution context (thread or fiber).
+    #
+    # @!visibility private
+    # @param hub [Hub, nil]
+    # @return [Hub, nil]
+    def set_current_hub_internal(hub)
+      if @hub_isolation_level == :fiber
+        ::Fiber[THREAD_LOCAL] = [::Fiber.current, hub]
+        hub # callers use the return value, so don't return the pair
+      else
+        ::Thread.current.thread_variable_set(THREAD_LOCAL, hub)
+      end
+    end
   end
 end
 

data/sentry-ruby-core.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.platform = Gem::Platform::RUBY
   spec.required_ruby_version = '>= 2.7'
   spec.extra_rdoc_files = ["README.md", "LICENSE.txt"]
-  spec.files = `git ls-files | grep -Ev '^(spec|benchmarks|examples|\.rubocop\.yml)'`.split("\n")
+  spec.files = `git ls-files | grep -Ev '^(spec|benchmarks|examples|test-matrix\.json|\.rubocop\.yml)'`.split("\n")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage

data/sentry-ruby.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.platform = Gem::Platform::RUBY
   spec.required_ruby_version = '>= 2.7'
   spec.extra_rdoc_files = ["README.md", "LICENSE.txt"]
-  spec.files = `git ls-files | grep -Ev '^(spec|benchmarks|examples|\.rubocop\.yml)'`.split("\n")
+  spec.files = `git ls-files | grep -Ev '^(spec|benchmarks|examples|test-matrix\.json|\.rubocop\.yml)'`.split("\n")
 
   github_root_uri = 'https://github.com/getsentry/sentry-ruby'
   spec.homepage = "#{github_root_uri}/tree/#{spec.version}/#{spec.name}"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sentry-ruby
 version: !ruby/object:Gem::Version
-  version: 6.6.2
+  version: 6.7.0
 platform: ruby
 authors:
 - Sentry Team
@@ -76,6 +76,36 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- bin/test
+- gemfiles/ruby-2.7_rack-2_redis-4.gemfile.lock
+- gemfiles/ruby-2.7_rack-3.1_redis-4.gemfile.lock
+- gemfiles/ruby-2.7_rack-3_redis-4.gemfile.lock
+- gemfiles/ruby-3.0_rack-2_redis-4.gemfile.lock
+- gemfiles/ruby-3.0_rack-3.1_redis-4.gemfile.lock
+- gemfiles/ruby-3.0_rack-3_redis-4.gemfile.lock
+- gemfiles/ruby-3.1_rack-2_redis-4.gemfile.lock
+- gemfiles/ruby-3.1_rack-3.1_redis-4.gemfile.lock
+- gemfiles/ruby-3.1_rack-3_redis-4.gemfile.lock
+- gemfiles/ruby-3.2_rack-0_redis-5.gemfile.lock
+- gemfiles/ruby-3.2_rack-2_redis-4.gemfile.lock
+- gemfiles/ruby-3.2_rack-2_redis-5.gemfile.lock
+- gemfiles/ruby-3.2_rack-3.1_redis-4.gemfile.lock
+- gemfiles/ruby-3.2_rack-3_redis-4.gemfile.lock
+- gemfiles/ruby-3.2_rack-3_redis-5.gemfile.lock
+- gemfiles/ruby-3.3_rack-2_redis-4.gemfile.lock
+- gemfiles/ruby-3.3_rack-3.1_redis-4.gemfile.lock
+- gemfiles/ruby-3.3_rack-3.1_redis-5.3.gemfile.lock
+- gemfiles/ruby-3.3_rack-3_redis-4.gemfile.lock
+- gemfiles/ruby-3.4_rack-2_redis-4.gemfile.lock
+- gemfiles/ruby-3.4_rack-3.1_redis-4.gemfile.lock
+- gemfiles/ruby-3.4_rack-3.1_redis-5.3.gemfile.lock
+- gemfiles/ruby-3.4_rack-3_redis-4.gemfile.lock
+- gemfiles/ruby-4.0_rack-2_redis-4.gemfile.lock
+- gemfiles/ruby-4.0_rack-3.1_redis-4.gemfile.lock
+- gemfiles/ruby-4.0_rack-3_redis-4.gemfile.lock
+- gemfiles/ruby-jruby-9.4.14.0_rack-2_redis-4.gemfile.lock
+- gemfiles/ruby-jruby-9.4.14.0_rack-3.1_redis-4.gemfile.lock
+- gemfiles/ruby-jruby-9.4.14.0_rack-3_redis-4.gemfile.lock
 - lib/sentry-ruby.rb
 - lib/sentry/attachment.rb
 - lib/sentry/background_worker.rb
@@ -170,15 +200,15 @@ files:
 - lib/sentry/version.rb
 - sentry-ruby-core.gemspec
 - sentry-ruby.gemspec
-homepage: https://github.com/getsentry/sentry-ruby/tree/6.6.2/sentry-ruby
+homepage: https://github.com/getsentry/sentry-ruby/tree/6.7.0/sentry-ruby
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/getsentry/sentry-ruby/tree/6.6.2/sentry-ruby
-  source_code_uri: https://github.com/getsentry/sentry-ruby/tree/6.6.2/sentry-ruby
-  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/6.6.2/CHANGELOG.md
+  homepage_uri: https://github.com/getsentry/sentry-ruby/tree/6.7.0/sentry-ruby
+  source_code_uri: https://github.com/getsentry/sentry-ruby/tree/6.7.0/sentry-ruby
+  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/6.7.0/CHANGELOG.md
   bug_tracker_uri: https://github.com/getsentry/sentry-ruby/issues
-  documentation_uri: http://www.rubydoc.info/gems/sentry-ruby/6.6.2
+  documentation_uri: http://www.rubydoc.info/gems/sentry-ruby/6.7.0
 rdoc_options: []
 require_paths:
 - lib