sentry-ruby-core 6.4.1 → 6.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a700d6777f6c9ff19d7878858806085e70d6d8f003995d44c15d37a29c125f87
-  data.tar.gz: a463f19fe5fe50719398470b2926509ebd5708cb7702948207d164846c873a29
+  metadata.gz: e2784eb13a9b7e212a5bc3c607cd305e835631596418688c3a1e0e2fbcdfaa7a
+  data.tar.gz: 4d15760d10a1093a747d74caa928b6812d8b5b24c81698c01833bc52b5a775a3
 SHA512:
-  metadata.gz: 1953d81802e79fd96c1187b6f084bf952f2a1082e7a60293570781777423cdd419062fd235741b3e7bd90f1362966e8dc9ed8a26d6ae9d72a6d13f8afa0addd4
-  data.tar.gz: 9e6975759fb9a06307ab201f7377822f5fa4d4f407eacb656371f083cce2ff65ba98c0b4cc418f81e608d0e8e78449ee9c53e3c26e6706a3b8b4bfe8e77c37d2
+  metadata.gz: cd34baa8e81dbe92f33bb98ceedb8f526efd1406ca724e98eb86a0ea8d78585e31302037394961679850b11766a2ad777f9987dca3a94075421330043764ee10
+  data.tar.gz: f3cca1b504d70ac8f9f6e2083826c4f2fbcc7df5bf8da3438daf0a74ec1c7034ba4c0a98859ad291ac7cd453e88ca7be4af2a5722c1bb432f096f56e014ce83d

data/lib/sentry/baggage.rb

@@ -25,7 +25,7 @@ module Sentry
     # The presence of a Sentry item makes the baggage object immutable.
     #
     # @param header [String] The incoming Baggage header string.
-    # @return [Baggage, nil]
+    # @return [Baggage]
     def self.from_incoming_header(header)
       items = {}
       mutable = true

data/lib/sentry/configuration.rb

@@ -371,6 +371,24 @@ module Sentry
     # @return [Proc, nil]
     attr_reader :std_lib_logger_filter
 
+    # An optional organization ID. The SDK will try to extract it from the DSN in most cases
+    # but you can provide it explicitly for self-hosted and Relay setups.
+    # This value is used for trace propagation and for features like strict_trace_continuation.
+    # @return [String, nil]
+    attr_reader :org_id
+
+    # If set to true, the SDK will only continue a trace if the org_id of the incoming trace found in the
+    # baggage header matches the org_id of the current Sentry client and only if BOTH are present.
+    #
+    # If set to false, consistency of org_id will only be enforced if both are present.
+    # If either are missing, the trace will be continued.
+    #
+    # The client's organization ID is extracted from the DSN or can be set with the org_id option.
+    # If the organization IDs do not match, the SDK will start a new trace instead of continuing the incoming one.
+    # This is useful to prevent traces of unknown third-party services from being continued in your application.
+    # @return [Boolean]
+    attr_accessor :strict_trace_continuation
+
     # these are not config options
     # @!visibility private
     attr_reader :errors, :gem_specs
@@ -520,6 +538,8 @@ module Sentry
       self.trusted_proxies = []
       self.dsn = ENV["SENTRY_DSN"]
       self.capture_queue_time = true
+      self.org_id = nil
+      self.strict_trace_continuation = false
 
       spotlight_env = ENV["SENTRY_SPOTLIGHT"]
       spotlight_bool = Sentry::Utils::EnvHelper.env_to_bool(spotlight_env, strict: true)
@@ -673,6 +693,16 @@ module Sentry
       @profiler_class = profiler_class
     end
 
+    def org_id=(value)
+      @org_id = value&.to_s
+    end
+
+    # Returns the effective org ID, preferring the explicit config option over the DSN-parsed value.
+    # @return [String, nil]
+    def effective_org_id
+      org_id || dsn&.org_id
+    end
+
     def sending_allowed?
       spotlight || sending_to_dsn_allowed?
     end

data/lib/sentry/dsn.rb

@@ -11,8 +11,9 @@ module Sentry
     REQUIRED_ATTRIBUTES = %w[host path public_key project_id].freeze
     LOCALHOST_NAMES = %w[localhost 127.0.0.1 ::1 [::1]].freeze
     LOCALHOST_PATTERN = /\.local(host|domain)?$/i
+    ORG_ID_REGEX = /\Ao(\d+)\./
 
-    attr_reader :scheme, :secret_key, :port, *REQUIRED_ATTRIBUTES
+    attr_reader :scheme, :secret_key, :port, :org_id, *REQUIRED_ATTRIBUTES
 
     def initialize(dsn_string)
       @raw_value = dsn_string
@@ -31,6 +32,8 @@ module Sentry
       @host = uri.host
       @port = uri.port if uri.port
       @path = uri_path.join("/")
+
+      @org_id = extract_org_id_from_host
     end
 
     def valid?
@@ -101,5 +104,14 @@ module Sentry
 
       "Sentry " + fields.map { |key, value| "#{key}=#{value}" }.join(", ")
     end
+
+    private
+
+    def extract_org_id_from_host
+      return nil unless @host
+
+      match = ORG_ID_REGEX.match(@host)
+      match ? match[1] : nil
+    end
   end
 end

data/lib/sentry/exceptions.rb

@@ -6,4 +6,7 @@ module Sentry
 
   class ExternalError < Error
   end
+
+  class SizeExceededError < ExternalError
+  end
 end

data/lib/sentry/metric_event.rb

@@ -43,7 +43,7 @@ module Sentry
     private
 
     def serialize_attributes
-      @attributes.transform_values! { |v| attribute_hash(v) }
+      @attributes.transform_values { |v| attribute_hash(v) }
     end
   end
 end

data/lib/sentry/propagation_context.rb

@@ -53,6 +53,44 @@ module Sentry
       [trace_id, parent_span_id, parent_sampled]
     end
 
+    # Determines whether we should continue an incoming trace based on org_id matching
+    # and the strict_trace_continuation configuration option.
+    #
+    # @param incoming_baggage [Baggage] the baggage from the incoming request
+    # @return [Boolean]
+    def self.should_continue_trace?(incoming_baggage)
+      return true unless Sentry.initialized?
+
+      configuration = Sentry.configuration
+      sdk_org_id = configuration.effective_org_id
+      baggage_org_id = incoming_baggage.items["org_id"]
+
+      # Mismatched org IDs always start a new trace regardless of strict mode
+      if sdk_org_id && baggage_org_id && sdk_org_id != baggage_org_id
+        Sentry.sdk_logger.debug(LOGGER_PROGNAME) do
+          "Starting a new trace because org IDs don't match (incoming baggage org_id: #{baggage_org_id}, SDK org_id: #{sdk_org_id})"
+        end
+
+        return false
+      end
+
+      return true unless configuration.strict_trace_continuation
+
+      # In strict mode, both must be present and match (unless both are missing)
+      if sdk_org_id.nil? && baggage_org_id.nil?
+        true
+      elsif sdk_org_id.nil? || baggage_org_id.nil?
+        Sentry.sdk_logger.debug(LOGGER_PROGNAME) do
+          "Starting a new trace because strict trace continuation is enabled and one org ID is missing " \
+            "(incoming baggage org_id: #{baggage_org_id.inspect}, SDK org_id: #{sdk_org_id.inspect})"
+        end
+
+        false
+      else
+        true
+      end
+    end
+
     def self.extract_sample_rand_from_baggage(baggage, trace_id = nil)
       return unless baggage&.items
 
@@ -96,9 +134,7 @@ module Sentry
           sentry_trace_data = self.class.extract_sentry_trace(sentry_trace_header)
 
           if sentry_trace_data
-            @trace_id, @parent_span_id, @parent_sampled = sentry_trace_data
-
-            @baggage =
+            incoming_baggage =
               if baggage_header && !baggage_header.empty?
                 Baggage.from_incoming_header(baggage_header)
               else
@@ -108,10 +144,13 @@ module Sentry
                 Baggage.new({})
               end
 
-            @sample_rand = self.class.extract_sample_rand_from_baggage(@baggage, @trace_id)
-
-            @baggage.freeze!
-            @incoming_trace = true
+            if self.class.should_continue_trace?(incoming_baggage)
+              @trace_id, @parent_span_id, @parent_sampled = sentry_trace_data
+              @baggage = incoming_baggage
+              @sample_rand = self.class.extract_sample_rand_from_baggage(@baggage, @trace_id)
+              @baggage.freeze!
+              @incoming_trace = true
+            end
           end
         end
       end
@@ -162,7 +201,8 @@ module Sentry
         "sample_rand" => Utils::SampleRand.format(@sample_rand),
         "environment" => configuration.environment,
         "release" => configuration.release,
-        "public_key" => configuration.dsn&.public_key
+        "public_key" => configuration.dsn&.public_key,
+        "org_id" => configuration.effective_org_id
       }
 
       items.compact!

data/lib/sentry/release_detector.rb

@@ -13,7 +13,7 @@ module Sentry
 
       def detect_release_from_heroku(running_on_heroku)
         return unless running_on_heroku
-        ENV["HEROKU_SLUG_COMMIT"]
+        ENV["HEROKU_BUILD_COMMIT"] || ENV["HEROKU_SLUG_COMMIT"]
       end
 
       def detect_release_from_capistrano(project_root)

data/lib/sentry/scope.rb

@@ -135,6 +135,7 @@ module Sentry
       copy.session = session.deep_dup
       copy.propagation_context = propagation_context.deep_dup
       copy.attachments = attachments.dup
+      copy.event_processors = event_processors.dup
       copy
     end
 

data/lib/sentry/transaction.rb

@@ -295,7 +295,8 @@ module Sentry
         "sampled" => sampled&.to_s,
         "environment" => configuration&.environment,
         "release" => configuration&.release,
-        "public_key" => configuration&.dsn&.public_key
+        "public_key" => configuration&.dsn&.public_key,
+        "org_id" => configuration&.effective_org_id
       }
 
       items["transaction"] = name unless source_low_quality?

data/lib/sentry/transport/http_transport.rb

@@ -49,6 +49,12 @@ module Sentry
 
       if response.code.match?(/\A2\d{2}/)
         handle_rate_limited_response(response) if has_rate_limited_header?(response)
+      elsif response.code == "413"
+        error_message = "HTTP 413: Envelope dropped due to exceeded size limit"
+        error_message += " (body: #{response.body})" if response.body && !response.body.empty?
+        log_warn(error_message)
+
+        raise Sentry::SizeExceededError, error_message
       elsif response.code == "429"
         log_debug("the server responded with status 429")
         handle_rate_limited_response(response)

data/lib/sentry/transport.rb

@@ -19,7 +19,8 @@ module Sentry
       :before_send,
       :event_processor,
       :insufficient_data,
-      :backpressure
+      :backpressure,
+      :send_error
     ]
 
     include LoggingHelper
@@ -61,6 +62,10 @@ module Sentry
         log_debug("[Transport] Sending envelope with items [#{serialized_items.map(&:type).join(', ')}] #{envelope.event_id} to Sentry")
         send_data(data)
       end
+    rescue Sentry::SizeExceededError
+      serialized_items&.each do |item|
+        record_lost_event(:send_error, item.data_category)
+      end
     end
 
     def serialize_envelope(envelope)

data/lib/sentry/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sentry-ruby-core
 version: !ruby/object:Gem::Version
-  version: 6.4.1
+  version: 6.5.0
 platform: ruby
 authors:
 - Sentry Team
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.4.1
+        version: 6.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.4.1
+        version: 6.5.0
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement