sentry-ruby-core 5.20.1 → 5.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 698becb3655b43c16988129ae4176690e6a8a2e67bee4004b8580d71348b843a
-  data.tar.gz: 7a5e37ce71f2e3f483a3e193f2bfb0e283ae304ed4950068384806780614fc40
+  metadata.gz: d6ea6ea7aa1656256faf78dd295dddffdea94bac58ff263f49d3a67433a35fd6
+  data.tar.gz: 9f8b2d74f31fc7a313d4170bdbbc0707b61c52ae658102c6d353a09f84df81e9
 SHA512:
-  metadata.gz: 2531811bb4f288dd34ac72b7ad8fdf31cee30ba8bed63bb48a90c527d63ce3df531480ec5c9d69bf03c44ff81ddb9026936c45977f30c35a68ce473c1dc0b999
-  data.tar.gz: 2cfa9516dcbbddac0b7b8930b400150d2f93b7ff779c93fb237cdd5bfb5e04434a1cae2e8cedd85cade5bfe536807da1d6b1b9d5838a53267426bc5694c62ade
+  metadata.gz: 312560c682b07cee10690c180e7e2780daf616574dfcb792bebf1315feeb9a47ad428dbb7c7627439e781b8db85c9bc9166feb77dfa14974373df12982ae6324
+  data.tar.gz: 7f2d782aa3b58c473c0c06efbcb1e8ff8ff039a5d396d8066187d2ff863008145fb08a7ad97eedc69841b685d09da01a56c67938bb19032d65fab7ddbce05e7f

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 git_source(:github) { |name| "https://github.com/#{name}.git" }
 
@@ -14,6 +16,7 @@ gem "puma"
 
 gem "timecop"
 gem "stackprof" unless RUBY_PLATFORM == "java"
+gem "vernier", platforms: :ruby if RUBY_VERSION >= "3.2.1"
 
 gem "graphql", ">= 2.2.6" if RUBY_VERSION.to_f >= 2.7
 
@@ -25,5 +28,6 @@ gem "benchmark-memory"
 gem "yard", github: "lsegal/yard"
 gem "webrick"
 gem "faraday"
+gem "excon"
 
 eval_gemfile File.expand_path("../Gemfile", __dir__)

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rake/clean"
 CLOBBER.include "pkg"
 

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
 require "debug"

data/lib/sentry/backtrace.rb

@@ -13,10 +13,10 @@ module Sentry
         ^ \s* (?: [a-zA-Z]: | uri:classloader: )? ([^:]+ | <.*>):
         (\d+)
         (?: :in\s('|`)([^']+)')?$
-      /x.freeze
+      /x
 
       # org.jruby.runtime.callsite.CachingCallSite.call(CachingCallSite.java:170)
-      JAVA_INPUT_FORMAT = /^(.+)\.([^\.]+)\(([^\:]+)\:(\d+)\)$/.freeze
+      JAVA_INPUT_FORMAT = /^(.+)\.([^\.]+)\(([^\:]+)\:(\d+)\)$/
 
       # The file portion of the line (such as app/models/user.rb)
       attr_reader :file

data/lib/sentry/baggage.rb

@@ -6,7 +6,7 @@ module Sentry
   # A {https://www.w3.org/TR/baggage W3C Baggage Header} implementation.
   class Baggage
     SENTRY_PREFIX = "sentry-"
-    SENTRY_PREFIX_REGEX = /^sentry-/.freeze
+    SENTRY_PREFIX_REGEX = /^sentry-/
 
     # @return [Hash]
     attr_reader :items

data/lib/sentry/configuration.rb

@@ -3,8 +3,8 @@
 require "concurrent/utility/processor_counter"
 
 require "sentry/utils/exception_cause_chain"
-require 'sentry/utils/custom_inspection'
-require 'sentry/utils/env_helper'
+require "sentry/utils/custom_inspection"
+require "sentry/utils/env_helper"
 require "sentry/dsn"
 require "sentry/release_detector"
 require "sentry/transport/configuration"
@@ -291,6 +291,10 @@ module Sentry
     # @return [Symbol]
     attr_reader :instrumenter
 
+    # The profiler class
+    # @return [Class]
+    attr_reader :profiler_class
+
     # Take a float between 0.0 and 1.0 as the sample rate for capturing profiles.
     # Note that this rate is relative to traces_sample_rate / traces_sampler,
     # i.e. the profile is sampled by this rate after the transaction is sampled.
@@ -331,19 +335,19 @@ module Sentry
     ].freeze
 
     HEROKU_DYNO_METADATA_MESSAGE = "You are running on Heroku but haven't enabled Dyno Metadata. For Sentry's "\
-    "release detection to work correctly, please run `heroku labs:enable runtime-dyno-metadata`".freeze
+    "release detection to work correctly, please run `heroku labs:enable runtime-dyno-metadata`"
 
-    LOG_PREFIX = "** [Sentry] ".freeze
-    MODULE_SEPARATOR = "::".freeze
+    LOG_PREFIX = "** [Sentry] "
+    MODULE_SEPARATOR = "::"
     SKIP_INSPECTION_ATTRIBUTES = [:@linecache, :@stacktrace_builder]
 
     INSTRUMENTERS = [:sentry, :otel]
 
-    PROPAGATION_TARGETS_MATCH_ALL = /.*/.freeze
+    PROPAGATION_TARGETS_MATCH_ALL = /.*/
 
     DEFAULT_PATCHES = %i[redis puma http].freeze
 
-    APP_DIRS_PATTERN = /(bin|exe|app|config|lib|test|spec)/.freeze
+    APP_DIRS_PATTERN = /(bin|exe|app|config|lib|test|spec)/
 
     class << self
       # Post initialization callbacks are called at the end of initialization process
@@ -387,9 +391,9 @@ module Sentry
       self.auto_session_tracking = true
       self.enable_backpressure_handling = false
       self.trusted_proxies = []
-      self.dsn = ENV['SENTRY_DSN']
+      self.dsn = ENV["SENTRY_DSN"]
 
-      spotlight_env = ENV['SENTRY_SPOTLIGHT']
+      spotlight_env = ENV["SENTRY_SPOTLIGHT"]
       spotlight_bool = Sentry::Utils::EnvHelper.env_to_bool(spotlight_env, strict: true)
       self.spotlight = spotlight_bool.nil? ? (spotlight_env || false) : spotlight_bool
       self.server_name = server_name_from_env
@@ -403,6 +407,8 @@ module Sentry
       self.traces_sampler = nil
       self.enable_tracing = nil
 
+      self.profiler_class = Sentry::Profiler
+
       @transport = Transport::Configuration.new
       @cron = Cron::Configuration.new
       @metrics = Metrics::Configuration.new
@@ -498,6 +504,18 @@ module Sentry
       @profiles_sample_rate = profiles_sample_rate
     end
 
+    def profiler_class=(profiler_class)
+      if profiler_class == Sentry::Vernier::Profiler
+        begin
+          require "vernier"
+        rescue LoadError
+          raise ArgumentError, "Please add the 'vernier' gem to your Gemfile to use the Vernier profiler with Sentry."
+        end
+      end
+
+      @profiler_class = profiler_class
+    end
+
     def sending_allowed?
       spotlight || sending_to_dsn_allowed?
     end

data/lib/sentry/cron/monitor_check_ins.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sentry
   module Cron
     module MonitorCheckIns

data/lib/sentry/envelope/item.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Sentry
+  # @api private
+  class Envelope::Item
+    STACKTRACE_FRAME_LIMIT_ON_OVERSIZED_PAYLOAD = 500
+    MAX_SERIALIZED_PAYLOAD_SIZE = 1024 * 1000
+
+    SIZE_LIMITS = Hash.new(MAX_SERIALIZED_PAYLOAD_SIZE).update(
+      "profile" => 1024 * 1000 * 50
+    )
+
+    attr_reader :size_limit, :headers, :payload, :type, :data_category
+
+    # rate limits and client reports use the data_category rather than envelope item type
+    def self.data_category(type)
+      case type
+      when "session", "attachment", "transaction", "profile", "span" then type
+      when "sessions" then "session"
+      when "check_in" then "monitor"
+      when "statsd", "metric_meta" then "metric_bucket"
+      when "event" then "error"
+      when "client_report" then "internal"
+      else "default"
+      end
+    end
+
+    def initialize(headers, payload)
+      @headers = headers
+      @payload = payload
+      @type = headers[:type] || "event"
+      @data_category = self.class.data_category(type)
+      @size_limit = SIZE_LIMITS[type]
+    end
+
+    def to_s
+      [JSON.generate(@headers), @payload.is_a?(String) ? @payload : JSON.generate(@payload)].join("\n")
+    end
+
+    def serialize
+      result = to_s
+
+      if result.bytesize > size_limit
+        remove_breadcrumbs!
+        result = to_s
+      end
+
+      if result.bytesize > size_limit
+        reduce_stacktrace!
+        result = to_s
+      end
+
+      [result, result.bytesize > size_limit]
+    end
+
+    def size_breakdown
+      payload.map do |key, value|
+        "#{key}: #{JSON.generate(value).bytesize}"
+      end.join(", ")
+    end
+
+    private
+
+    def remove_breadcrumbs!
+      if payload.key?(:breadcrumbs)
+        payload.delete(:breadcrumbs)
+      elsif payload.key?("breadcrumbs")
+        payload.delete("breadcrumbs")
+      end
+    end
+
+    def reduce_stacktrace!
+      if exceptions = payload.dig(:exception, :values) || payload.dig("exception", "values")
+        exceptions.each do |exception|
+          # in most cases there is only one exception (2 or 3 when have multiple causes), so we won't loop through this double condition much
+          traces = exception.dig(:stacktrace, :frames) || exception.dig("stacktrace", "frames")
+
+          if traces && traces.size > STACKTRACE_FRAME_LIMIT_ON_OVERSIZED_PAYLOAD
+            size_on_both_ends = STACKTRACE_FRAME_LIMIT_ON_OVERSIZED_PAYLOAD / 2
+            traces.replace(
+              traces[0..(size_on_both_ends - 1)] + traces[-size_on_both_ends..-1],
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sentry/envelope.rb

@@ -3,91 +3,6 @@
 module Sentry
   # @api private
   class Envelope
-    class Item
-      STACKTRACE_FRAME_LIMIT_ON_OVERSIZED_PAYLOAD = 500
-      MAX_SERIALIZED_PAYLOAD_SIZE = 1024 * 1000
-
-      attr_accessor :headers, :payload
-
-      def initialize(headers, payload)
-        @headers = headers
-        @payload = payload
-      end
-
-      def type
-        @headers[:type] || "event"
-      end
-
-      # rate limits and client reports use the data_category rather than envelope item type
-      def self.data_category(type)
-        case type
-        when "session", "attachment", "transaction", "profile", "span" then type
-        when "sessions" then "session"
-        when "check_in" then "monitor"
-        when "statsd", "metric_meta" then "metric_bucket"
-        when "event" then "error"
-        when "client_report" then "internal"
-        else "default"
-        end
-      end
-
-      def data_category
-        self.class.data_category(type)
-      end
-
-      def to_s
-        [JSON.generate(@headers), @payload.is_a?(String) ? @payload : JSON.generate(@payload)].join("\n")
-      end
-
-      def serialize
-        result = to_s
-
-        if result.bytesize > MAX_SERIALIZED_PAYLOAD_SIZE
-          remove_breadcrumbs!
-          result = to_s
-        end
-
-        if result.bytesize > MAX_SERIALIZED_PAYLOAD_SIZE
-          reduce_stacktrace!
-          result = to_s
-        end
-
-        [result, result.bytesize > MAX_SERIALIZED_PAYLOAD_SIZE]
-      end
-
-      def size_breakdown
-        payload.map do |key, value|
-          "#{key}: #{JSON.generate(value).bytesize}"
-        end.join(", ")
-      end
-
-      private
-
-      def remove_breadcrumbs!
-        if payload.key?(:breadcrumbs)
-          payload.delete(:breadcrumbs)
-        elsif payload.key?("breadcrumbs")
-          payload.delete("breadcrumbs")
-        end
-      end
-
-      def reduce_stacktrace!
-        if exceptions = payload.dig(:exception, :values) || payload.dig("exception", "values")
-          exceptions.each do |exception|
-            # in most cases there is only one exception (2 or 3 when have multiple causes), so we won't loop through this double condition much
-            traces = exception.dig(:stacktrace, :frames) || exception.dig("stacktrace", "frames")
-
-            if traces && traces.size > STACKTRACE_FRAME_LIMIT_ON_OVERSIZED_PAYLOAD
-              size_on_both_ends = STACKTRACE_FRAME_LIMIT_ON_OVERSIZED_PAYLOAD / 2
-              traces.replace(
-                traces[0..(size_on_both_ends - 1)] + traces[-size_on_both_ends..-1],
-              )
-            end
-          end
-        end
-      end
-    end
-
     attr_accessor :headers, :items
 
     def initialize(headers = {})
@@ -108,3 +23,5 @@ module Sentry
     end
   end
 end
+
+require_relative "envelope/item"

data/lib/sentry/excon/middleware.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Sentry
+  module Excon
+    OP_NAME = "http.client"
+
+    class Middleware < ::Excon::Middleware::Base
+      def initialize(stack)
+        super
+        @instrumenter = Instrumenter.new
+      end
+
+      def request_call(datum)
+        @instrumenter.start_transaction(datum)
+        @stack.request_call(datum)
+      end
+
+      def response_call(datum)
+        @instrumenter.finish_transaction(datum)
+        @stack.response_call(datum)
+      end
+    end
+
+    class Instrumenter
+      SPAN_ORIGIN = "auto.http.excon"
+      BREADCRUMB_CATEGORY = "http"
+
+      include Utils::HttpTracing
+
+      def start_transaction(env)
+        return unless Sentry.initialized?
+
+        current_span = Sentry.get_current_scope&.span
+        @span = current_span&.start_child(op: OP_NAME, start_timestamp: Sentry.utc_now.to_f, origin: SPAN_ORIGIN)
+
+        request_info = extract_request_info(env)
+
+        if propagate_trace?(request_info[:url])
+          set_propagation_headers(env[:headers])
+        end
+      end
+
+      def finish_transaction(response)
+        return unless @span
+
+        response_status = response[:response][:status]
+        request_info = extract_request_info(response)
+
+        if record_sentry_breadcrumb?
+          record_sentry_breadcrumb(request_info, response_status)
+        end
+
+        set_span_info(@span, request_info, response_status)
+      ensure
+        @span&.finish
+      end
+
+      private
+
+      def extract_request_info(env)
+        url = env[:scheme] + "://" + env[:hostname] + env[:path]
+        result = { method: env[:method].to_s.upcase, url: url }
+
+        if Sentry.configuration.send_default_pii
+          result[:query] = env[:query]
+
+          # Handle excon 1.0.0+
+          result[:query] = build_nested_query(result[:query]) unless result[:query].is_a?(String)
+
+          result[:body] = env[:body]
+        end
+
+        result
+      end
+    end
+  end
+end

data/lib/sentry/excon.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+Sentry.register_patch(:excon) do
+  if defined?(::Excon)
+    require "sentry/excon/middleware"
+    if Excon.defaults[:middlewares]
+      Excon.defaults[:middlewares] << Sentry::Excon::Middleware unless Excon.defaults[:middlewares].include?(Sentry::Excon::Middleware)
+    end
+  end
+end

data/lib/sentry/interfaces/single_exception.rb

@@ -7,8 +7,8 @@ module Sentry
     include CustomInspection
 
     SKIP_INSPECTION_ATTRIBUTES = [:@stacktrace]
-    PROBLEMATIC_LOCAL_VALUE_REPLACEMENT = "[ignored due to error]".freeze
-    OMISSION_MARK = "...".freeze
+    PROBLEMATIC_LOCAL_VALUE_REPLACEMENT = "[ignored due to error]"
+    OMISSION_MARK = "..."
     MAX_LOCAL_BYTES = 1024
 
     attr_reader :type, :module, :thread_id, :stacktrace, :mechanism

data/lib/sentry/profiler/helpers.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "securerandom"
+
+module Sentry
+  class Profiler
+    module Helpers
+      def in_app?(abs_path)
+        abs_path.match?(@in_app_pattern)
+      end
+
+      # copied from stacktrace.rb since I don't want to touch existing code
+      # TODO-neel-profiler try to fetch this from stackprof once we patch
+      # the native extension
+      def compute_filename(abs_path, in_app)
+        return nil if abs_path.nil?
+
+        under_project_root = @project_root && abs_path.start_with?(@project_root)
+
+        prefix =
+          if under_project_root && in_app
+            @project_root
+          else
+            longest_load_path = $LOAD_PATH.select { |path| abs_path.start_with?(path.to_s) }.max_by(&:size)
+
+            if under_project_root
+              longest_load_path || @project_root
+            else
+              longest_load_path
+            end
+          end
+
+        prefix ? abs_path[prefix.to_s.chomp(File::SEPARATOR).length + 1..-1] : abs_path
+      end
+
+      def split_module(name)
+        # last module plus class/instance method
+        i = name.rindex("::")
+        function = i ? name[(i + 2)..-1] : name
+        mod = i ? name[0...i] : nil
+
+        [function, mod]
+      end
+    end
+  end
+end

data/lib/sentry/profiler.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 
 require "securerandom"
+require_relative "profiler/helpers"
 
 module Sentry
   class Profiler
+    include Profiler::Helpers
+
     VERSION = "1"
     PLATFORM = "ruby"
     # 101 Hz in microseconds
@@ -44,6 +47,10 @@ module Sentry
       log("Stopped")
     end
 
+    def active_thread_id
+      "0"
+    end
+
     # Sets initial sampling decision of the profile.
     # @return [void]
     def set_initial_sample_decision(transaction_sampled)
@@ -188,43 +195,6 @@ module Sentry
       Sentry.logger.debug(LOGGER_PROGNAME) { "[Profiler] #{message}" }
     end
 
-    def in_app?(abs_path)
-      abs_path.match?(@in_app_pattern)
-    end
-
-    # copied from stacktrace.rb since I don't want to touch existing code
-    # TODO-neel-profiler try to fetch this from stackprof once we patch
-    # the native extension
-    def compute_filename(abs_path, in_app)
-      return nil if abs_path.nil?
-
-      under_project_root = @project_root && abs_path.start_with?(@project_root)
-
-      prefix =
-        if under_project_root && in_app
-          @project_root
-        else
-          longest_load_path = $LOAD_PATH.select { |path| abs_path.start_with?(path.to_s) }.max_by(&:size)
-
-          if under_project_root
-            longest_load_path || @project_root
-          else
-            longest_load_path
-          end
-        end
-
-      prefix ? abs_path[prefix.to_s.chomp(File::SEPARATOR).length + 1..-1] : abs_path
-    end
-
-    def split_module(name)
-      # last module plus class/instance method
-      i = name.rindex("::")
-      function = i ? name[(i + 2)..-1] : name
-      mod = i ? name[0...i] : nil
-
-      [function, mod]
-    end
-
     def record_lost_event(reason)
       Sentry.get_current_client&.transport&.record_lost_event(reason, "profile")
     end

data/lib/sentry/rack/capture_exceptions.rb

@@ -54,7 +54,7 @@ module Sentry
       end
 
       def transaction_op
-        "http.server".freeze
+        "http.server"
       end
 
       def capture_exception(exception, env)

data/lib/sentry/rspec.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+RSpec::Matchers.define :include_sentry_event do |event_message = "", **opts|
+  match do |sentry_events|
+    @expected_exception = expected_exception(**opts)
+    @context = context(**opts)
+    @tags = tags(**opts)
+
+    @expected_event = expected_event(event_message)
+    @matched_event = find_matched_event(event_message, sentry_events)
+
+    return false unless @matched_event
+
+    [verify_context(), verify_tags()].all?
+  end
+
+  chain :with_context do |context|
+    @context = context
+  end
+
+  chain :with_tags do |tags|
+    @tags = tags
+  end
+
+  failure_message do |sentry_events|
+    info = ["Failed to find event matching:\n"]
+    info << "  message: #{@expected_event.message.inspect}"
+    info << "  exception: #{@expected_exception.inspect}"
+    info << "  context: #{@context.inspect}"
+    info << "  tags: #{@tags.inspect}"
+    info << "\n"
+    info << "Captured events:\n"
+    info << dump_events(sentry_events)
+    info.join("\n")
+  end
+
+  def expected_event(event_message)
+    if @expected_exception
+      Sentry.get_current_client.event_from_exception(@expected_exception)
+    else
+      Sentry.get_current_client.event_from_message(event_message)
+    end
+  end
+
+  def expected_exception(**opts)
+    opts[:exception].new(opts[:message]) if opts[:exception]
+  end
+
+  def context(**opts)
+    opts.fetch(:context, @context || {})
+  end
+
+  def tags(**opts)
+    opts.fetch(:tags, @tags || {})
+  end
+
+  def find_matched_event(event_message, sentry_events)
+    @matched_event ||= sentry_events
+      .find { |event|
+        if @expected_exception
+          # Is it OK that we only compare the first exception?
+          event_exception = event.exception.values.first
+          expected_event_exception = @expected_event.exception.values.first
+
+          event_exception.type == expected_event_exception.type && event_exception.value == expected_event_exception.value
+        else
+          event.message == @expected_event.message
+        end
+      }
+  end
+
+  def dump_events(sentry_events)
+    sentry_events.map(&Kernel.method(:Hash)).map do |hash|
+      hash.select { |k, _| [:message, :contexts, :tags, :exception].include?(k) }
+    end.map do |hash|
+      JSON.pretty_generate(hash)
+    end.join("\n\n")
+  end
+
+  def verify_context
+    return true if @context.empty?
+
+    @matched_event.contexts.any? { |key, value| value == @context[key] }
+  end
+
+  def verify_tags
+    return true if @tags.empty?
+
+    @tags.all? { |key, value| @matched_event.tags.include?(key) && @matched_event.tags[key] == value }
+  end
+end

data/lib/sentry/session_flusher.rb

@@ -10,6 +10,7 @@ module Sentry
       @pending_aggregates = {}
       @release = configuration.release
       @environment = configuration.environment
+      @mutex = Mutex.new
 
       log_debug("[Sessions] Sessions won't be captured without a valid release") unless @release
     end
@@ -18,7 +19,6 @@ module Sentry
       return if @pending_aggregates.empty?
 
       @client.capture_envelope(pending_envelope)
-      @pending_aggregates = {}
     end
 
     alias_method :run, :flush
@@ -42,11 +42,15 @@ module Sentry
     end
 
     def pending_envelope
-      envelope = Envelope.new
+      aggregates = @mutex.synchronize do
+        aggregates = @pending_aggregates.values
+        @pending_aggregates = {}
+        aggregates
+      end
 
+      envelope = Envelope.new
       header = { type: "sessions" }
-      payload = { attrs: attrs, aggregates: @pending_aggregates.values }
-
+      payload = { attrs: attrs, aggregates: aggregates }
       envelope.add_item(header, payload)
       envelope
     end

data/lib/sentry/test_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sentry
   module TestHelper
     DUMMY_DSN = "http://12345:67890@sentry.localdomain/sentry/42"

data/lib/sentry/transaction.rb

@@ -9,7 +9,7 @@ module Sentry
     # @deprecated Use Sentry::PropagationContext::SENTRY_TRACE_REGEXP instead.
     SENTRY_TRACE_REGEXP = PropagationContext::SENTRY_TRACE_REGEXP
 
-    UNLABELD_NAME = "<unlabeled transaction>".freeze
+    UNLABELD_NAME = "<unlabeled transaction>"
     MESSAGE_PREFIX = "[Tracing]"
 
     # https://develop.sentry.dev/sdk/event-payloads/transaction/#transaction-annotations
@@ -85,7 +85,7 @@ module Sentry
       @effective_sample_rate = nil
       @contexts = {}
       @measurements = {}
-      @profiler = Profiler.new(@configuration)
+      @profiler = @configuration.profiler_class.new(@configuration)
       init_span_recorder
     end
 

data/lib/sentry/transaction_event.rb

@@ -74,8 +74,7 @@ module Sentry
           id: event_id,
           name: transaction.name,
           trace_id: transaction.trace_id,
-          # TODO-neel-profiler stubbed for now, see thread_id note in profiler.rb
-          active_thead_id: "0"
+          active_thread_id: transaction.profiler.active_thread_id.to_s
         }
       )
 

data/lib/sentry/utils/http_tracing.rb

@@ -19,7 +19,7 @@ module Sentry
         crumb = Sentry::Breadcrumb.new(
           level: :info,
           category: self.class::BREADCRUMB_CATEGORY,
-          type: :info,
+          type: "info",
           data: { status: response_status, **request_info }
         )
 
@@ -36,6 +36,25 @@ module Sentry
           Sentry.configuration.propagate_traces &&
           Sentry.configuration.trace_propagation_targets.any? { |target| url.match?(target) }
       end
+
+      # Kindly borrowed from Rack::Utils
+      def build_nested_query(value, prefix = nil)
+        case value
+        when Array
+          value.map { |v|
+            build_nested_query(v, "#{prefix}[]")
+          }.join("&")
+        when Hash
+          value.map { |k, v|
+            build_nested_query(v, prefix ? "#{prefix}[#{k}]" : k)
+          }.delete_if(&:empty?).join("&")
+        when nil
+          URI.encode_www_form_component(prefix)
+        else
+          raise ArgumentError, "value must be a Hash" if prefix.nil?
+          "#{URI.encode_www_form_component(prefix)}=#{URI.encode_www_form_component(value)}"
+        end
+      end
     end
   end
 end

data/lib/sentry/vernier/output.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require "json"
+require "rbconfig"
+
+module Sentry
+  module Vernier
+    class Output
+      include Profiler::Helpers
+
+      attr_reader :profile
+
+      def initialize(profile, project_root:, in_app_pattern:, app_dirs_pattern:)
+        @profile = profile
+        @project_root = project_root
+        @in_app_pattern = in_app_pattern
+        @app_dirs_pattern = app_dirs_pattern
+      end
+
+      def to_h
+        @to_h ||= {
+          frames: frames,
+          stacks: stacks,
+          samples: samples,
+          thread_metadata: thread_metadata
+        }
+      end
+
+      private
+
+      def thread_metadata
+        profile.threads.map { |thread_id, thread_info|
+          [thread_id, { name: thread_info[:name] }]
+        }.to_h
+      end
+
+      def samples
+        profile.threads.flat_map { |thread_id, thread_info|
+          started_at = thread_info[:started_at]
+          samples, timestamps = thread_info.values_at(:samples, :timestamps)
+
+          samples.zip(timestamps).map { |stack_id, timestamp|
+            elapsed_since_start_ns = timestamp - started_at
+
+            next if elapsed_since_start_ns < 0
+
+            {
+              thread_id: thread_id.to_s,
+              stack_id: stack_id,
+              elapsed_since_start_ns: elapsed_since_start_ns.to_s
+            }
+          }.compact
+        }
+      end
+
+      def frames
+        funcs = stack_table_hash[:frame_table].fetch(:func)
+        lines = stack_table_hash[:func_table].fetch(:first_line)
+
+        funcs.map do |idx|
+          function, mod = split_module(stack_table_hash[:func_table][:name][idx])
+
+          abs_path = stack_table_hash[:func_table][:filename][idx]
+          in_app = in_app?(abs_path)
+          filename = compute_filename(abs_path, in_app)
+
+          {
+            function: function,
+            module: mod,
+            filename: filename,
+            abs_path: abs_path,
+            lineno: (lineno = lines[idx]) > 0 ? lineno : nil,
+            in_app: in_app
+          }.compact
+        end
+      end
+
+      def stacks
+        profile._stack_table.stack_count.times.map do |stack_id|
+          profile.stack(stack_id).frames.map(&:idx)
+        end
+      end
+
+      def stack_table_hash
+        @stack_table_hash ||= profile._stack_table.to_h
+      end
+    end
+  end
+end

data/lib/sentry/vernier/profiler.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+require "securerandom"
+require_relative "../profiler/helpers"
+require_relative "output"
+
+module Sentry
+  module Vernier
+    class Profiler
+      EMPTY_RESULT = {}.freeze
+
+      attr_reader :started, :event_id, :result
+
+      def initialize(configuration)
+        @event_id = SecureRandom.uuid.delete("-")
+
+        @started = false
+        @sampled = nil
+
+        @profiling_enabled = defined?(Vernier) && configuration.profiling_enabled?
+        @profiles_sample_rate = configuration.profiles_sample_rate
+        @project_root = configuration.project_root
+        @app_dirs_pattern = configuration.app_dirs_pattern
+        @in_app_pattern = Regexp.new("^(#{@project_root}/)?#{@app_dirs_pattern}")
+      end
+
+      def set_initial_sample_decision(transaction_sampled)
+        unless @profiling_enabled
+          @sampled = false
+          return
+        end
+
+        unless transaction_sampled
+          @sampled = false
+          log("Discarding profile because transaction not sampled")
+          return
+        end
+
+        case @profiles_sample_rate
+        when 0.0
+          @sampled = false
+          log("Discarding profile because sample_rate is 0")
+          return
+        when 1.0
+          @sampled = true
+          return
+        else
+          @sampled = Random.rand < @profiles_sample_rate
+        end
+
+        log("Discarding profile due to sampling decision") unless @sampled
+      end
+
+      def start
+        return unless @sampled
+        return if @started
+
+        @started = ::Vernier.start_profile
+
+        log("Started")
+
+        @started
+      rescue RuntimeError => e
+        # TODO: once Vernier raises something more dedicated, we should catch that instead
+        if e.message.include?("Profile already started")
+          log("Not started since running elsewhere")
+        else
+          log("Failed to start: #{e.message}")
+        end
+      end
+
+      def stop
+        return unless @sampled
+        return unless @started
+
+        @result = ::Vernier.stop_profile
+
+        log("Stopped")
+      rescue RuntimeError => e
+        if e.message.include?("Profile not started")
+          log("Not stopped since not started")
+        else
+          log("Failed to stop Vernier: #{e.message}")
+        end
+      end
+
+      def active_thread_id
+        Thread.current.object_id
+      end
+
+      def to_hash
+        return EMPTY_RESULT unless @started
+
+        unless @sampled
+          record_lost_event(:sample_rate)
+          return EMPTY_RESULT
+        end
+
+        { **profile_meta, profile: output.to_h }
+      end
+
+      private
+
+      def log(message)
+        Sentry.logger.debug(LOGGER_PROGNAME) { "[Profiler::Vernier] #{message}" }
+      end
+
+      def record_lost_event(reason)
+        Sentry.get_current_client&.transport&.record_lost_event(reason, "profile")
+      end
+
+      def profile_meta
+        {
+          event_id: @event_id,
+          version: "1",
+          platform: "ruby"
+        }
+      end
+
+      def output
+        @output ||= Output.new(
+          result,
+          project_root: @project_root,
+          app_dirs_pattern: @app_dirs_pattern,
+          in_app_pattern: @in_app_pattern
+        )
+      end
+    end
+  end
+end

data/lib/sentry/version.rb

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

data/lib/sentry-ruby.rb

@@ -25,6 +25,7 @@ require "sentry/session_flusher"
 require "sentry/backpressure_monitor"
 require "sentry/cron/monitor_check_ins"
 require "sentry/metrics"
+require "sentry/vernier/profiler"
 
 [
   "sentry/rake",
@@ -41,14 +42,16 @@ module Sentry
 
   CAPTURED_SIGNATURE = :@__sentry_captured
 
-  LOGGER_PROGNAME = "sentry".freeze
+  LOGGER_PROGNAME = "sentry"
 
-  SENTRY_TRACE_HEADER_NAME = "sentry-trace".freeze
+  SENTRY_TRACE_HEADER_NAME = "sentry-trace"
 
-  BAGGAGE_HEADER_NAME = "baggage".freeze
+  BAGGAGE_HEADER_NAME = "baggage"
 
   THREAD_LOCAL = :sentry_hub
 
+  MUTEX = Mutex.new
+
   class << self
     # @!visibility private
     def exception_locals_tp
@@ -274,8 +277,10 @@ module Sentry
 
       @background_worker.shutdown
 
-      @main_hub = nil
-      Thread.current.thread_variable_set(THREAD_LOCAL, nil)
+      MUTEX.synchronize do
+        @main_hub = nil
+        Thread.current.thread_variable_set(THREAD_LOCAL, nil)
+      end
     end
 
     # Returns true if the SDK is initialized.
@@ -302,7 +307,7 @@ module Sentry
     #
     # @return [Hub]
     def get_main_hub
-      @main_hub
+      MUTEX.synchronize { @main_hub }
     end
 
     # Takes an instance of Sentry::Breadcrumb and stores it to the current active scope.
@@ -609,3 +614,4 @@ require "sentry/redis"
 require "sentry/puma"
 require "sentry/graphql"
 require "sentry/faraday"
+require "sentry/excon"

data/sentry-ruby-core.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "lib/sentry/version"
 
 Gem::Specification.new do |spec|

data/sentry-ruby.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "lib/sentry/version"
 
 Gem::Specification.new do |spec|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-ruby-core
 version: !ruby/object:Gem::Version
-  version: 5.20.1
+  version: 5.22.0
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-27 00:00:00.000000000 Z
+date: 2024-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sentry-ruby
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.20.1
+        version: 5.22.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.20.1
+        version: 5.22.0
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -77,9 +77,12 @@ files:
 - lib/sentry/cron/monitor_schedule.rb
 - lib/sentry/dsn.rb
 - lib/sentry/envelope.rb
+- lib/sentry/envelope/item.rb
 - lib/sentry/error_event.rb
 - lib/sentry/event.rb
 - lib/sentry/exceptions.rb
+- lib/sentry/excon.rb
+- lib/sentry/excon/middleware.rb
 - lib/sentry/faraday.rb
 - lib/sentry/graphql.rb
 - lib/sentry/hub.rb
@@ -106,6 +109,7 @@ files:
 - lib/sentry/metrics/timing.rb
 - lib/sentry/net/http.rb
 - lib/sentry/profiler.rb
+- lib/sentry/profiler/helpers.rb
 - lib/sentry/propagation_context.rb
 - lib/sentry/puma.rb
 - lib/sentry/rack.rb
@@ -113,6 +117,7 @@ files:
 - lib/sentry/rake.rb
 - lib/sentry/redis.rb
 - lib/sentry/release_detector.rb
+- lib/sentry/rspec.rb
 - lib/sentry/scope.rb
 - lib/sentry/session.rb
 - lib/sentry/session_flusher.rb
@@ -135,6 +140,8 @@ files:
 - lib/sentry/utils/logging_helper.rb
 - lib/sentry/utils/real_ip.rb
 - lib/sentry/utils/request_id.rb
+- lib/sentry/vernier/output.rb
+- lib/sentry/vernier/profiler.rb
 - lib/sentry/version.rb
 - sentry-ruby-core.gemspec
 - sentry-ruby.gemspec
@@ -160,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.5.22
 signing_key: 
 specification_version: 4
 summary: A gem that provides a client interface for the Sentry error logger