sentry-ruby-core 6.6.2 → 7.0.0

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,12 +271,13 @@ 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
       @backpressure_monitor = config.enable_backpressure_handling ? Sentry::BackpressureMonitor.new(config, client) : nil
-      exception_locals_tp.enable if config.include_local_variables
+      exception_locals_tp.enable if config.data_collection.collect_stack_frame_variables?
       at_exit { close }
     end
 
@@ -271,7 +301,7 @@ module Sentry
         client.configuration.run_after_close_callbacks
         client.flush
 
-        if client.configuration.include_local_variables
+        if client.configuration.data_collection.collect_stack_frame_variables?
           exception_locals_tp.disable
         end
       end
@@ -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.
@@ -495,7 +527,7 @@ module Sentry
     #   Sentry.capture_log("User logged in", level: :info, user_id: 123)
     #
     # @see https://develop.sentry.dev/sdk/telemetry/logs/ Sentry SDK Telemetry Logs Protocol
-    # @return [LogEvent, nil] The created log event or nil if logging is disabled
+    # @return [LogEvent, nil] The created log event or nil if Sentry is not initialized
     def capture_log(message, **options)
       return unless initialized?
       get_current_hub.capture_log_event(message, **options)
@@ -607,14 +639,6 @@ module Sentry
 
     # Returns the structured logger instance that implements Sentry's SDK telemetry logs protocol.
     #
-    # This logger is only available when logs are enabled in the configuration.
-    #
-    # @example Enable logs in configuration
-    #   Sentry.init do |config|
-    #     config.dsn = "YOUR_DSN"
-    #     config.enable_logs = true
-    #   end
-    #
     # @example Basic usage
     #   Sentry.logger.info("User logged in successfully", user_id: 123)
     #   Sentry.logger.error("Failed to process payment",
@@ -624,19 +648,13 @@ module Sentry
     #
     # @see https://develop.sentry.dev/sdk/telemetry/logs/ Sentry SDK Telemetry Logs Protocol
     #
-    # @return [StructuredLogger] The structured logger instance or nil if logs are disabled
+    # @return [StructuredLogger] The structured logger instance
     def logger
       @logger ||= configuration.structured_logging.logger_class.new(configuration)
     end
 
     # Returns the metrics API for capturing custom metrics.
     #
-    # @example Enable metrics
-    #   Sentry.init do |config|
-    #     config.dsn = "YOUR_DSN"
-    #     config.enable_metrics = true
-    #   end
-    #
     # @example Usage
     #   Sentry.metrics.count("button.click", 1, attributes: { button_id: "submit" })
     #   Sentry.metrics.distribution("response.time", 120.5, unit: "millisecond")
@@ -708,6 +726,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-core
 version: !ruby/object:Gem::Version
-  version: 6.6.2
+  version: 7.0.0
 platform: ruby
 authors:
 - Sentry Team
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.6.2
+        version: 7.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.6.2
+        version: 7.0.0
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -56,6 +56,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
@@ -75,6 +105,8 @@ files:
 - lib/sentry/cron/monitor_check_ins.rb
 - lib/sentry/cron/monitor_config.rb
 - lib/sentry/cron/monitor_schedule.rb
+- lib/sentry/data_collection.rb
+- lib/sentry/data_collection/key_value_collection.rb
 - lib/sentry/debug_structured_logger.rb
 - lib/sentry/dsn.rb
 - lib/sentry/envelope.rb