sentry-ruby 5.28.1 → 6.3.1

data/lib/sentry-ruby.rb

@@ -26,8 +26,8 @@ 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"
+require "sentry/metrics"
 
 [
   "sentry/rake",
@@ -59,7 +59,6 @@ module Sentry
     logger
     session_flusher
     backpressure_monitor
-    metrics_aggregator
     exception_locals_tp
   ].freeze
 
@@ -93,10 +92,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
@@ -252,7 +247,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
@@ -273,12 +267,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
 
@@ -635,24 +623,27 @@ 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
-          # Use configured structured logger class or default to StructuredLogger
-          # @see https://develop.sentry.dev/sdk/telemetry/logs/
-          configuration.structured_logging.logger_class.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."
-
-                    Caller: #{caller.first}
-          STR
-
-          configuration.sdk_logger
-        end
+      @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")
+    #   Sentry.metrics.gauge("cpu.usage", 75.2, unit: "percent")
+    #
+    # @return [Metrics] The metrics API
+    def metrics
+      Metrics
     end
 
     ##### Helpers #####
@@ -675,6 +666,38 @@ module Sentry
       META
     end
 
+    # Registers a callback function that retrieves the current external propagation context.
+    # This is used by OpenTelemetry integration to provide trace_id and span_id from OTel context.
+    #
+    # @param callback [Proc, nil] A callable that returns [trace_id, span_id] or nil
+    # @return [void]
+    #
+    # @example
+    #   Sentry.register_external_propagation_context do
+    #     span_context = OpenTelemetry::Trace.current_span.context
+    #     return nil unless span_context.valid?
+    #     [span_context.hex_trace_id, span_context.hex_span_id]
+    #   end
+    def register_external_propagation_context(&callback)
+      @external_propagation_context_callback = callback
+    end
+
+    # Returns the external propagation context (trace_id, span_id) if a callback is registered.
+    #
+    # @return [Array<String>, nil] A tuple of [trace_id, span_id] or nil if no context is available
+    def get_external_propagation_context
+      return nil unless @external_propagation_context_callback
+
+      @external_propagation_context_callback.call
+    rescue => e
+      sdk_logger&.debug(LOGGER_PROGNAME) { "Error getting external propagation context: #{e.message}" } if initialized?
+      nil
+    end
+
+    def clear_external_propagation_context
+      @external_propagation_context_callback = nil
+    end
+
     # @!visibility private
     def utc_now
       Time.now.utc

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")
 
@@ -30,4 +30,5 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "concurrent-ruby", "~> 1.0", ">= 1.0.2"
   spec.add_dependency "bigdecimal"
+  spec.add_dependency "logger"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sentry-ruby
 version: !ruby/object:Gem::Version
-  version: 5.28.1
+  version: 6.3.1
 platform: ruby
 authors:
 - Sentry Team
@@ -43,6 +43,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A gem that provides a client interface for the Sentry error logger
 email: accounts@sentry.io
 executables: []
@@ -67,6 +81,7 @@ files:
 - lib/sentry/background_worker.rb
 - lib/sentry/backpressure_monitor.rb
 - lib/sentry/backtrace.rb
+- lib/sentry/backtrace/line.rb
 - lib/sentry/baggage.rb
 - lib/sentry/breadcrumb.rb
 - lib/sentry/breadcrumb/sentry_logger.rb
@@ -105,16 +120,9 @@ files:
 - lib/sentry/log_event.rb
 - lib/sentry/log_event_buffer.rb
 - lib/sentry/logger.rb
+- lib/sentry/metric_event.rb
+- lib/sentry/metric_event_buffer.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
@@ -127,11 +135,13 @@ files:
 - lib/sentry/release_detector.rb
 - lib/sentry/rspec.rb
 - lib/sentry/scope.rb
+- lib/sentry/sequel.rb
 - lib/sentry/session.rb
 - lib/sentry/session_flusher.rb
 - lib/sentry/span.rb
 - lib/sentry/std_lib_logger.rb
 - lib/sentry/structured_logger.rb
+- lib/sentry/telemetry_event_buffer.rb
 - lib/sentry/test_helper.rb
 - lib/sentry/threaded_periodic_worker.rb
 - lib/sentry/transaction.rb
@@ -152,21 +162,22 @@ files:
 - lib/sentry/utils/real_ip.rb
 - lib/sentry/utils/request_id.rb
 - lib/sentry/utils/sample_rand.rb
+- lib/sentry/utils/telemetry_attributes.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.28.1/sentry-ruby
+homepage: https://github.com/getsentry/sentry-ruby/tree/6.3.1/sentry-ruby
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/getsentry/sentry-ruby/tree/5.28.1/sentry-ruby
-  source_code_uri: https://github.com/getsentry/sentry-ruby/tree/5.28.1/sentry-ruby
-  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/5.28.1/CHANGELOG.md
+  homepage_uri: https://github.com/getsentry/sentry-ruby/tree/6.3.1/sentry-ruby
+  source_code_uri: https://github.com/getsentry/sentry-ruby/tree/6.3.1/sentry-ruby
+  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/6.3.1/CHANGELOG.md
   bug_tracker_uri: https://github.com/getsentry/sentry-ruby/issues
-  documentation_uri: http://www.rubydoc.info/gems/sentry-ruby/5.28.1
+  documentation_uri: http://www.rubydoc.info/gems/sentry-ruby/6.3.1
 rdoc_options: []
 require_paths:
 - lib
@@ -174,7 +185,7 @@ 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:
   - - ">="

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,57 +0,0 @@
-# frozen_string_literal: true
-
-module Sentry
-  module Metrics
-    class Configuration
-      include ArgumentCheckingHelper
-      include LoggingHelper
-
-      # 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_reader :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(sdk_logger)
-        @sdk_logger = sdk_logger
-        @enabled = false
-        @enable_code_locations = true
-      end
-
-      def enabled=(value)
-        log_warn <<~MSG
-          `config.metrics` is now deprecated and will be removed in the next major.
-        MSG
-
-        @enabled = value
-      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

data/lib/sentry/metrics/gauge_metric.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module Sentry
-  module Metrics
-    class GaugeMetric < Metric
-      attr_reader :last, :min, :max, :sum, :count
-
-      def initialize(value)
-        value = value.to_f
-        @last = value
-        @min = value
-        @max = value
-        @sum = value
-        @count = 1
-      end
-
-      def add(value)
-        value = value.to_f
-        @last = value
-        @min = [@min, value].min
-        @max = [@max, value].max
-        @sum += value
-        @count += 1
-      end
-
-      def serialize
-        [last, min, max, sum, count]
-      end
-
-      def weight
-        5
-      end
-    end
-  end
-end