sentry-ruby 5.19.0 → 5.21.0

data/lib/sentry/release_detector.rb

@@ -13,12 +13,12 @@ module Sentry
 
       def detect_release_from_heroku(running_on_heroku)
         return unless running_on_heroku
-        ENV['HEROKU_SLUG_COMMIT']
+        ENV["HEROKU_SLUG_COMMIT"]
       end
 
       def detect_release_from_capistrano(project_root)
-        revision_file = File.join(project_root, 'REVISION')
-        revision_log = File.join(project_root, '..', 'revisions.log')
+        revision_file = File.join(project_root, "REVISION")
+        revision_log = File.join(project_root, "..", "revisions.log")
 
         if File.exist?(revision_file)
           File.read(revision_file).strip
@@ -32,7 +32,7 @@ module Sentry
       end
 
       def detect_release_from_env
-        ENV['SENTRY_RELEASE']
+        ENV["SENTRY_RELEASE"]
       end
     end
   end

data/lib/sentry/scope.rb

@@ -62,6 +62,7 @@ module Sentry
 
       if span
         event.contexts[:trace] ||= span.get_trace_context
+        event.dynamic_sampling_context ||= span.get_dynamic_sampling_context
       else
         event.contexts[:trace] ||= propagation_context.get_trace_context
         event.dynamic_sampling_context ||= propagation_context.get_dynamic_sampling_context

data/lib/sentry/session_flusher.rb

@@ -44,7 +44,7 @@ module Sentry
     def pending_envelope
       envelope = Envelope.new
 
-      header = { type: 'sessions' }
+      header = { type: "sessions" }
       payload = { attrs: attrs, aggregates: @pending_aggregates.values }
 
       envelope.add_item(header, payload)

data/lib/sentry/span.rb

@@ -160,6 +160,12 @@ module Sentry
       transaction.get_baggage&.serialize
     end
 
+    # Returns the Dynamic Sampling Context from the transaction baggage.
+    # @return [Hash, nil]
+    def get_dynamic_sampling_context
+      transaction.get_baggage&.dynamic_sampling_context
+    end
+
     # @return [Hash]
     def to_hash
       hash = {

data/lib/sentry/test_helper.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module Sentry
   module TestHelper
-    DUMMY_DSN = 'http://12345:67890@sentry.localdomain/sentry/42'
+    DUMMY_DSN = "http://12345:67890@sentry.localdomain/sentry/42"
 
     # Alters the existing SDK configuration with test-suitable options. Mainly:
     # - Sets a dummy DSN instead of `nil` or an actual DSN.

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
 
@@ -265,8 +265,8 @@ module Sentry
       else
         is_backpressure = Sentry.backpressure_monitor&.downsample_factor&.positive?
         reason = is_backpressure ? :backpressure : :sample_rate
-        hub.current_client.transport.record_lost_event(reason, 'transaction')
-        hub.current_client.transport.record_lost_event(reason, 'span')
+        hub.current_client.transport.record_lost_event(reason, "transaction")
+        hub.current_client.transport.record_lost_event(reason, "span")
       end
     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/transport/http_transport.rb

@@ -7,7 +7,7 @@ module Sentry
   class HTTPTransport < Transport
     GZIP_ENCODING = "gzip"
     GZIP_THRESHOLD = 1024 * 30
-    CONTENT_TYPE = 'application/x-sentry-envelope'
+    CONTENT_TYPE = "application/x-sentry-envelope"
 
     DEFAULT_DELAY = 60
     RETRY_AFTER_HEADER = "retry-after"
@@ -38,13 +38,13 @@ module Sentry
       end
 
       headers = {
-        'Content-Type' => CONTENT_TYPE,
-        'Content-Encoding' => encoding,
-        'User-Agent' => USER_AGENT
+        "Content-Type" => CONTENT_TYPE,
+        "Content-Encoding" => encoding,
+        "User-Agent" => USER_AGENT
       }
 
       auth_header = generate_auth_header
-      headers['X-Sentry-Auth'] = auth_header if auth_header
+      headers["X-Sentry-Auth"] = auth_header if auth_header
 
       response = conn.start do |http|
         request = ::Net::HTTP::Post.new(endpoint, headers)
@@ -60,7 +60,7 @@ module Sentry
       else
         error_info = "the server responded with status #{response.code}"
         error_info += "\nbody: #{response.body}"
-        error_info += " Error in headers is: #{response['x-sentry-error']}" if response['x-sentry-error']
+        error_info += " Error in headers is: #{response['x-sentry-error']}" if response["x-sentry-error"]
 
         raise Sentry::ExternalError, error_info
       end
@@ -78,13 +78,13 @@ module Sentry
 
       now = Sentry.utc_now.to_i
       fields = {
-        'sentry_version' => PROTOCOL_VERSION,
-        'sentry_client' => USER_AGENT,
-        'sentry_timestamp' => now,
-        'sentry_key' => @dsn.public_key
+        "sentry_version" => PROTOCOL_VERSION,
+        "sentry_client" => USER_AGENT,
+        "sentry_timestamp" => now,
+        "sentry_key" => @dsn.public_key
       }
-      fields['sentry_secret'] = @dsn.secret_key if @dsn.secret_key
-      'Sentry ' + fields.map { |key, value| "#{key}=#{value}" }.join(', ')
+      fields["sentry_secret"] = @dsn.secret_key if @dsn.secret_key
+      "Sentry " + fields.map { |key, value| "#{key}=#{value}" }.join(", ")
     end
 
     def conn

data/lib/sentry/transport.rb

@@ -5,7 +5,7 @@ require "sentry/envelope"
 
 module Sentry
   class Transport
-    PROTOCOL_VERSION = '7'
+    PROTOCOL_VERSION = "7"
     USER_AGENT = "sentry-ruby/#{Sentry::VERSION}"
     CLIENT_REPORT_INTERVAL = 30
 
@@ -134,13 +134,13 @@ module Sentry
       envelope = Envelope.new(envelope_headers)
 
       envelope.add_item(
-        { type: item_type, content_type: 'application/json' },
+        { type: item_type, content_type: "application/json" },
         event_payload
       )
 
       if event.is_a?(TransactionEvent) && event.profile
         envelope.add_item(
-          { type: 'profile', content_type: 'application/json' },
+          { type: "profile", content_type: "application/json" },
           event.profile
         )
       end
@@ -185,7 +185,7 @@ module Sentry
         { reason: reason, category: category, quantity: val }
       end
 
-      item_header = { type: 'client_report' }
+      item_header = { type: "client_report" }
       item_payload = {
         timestamp: Sentry.utc_now.iso8601,
         discarded_events: discarded_events_hash

data/lib/sentry/utils/env_helper.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Sentry
+  module Utils
+    module EnvHelper
+      TRUTHY_ENV_VALUES = %w[t true yes y 1 on].freeze
+      FALSY_ENV_VALUES = %w[f false no n 0 off].freeze
+
+      def self.env_to_bool(value, strict: false)
+        value = value.to_s
+        normalized = value.downcase
+
+        return false if FALSY_ENV_VALUES.include?(normalized)
+
+        return true if TRUTHY_ENV_VALUES.include?(normalized)
+
+        strict ? nil : !(value.nil? || value.empty?)
+      end
+    end
+  end
+end

data/lib/sentry/utils/real_ip.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'ipaddr'
+require "ipaddr"
 
 # Based on ActionDispatch::RemoteIp. All security-related precautions from that
 # middleware have been removed, because the Event IP just needs to be accurate,

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,125 @@
+# 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
+
+        ::Vernier.start_profile
+        @started = true
+
+        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")
+      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.19.0"
+  VERSION = "5.21.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,11 +42,11 @@ 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
 
@@ -563,7 +564,7 @@ module Sentry
     #
     # @return [String]
     def get_trace_propagation_meta
-      return '' unless initialized?
+      return "" unless initialized?
       get_current_hub.get_trace_propagation_meta
     end
 

data/sentry-ruby-core.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "lib/sentry/version"
 
 Gem::Specification.new do |spec|
@@ -12,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.platform = Gem::Platform::RUBY
   spec.required_ruby_version = '>= 2.4'
   spec.extra_rdoc_files = ["README.md", "LICENSE.txt"]
-  spec.files = `git ls-files | grep -Ev '^(spec|benchmarks|examples)'`.split("\n")
+  spec.files = `git ls-files | grep -Ev '^(spec|benchmarks|examples|\.rubocop\.yml)'`.split("\n")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage

data/sentry-ruby.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "lib/sentry/version"
 
 Gem::Specification.new do |spec|
@@ -11,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.platform = Gem::Platform::RUBY
   spec.required_ruby_version = '>= 2.4'
   spec.extra_rdoc_files = ["README.md", "LICENSE.txt"]
-  spec.files = `git ls-files | grep -Ev '^(spec|benchmarks|examples)'`.split("\n")
+  spec.files = `git ls-files | grep -Ev '^(spec|benchmarks|examples|\.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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-ruby
 version: !ruby/object:Gem::Version
-  version: 5.19.0
+  version: 5.21.0
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-13 00:00:00.000000000 Z
+date: 2024-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -83,6 +83,7 @@ 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
@@ -112,6 +113,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
@@ -135,23 +137,26 @@ files:
 - lib/sentry/utils/argument_checking_helper.rb
 - lib/sentry/utils/custom_inspection.rb
 - lib/sentry/utils/encoding_helper.rb
+- lib/sentry/utils/env_helper.rb
 - lib/sentry/utils/exception_cause_chain.rb
 - lib/sentry/utils/http_tracing.rb
 - 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
-homepage: https://github.com/getsentry/sentry-ruby/tree/5.19.0/sentry-ruby
+homepage: https://github.com/getsentry/sentry-ruby/tree/5.21.0/sentry-ruby
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/getsentry/sentry-ruby/tree/5.19.0/sentry-ruby
-  source_code_uri: https://github.com/getsentry/sentry-ruby/tree/5.19.0/sentry-ruby
-  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/5.19.0/CHANGELOG.md
+  homepage_uri: https://github.com/getsentry/sentry-ruby/tree/5.21.0/sentry-ruby
+  source_code_uri: https://github.com/getsentry/sentry-ruby/tree/5.21.0/sentry-ruby
+  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/5.21.0/CHANGELOG.md
   bug_tracker_uri: https://github.com/getsentry/sentry-ruby/issues
-  documentation_uri: http://www.rubydoc.info/gems/sentry-ruby/5.19.0
+  documentation_uri: http://www.rubydoc.info/gems/sentry-ruby/5.21.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -167,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.16
 signing_key: 
 specification_version: 4
 summary: A gem that provides a client interface for the Sentry error logger