sentry-ruby 5.26.0 → 6.1.0

data/lib/sentry/utils/sample_rand.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module Sentry
+  module Utils
+    class SampleRand
+      PRECISION = 1_000_000.0
+      FORMAT_PRECISION = 6
+
+      attr_reader :trace_id
+
+      def self.valid?(value)
+        return false unless value
+        value >= 0.0 && value < 1.0
+      end
+
+      def self.format(value)
+        return unless value
+
+        truncated = (value * PRECISION).floor / PRECISION
+        "%.#{FORMAT_PRECISION}f" % truncated
+      end
+
+      def initialize(trace_id: nil)
+        @trace_id = trace_id
+      end
+
+      def generate_from_trace_id
+        (random_from_trace_id * PRECISION).floor / PRECISION
+      end
+
+      def generate_from_sampling_decision(sampled, sample_rate)
+        if invalid_sample_rate?(sample_rate)
+          fallback_generation
+        else
+          generate_based_on_sampling(sampled, sample_rate)
+        end
+      end
+
+      def generate_from_value(sample_rand_value)
+        parsed_value = parse_value(sample_rand_value)
+
+        if self.class.valid?(parsed_value)
+          parsed_value
+        else
+          fallback_generation
+        end
+      end
+
+      private
+
+      def random_from_trace_id
+        if @trace_id
+          Random.new(@trace_id[0, 16].to_i(16))
+        else
+          Random.new
+        end.rand(1.0)
+      end
+
+      def invalid_sample_rate?(sample_rate)
+        sample_rate.nil? || sample_rate <= 0.0 || sample_rate > 1.0
+      end
+
+      def fallback_generation
+        if @trace_id
+          (random_from_trace_id * PRECISION).floor / PRECISION
+        else
+          format_random(Random.rand(1.0))
+        end
+      end
+
+      def generate_based_on_sampling(sampled, sample_rate)
+        random = random_from_trace_id
+
+        result = if sampled
+          random * sample_rate
+        elsif sample_rate == 1.0
+          random
+        else
+          sample_rate + random * (1.0 - sample_rate)
+        end
+
+        format_random(result)
+      end
+
+      def format_random(value)
+        truncated = (value * PRECISION).floor / PRECISION
+        ("%.#{FORMAT_PRECISION}f" % truncated).to_f
+      end
+
+      def parse_value(sample_rand_value)
+        Float(sample_rand_value)
+      rescue ArgumentError
+        nil
+      end
+    end
+  end
+end

data/lib/sentry/vernier/profiler.rb

@@ -20,6 +20,7 @@ module Sentry
 
         @profiling_enabled = defined?(Vernier) && configuration.profiling_enabled?
         @profiles_sample_rate = configuration.profiles_sample_rate
+        @profiles_sample_interval = configuration.profiles_sample_interval
         @project_root = configuration.project_root
         @app_dirs_pattern = configuration.app_dirs_pattern
         @in_app_pattern = Regexp.new("^(#{@project_root}/)?#{@app_dirs_pattern}")
@@ -56,7 +57,7 @@ module Sentry
         return unless @sampled
         return if @started
 
-        @started = ::Vernier.start_profile
+        @started = ::Vernier.start_profile(interval: @profiles_sample_interval)
 
         log("Started")
 
@@ -90,9 +91,9 @@ module Sentry
         Thread.current.object_id
       end
 
-      def to_hash
+      def to_h
         unless @sampled
-          record_lost_event(:sample_rate)
+          record_lost_event(:sample_rate) if @profiling_enabled
           return EMPTY_RESULT
         end
 

data/lib/sentry/version.rb

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

data/lib/sentry-ruby.rb

@@ -10,8 +10,10 @@ require "sentry/core_ext/object/deep_dup"
 require "sentry/utils/argument_checking_helper"
 require "sentry/utils/encoding_helper"
 require "sentry/utils/logging_helper"
+require "sentry/utils/sample_rand"
 require "sentry/configuration"
 require "sentry/structured_logger"
+require "sentry/debug_structured_logger"
 require "sentry/event"
 require "sentry/error_event"
 require "sentry/transaction_event"
@@ -24,7 +26,6 @@ require "sentry/threaded_periodic_worker"
 require "sentry/session_flusher"
 require "sentry/backpressure_monitor"
 require "sentry/cron/monitor_check_ins"
-require "sentry/metrics"
 require "sentry/vernier/profiler"
 
 [
@@ -57,7 +58,6 @@ module Sentry
     logger
     session_flusher
     backpressure_monitor
-    metrics_aggregator
     exception_locals_tp
   ].freeze
 
@@ -91,10 +91,6 @@ module Sentry
     #   @return [BackpressureMonitor, nil]
     attr_reader :backpressure_monitor
 
-    # @!attribute [r] metrics_aggregator
-    #   @return [Metrics::Aggregator, nil]
-    attr_reader :metrics_aggregator
-
     ##### Patch Registration #####
 
     # @!visibility private
@@ -237,8 +233,7 @@ module Sentry
     # @yieldparam config [Configuration]
     # @return [void]
     def init(&block)
-      config = Configuration.new
-      yield(config) if block_given?
+      config = Configuration.new(&block)
 
       config.detect_release
       apply_patches(config)
@@ -251,7 +246,6 @@ module Sentry
       @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
-      @metrics_aggregator = config.metrics.enabled ? Sentry::Metrics::Aggregator.new(config, client) : nil
       exception_locals_tp.enable if config.include_local_variables
       at_exit { close }
     end
@@ -272,12 +266,6 @@ module Sentry
         @backpressure_monitor = nil
       end
 
-      if @metrics_aggregator
-        @metrics_aggregator.flush(force: true)
-        @metrics_aggregator.kill
-        @metrics_aggregator = nil
-      end
-
       if client = get_current_client
         client.flush
 
@@ -498,6 +486,7 @@ module Sentry
     # @param [Hash] options Extra log event options
     # @option options [Symbol] level The log level (:trace, :debug, :info, :warn, :error, :fatal)
     # @option options [Integer] severity The severity number according to the Sentry Logs Protocol
+    # @option options [String] origin The origin of the log event (e.g., "auto.db.rails", "manual")
     # @option options [Hash] Additional attributes to include with the log
     #
     # @example Direct usage (prefer using Sentry.logger instead)
@@ -633,22 +622,9 @@ module Sentry
     #
     # @see https://develop.sentry.dev/sdk/telemetry/logs/ Sentry SDK Telemetry Logs Protocol
     #
-    # @return [StructuredLogger, nil] The structured logger instance or nil if logs are disabled
+    # @return [StructuredLogger] The structured logger instance or nil if logs are disabled
     def logger
-      @logger ||=
-        if configuration.enable_logs
-          # Initialize the public-facing Structured Logger if logs are enabled
-          # This creates a StructuredLogger instance that implements Sentry's SDK telemetry logs protocol
-          # @see https://develop.sentry.dev/sdk/telemetry/logs/
-          StructuredLogger.new(configuration)
-        else
-          warn <<~STR
-            [sentry] `Sentry.logger` will no longer be used as internal SDK logger when `enable_logs` feature is turned on.
-                    Use Sentry.configuration.sdk_logger for SDK-specific logging needs."
-          STR
-
-          configuration.sdk_logger
-        end
+      @logger ||= configuration.structured_logging.logger_class.new(configuration)
     end
 
     ##### Helpers #####

data/sentry-ruby-core.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.homepage = "https://github.com/getsentry/sentry-ruby"
 
   spec.platform = Gem::Platform::RUBY
-  spec.required_ruby_version = '>= 2.4'
+  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")
 

data/sentry-ruby.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.license = 'MIT'
 
   spec.platform = Gem::Platform::RUBY
-  spec.required_ruby_version = '>= 2.4'
+  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")
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sentry-ruby
 version: !ruby/object:Gem::Version
-  version: 5.26.0
+  version: 6.1.0
 platform: ruby
 authors:
 - Sentry Team
@@ -80,6 +80,7 @@ files:
 - lib/sentry/cron/monitor_check_ins.rb
 - lib/sentry/cron/monitor_config.rb
 - lib/sentry/cron/monitor_schedule.rb
+- lib/sentry/debug_structured_logger.rb
 - lib/sentry/dsn.rb
 - lib/sentry/envelope.rb
 - lib/sentry/envelope/item.rb
@@ -104,16 +105,6 @@ files:
 - lib/sentry/log_event.rb
 - lib/sentry/log_event_buffer.rb
 - lib/sentry/logger.rb
-- lib/sentry/metrics.rb
-- lib/sentry/metrics/aggregator.rb
-- lib/sentry/metrics/configuration.rb
-- lib/sentry/metrics/counter_metric.rb
-- lib/sentry/metrics/distribution_metric.rb
-- lib/sentry/metrics/gauge_metric.rb
-- lib/sentry/metrics/local_aggregator.rb
-- lib/sentry/metrics/metric.rb
-- lib/sentry/metrics/set_metric.rb
-- lib/sentry/metrics/timing.rb
 - lib/sentry/net/http.rb
 - lib/sentry/profiler.rb
 - lib/sentry/profiler/helpers.rb
@@ -137,6 +128,7 @@ files:
 - lib/sentry/transaction_event.rb
 - lib/sentry/transport.rb
 - lib/sentry/transport/configuration.rb
+- lib/sentry/transport/debug_transport.rb
 - lib/sentry/transport/dummy_transport.rb
 - lib/sentry/transport/http_transport.rb
 - lib/sentry/transport/spotlight_transport.rb
@@ -149,21 +141,22 @@ files:
 - lib/sentry/utils/logging_helper.rb
 - lib/sentry/utils/real_ip.rb
 - lib/sentry/utils/request_id.rb
+- lib/sentry/utils/sample_rand.rb
 - lib/sentry/utils/uuid.rb
 - lib/sentry/vernier/output.rb
 - lib/sentry/vernier/profiler.rb
 - lib/sentry/version.rb
 - sentry-ruby-core.gemspec
 - sentry-ruby.gemspec
-homepage: https://github.com/getsentry/sentry-ruby/tree/5.26.0/sentry-ruby
+homepage: https://github.com/getsentry/sentry-ruby/tree/6.1.0/sentry-ruby
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/getsentry/sentry-ruby/tree/5.26.0/sentry-ruby
-  source_code_uri: https://github.com/getsentry/sentry-ruby/tree/5.26.0/sentry-ruby
-  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/5.26.0/CHANGELOG.md
+  homepage_uri: https://github.com/getsentry/sentry-ruby/tree/6.1.0/sentry-ruby
+  source_code_uri: https://github.com/getsentry/sentry-ruby/tree/6.1.0/sentry-ruby
+  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/6.1.0/CHANGELOG.md
   bug_tracker_uri: https://github.com/getsentry/sentry-ruby/issues
-  documentation_uri: http://www.rubydoc.info/gems/sentry-ruby/5.26.0
+  documentation_uri: http://www.rubydoc.info/gems/sentry-ruby/6.1.0
 rdoc_options: []
 require_paths:
 - lib
@@ -171,14 +164,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A gem that provides a client interface for the Sentry error logger
 test_files: []

data/lib/sentry/metrics/aggregator.rb

@@ -1,248 +0,0 @@
-# frozen_string_literal: true
-
-module Sentry
-  module Metrics
-    class Aggregator < ThreadedPeriodicWorker
-      FLUSH_INTERVAL = 5
-      ROLLUP_IN_SECONDS = 10
-
-      # this is how far removed from user code in the backtrace we are
-      # when we record code locations
-      DEFAULT_STACKLEVEL = 4
-
-      KEY_SANITIZATION_REGEX = /[^a-zA-Z0-9_\-.]+/
-      UNIT_SANITIZATION_REGEX = /[^a-zA-Z0-9_]+/
-      TAG_KEY_SANITIZATION_REGEX = /[^a-zA-Z0-9_\-.\/]+/
-
-      TAG_VALUE_SANITIZATION_MAP = {
-        "\n" => "\\n",
-        "\r" => "\\r",
-        "\t" => "\\t",
-        "\\" => "\\\\",
-        "|" => "\\u{7c}",
-        "," => "\\u{2c}"
-      }
-
-      METRIC_TYPES = {
-        c: CounterMetric,
-        d: DistributionMetric,
-        g: GaugeMetric,
-        s: SetMetric
-      }
-
-      # exposed only for testing
-      attr_reader :client, :thread, :buckets, :flush_shift, :code_locations
-
-      def initialize(configuration, client)
-        super(configuration.sdk_logger, FLUSH_INTERVAL)
-        @client = client
-        @before_emit = configuration.metrics.before_emit
-        @enable_code_locations = configuration.metrics.enable_code_locations
-        @stacktrace_builder = configuration.stacktrace_builder
-
-        @default_tags = {}
-        @default_tags["release"] = configuration.release if configuration.release
-        @default_tags["environment"] = configuration.environment if configuration.environment
-
-        @mutex = Mutex.new
-
-        # a nested hash of timestamp -> bucket keys -> Metric instance
-        @buckets = {}
-
-        # the flush interval needs to be shifted once per startup to create jittering
-        @flush_shift = Random.rand * ROLLUP_IN_SECONDS
-
-        # a nested hash of timestamp (start of day) -> meta keys -> frame
-        @code_locations = {}
-      end
-
-      def add(type,
-              key,
-              value,
-              unit: "none",
-              tags: {},
-              timestamp: nil,
-              stacklevel: nil)
-        return unless ensure_thread
-        return unless METRIC_TYPES.keys.include?(type)
-
-        updated_tags = get_updated_tags(tags)
-        return if @before_emit && !@before_emit.call(key, updated_tags)
-
-        timestamp ||= Sentry.utc_now
-
-        # this is integer division and thus takes the floor of the division
-        # and buckets into 10 second intervals
-        bucket_timestamp = (timestamp.to_i / ROLLUP_IN_SECONDS) * ROLLUP_IN_SECONDS
-
-        serialized_tags = serialize_tags(updated_tags)
-        bucket_key = [type, key, unit, serialized_tags]
-
-        added = @mutex.synchronize do
-          record_code_location(type, key, unit, timestamp, stacklevel: stacklevel) if @enable_code_locations
-          process_bucket(bucket_timestamp, bucket_key, type, value)
-        end
-
-        # for sets, we pass on if there was a new entry to the local gauge
-        local_value = type == :s ? added : value
-        process_span_aggregator(bucket_key, local_value)
-      end
-
-      def flush(force: false)
-        flushable_buckets = get_flushable_buckets!(force)
-        code_locations = get_code_locations!
-        return if flushable_buckets.empty? && code_locations.empty?
-
-        envelope = Envelope.new
-
-        unless flushable_buckets.empty?
-          payload = serialize_buckets(flushable_buckets)
-          envelope.add_item(
-            { type: "statsd", length: payload.bytesize },
-            payload
-          )
-        end
-
-        unless code_locations.empty?
-          code_locations.each do |timestamp, locations|
-            payload = serialize_locations(timestamp, locations)
-            envelope.add_item(
-              { type: "metric_meta", content_type: "application/json" },
-              payload
-            )
-          end
-        end
-
-        @client.capture_envelope(envelope)
-      end
-
-      alias_method :run, :flush
-
-      private
-
-      # important to sort for key consistency
-      def serialize_tags(tags)
-        tags.flat_map do |k, v|
-          if v.is_a?(Array)
-            v.map { |x| [k.to_s, x.to_s] }
-          else
-            [[k.to_s, v.to_s]]
-          end
-        end.sort
-      end
-
-      def get_flushable_buckets!(force)
-        @mutex.synchronize do
-          flushable_buckets = {}
-
-          if force
-            flushable_buckets = @buckets
-            @buckets = {}
-          else
-            cutoff = Sentry.utc_now.to_i - ROLLUP_IN_SECONDS - @flush_shift
-            flushable_buckets = @buckets.select { |k, _| k <= cutoff }
-            @buckets.reject! { |k, _| k <= cutoff }
-          end
-
-          flushable_buckets
-        end
-      end
-
-      def get_code_locations!
-        @mutex.synchronize do
-          code_locations = @code_locations
-          @code_locations = {}
-          code_locations
-        end
-      end
-
-      # serialize buckets to statsd format
-      def serialize_buckets(buckets)
-        buckets.map do |timestamp, timestamp_buckets|
-          timestamp_buckets.map do |metric_key, metric|
-            type, key, unit, tags = metric_key
-            values = metric.serialize.join(":")
-            sanitized_tags = tags.map { |k, v| "#{sanitize_tag_key(k)}:#{sanitize_tag_value(v)}" }.join(",")
-
-            "#{sanitize_key(key)}@#{sanitize_unit(unit)}:#{values}|#{type}|\##{sanitized_tags}|T#{timestamp}"
-          end
-        end.flatten.join("\n")
-      end
-
-      def serialize_locations(timestamp, locations)
-        mapping = locations.map do |meta_key, location|
-          type, key, unit = meta_key
-          mri = "#{type}:#{sanitize_key(key)}@#{sanitize_unit(unit)}"
-
-          # note this needs to be an array but it really doesn't serve a purpose right now
-          [mri, [location.merge(type: "location")]]
-        end.to_h
-
-        { timestamp: timestamp, mapping: mapping }
-      end
-
-      def sanitize_key(key)
-        key.gsub(KEY_SANITIZATION_REGEX, "_")
-      end
-
-      def sanitize_unit(unit)
-        unit.gsub(UNIT_SANITIZATION_REGEX, "")
-      end
-
-      def sanitize_tag_key(key)
-        key.gsub(TAG_KEY_SANITIZATION_REGEX, "")
-      end
-
-      def sanitize_tag_value(value)
-        value.chars.map { |c| TAG_VALUE_SANITIZATION_MAP[c] || c }.join
-      end
-
-      def get_transaction_name
-        scope = Sentry.get_current_scope
-        return nil unless scope && scope.transaction_name
-        return nil if scope.transaction_source_low_quality?
-
-        scope.transaction_name
-      end
-
-      def get_updated_tags(tags)
-        updated_tags = @default_tags.merge(tags)
-
-        transaction_name = get_transaction_name
-        updated_tags["transaction"] = transaction_name if transaction_name
-
-        updated_tags
-      end
-
-      def process_span_aggregator(key, value)
-        scope = Sentry.get_current_scope
-        return nil unless scope && scope.span
-        return nil if scope.transaction_source_low_quality?
-
-        scope.span.metrics_local_aggregator.add(key, value)
-      end
-
-      def process_bucket(timestamp, key, type, value)
-        @buckets[timestamp] ||= {}
-
-        if (metric = @buckets[timestamp][key])
-          old_weight = metric.weight
-          metric.add(value)
-          metric.weight - old_weight
-        else
-          metric = METRIC_TYPES[type].new(value)
-          @buckets[timestamp][key] = metric
-          metric.weight
-        end
-      end
-
-      def record_code_location(type, key, unit, timestamp, stacklevel: nil)
-        meta_key =  [type, key, unit]
-        start_of_day = Time.utc(timestamp.year, timestamp.month, timestamp.day).to_i
-
-        @code_locations[start_of_day] ||= {}
-        @code_locations[start_of_day][meta_key] ||= @stacktrace_builder.metrics_code_location(caller[stacklevel || DEFAULT_STACKLEVEL])
-      end
-    end
-  end
-end

data/lib/sentry/metrics/configuration.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-module Sentry
-  module Metrics
-    class Configuration
-      include ArgumentCheckingHelper
-
-      # Enable metrics usage.
-      # Starts a new {Sentry::Metrics::Aggregator} instance to aggregate metrics
-      # and a thread to aggregate flush every 5 seconds.
-      # @return [Boolean]
-      attr_accessor :enabled
-
-      # Enable code location reporting.
-      # Will be sent once per day.
-      # True by default.
-      # @return [Boolean]
-      attr_accessor :enable_code_locations
-
-      # Optional Proc, called before emitting a metric to the aggregator.
-      # Use it to filter keys (return false/nil) or update tags.
-      # Make sure to return true at the end.
-      #
-      # @example
-      #   config.metrics.before_emit = lambda do |key, tags|
-      #     return nil if key == 'foo'
-      #     tags[:bar] = 42
-      #     tags.delete(:baz)
-      #     true
-      #   end
-      #
-      # @return [Proc, nil]
-      attr_reader :before_emit
-
-      def initialize
-        @enabled = false
-        @enable_code_locations = true
-      end
-
-      def before_emit=(value)
-        check_callable!("metrics.before_emit", value)
-
-        @before_emit = value
-      end
-    end
-  end
-end

data/lib/sentry/metrics/counter_metric.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module Sentry
-  module Metrics
-    class CounterMetric < Metric
-      attr_reader :value
-
-      def initialize(value)
-        @value = value.to_f
-      end
-
-      def add(value)
-        @value += value.to_f
-      end
-
-      def serialize
-        [value]
-      end
-
-      def weight
-        1
-      end
-    end
-  end
-end

data/lib/sentry/metrics/distribution_metric.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module Sentry
-  module Metrics
-    class DistributionMetric < Metric
-      attr_reader :value
-
-      def initialize(value)
-        @value = [value.to_f]
-      end
-
-      def add(value)
-        @value << value.to_f
-      end
-
-      def serialize
-        value
-      end
-
-      def weight
-        value.size
-      end
-    end
-  end
-end