sentry-ruby 4.1.3 → 4.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 823d9f50e4335e2c08fa6a6afedac78e2c6243ea94a104db560870f0021c51c7
-  data.tar.gz: 385143cfb2e2218afb9fca2bebe07a26bca02565cd525b32a1abdde38bcd53e0
+  metadata.gz: a99aa0cd23f84ac85fe92aeff13f70aabb29f8b4f7e5239b48806f66e9af5376
+  data.tar.gz: bb5c2b32b2086f913fd6e8f55566b9a6bb6331aae414922e65696e4eb87457fe
 SHA512:
-  metadata.gz: 143855b2a274c65d17b72a60adbe8ff72b2d71ad316796d7899803d3bf28f4645cba7afa1518aabae592b0093ba51f5f3c41d755ce9674cd65b3da3363a5bb72
-  data.tar.gz: a4b8fc9795553867da3b5d6c0eebd6f2d4198805c21f19a936149653ddac882b4db5cba46678f016982f3529314a95d5a23e9770173f53dbeb33ff7ba6a4b6c7
+  metadata.gz: 70c330fa68f5a42588f7dfa815b7e2276b508de5c3a606c058d37afff5ef3b50ba3c3071cbb51356fd859c97ca19ffdd95a986931e4f54b752ad2b11b352feae
+  data.tar.gz: 0d0dde39080876a24f52256c503778226ae53bf0a668ba55503ae6c76bb4d0731b1cb7c775029fd2ec258c5e4eacbcb679272d7dd9495831ac1f6b77d56124ff

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 4.1.4
+
+- Fix headers serialization for sentry-ruby [#1197](https://github.com/getsentry/sentry-ruby/pull/1197) (by @moofkit)
+- Support capturing "sentry-trace" header from the middleware [#1205](https://github.com/getsentry/sentry-ruby/pull/1205)
+- Document public APIs on the Sentry module [#1208](https://github.com/getsentry/sentry-ruby/pull/1208)
+- Check the argument type of capture_exception and capture_event helpers [#1209](https://github.com/getsentry/sentry-ruby/pull/1209)
+
 ## 4.1.3
 
 - rm reference to old constant (from Rails v2.2) [#1184](https://github.com/getsentry/sentry-ruby/pull/1184)

data/lib/sentry-ruby.rb

@@ -3,6 +3,7 @@ require "time"
 
 require "sentry/version"
 require "sentry/core_ext/object/deep_dup"
+require "sentry/utils/argument_checking_helper"
 require "sentry/configuration"
 require "sentry/logger"
 require "sentry/event"
@@ -41,10 +42,12 @@ module Sentry
   end
 
   class << self
+    # Returns a hash that contains all the integrations that have been registered to the main SDK.
     def integrations
       @integrations ||= {}
     end
 
+    # Registers the SDK integration with its name and version.
     def register_integration(name, version)
       meta = { name: "sentry.ruby.#{name}", version: version }.freeze
       integrations[name.to_s] = meta
@@ -70,26 +73,19 @@ module Sentry
       @background_worker = Sentry::BackgroundWorker.new(config)
     end
 
-    def initialized?
-      !!@main_hub
-    end
-
+    # Returns the main thread's active hub.
     def get_main_hub
       @main_hub
     end
 
-    def logger
-      configuration.logger
-    end
-
-    def add_breadcrumb(breadcrumb, &block)
-      get_current_scope.breadcrumbs.record(breadcrumb, &block)
-    end
-
-    def get_current_client
-      get_current_hub&.current_client
+    # Takes an instance of Sentry::Breadcrumb and stores it to the current active scope.
+    def add_breadcrumb(breadcrumb)
+      get_current_scope.breadcrumbs.record(breadcrumb)
     end
 
+    # Returns the current active hub.
+    # If the current thread doesn't have an active hub, it will clone the main thread's active hub,
+    # stores it in the current thread, and then returns it.
     def get_current_hub
       # we need to assign a hub to the current thread if it doesn't have one yet
       #
@@ -99,38 +95,79 @@ module Sentry
       Thread.current[THREAD_LOCAL] || clone_hub_to_current_thread
     end
 
-    def clone_hub_to_current_thread
-      Thread.current[THREAD_LOCAL] = get_main_hub.clone
+    # Returns the current active client.
+    def get_current_client
+      get_current_hub&.current_client
     end
 
+    # Returns the current active scope.
     def get_current_scope
       get_current_hub&.current_scope
     end
 
-    def with_scope(&block)
-      get_current_hub&.with_scope(&block)
+    # Clones the main thread's active hub and stores it to the current thread.
+    def clone_hub_to_current_thread
+      Thread.current[THREAD_LOCAL] = get_main_hub.clone
     end
 
+    # Takes a block and yields the current active scope.
+    #
+    # ```ruby
+    # Sentry.configure_scope do |scope|
+    #   scope.set_tags(foo: "bar")
+    # end
+    #
+    # Sentry.capture_message("test message") # this event will have tags { foo: "bar" }
+    # ```
+    #
     def configure_scope(&block)
       get_current_hub&.configure_scope(&block)
     end
 
-    def capture_event(event)
-      get_current_hub&.capture_event(event)
+    # Takes a block and yields a temporary scope.
+    # The temporary scope will inherit all the attributes from the current active scope and replace it to be the active
+    # scope inside the block. For example:
+    #
+    # ```ruby
+    # Sentry.configure_scope do |scope|
+    #   scope.set_tags(foo: "bar")
+    # end
+    #
+    # Sentry.capture_message("test message") # this event will have tags { foo: "bar" }
+    #
+    # Sentry.with_scope do |temp_scope|
+    #   temp_scope.set_tags(foo: "baz")
+    #   Sentry.capture_message("test message 2") # this event will have tags { foo: "baz" }
+    # end
+    #
+    # Sentry.capture_message("test message 3") # this event will have tags { foo: "bar" }
+    # ```
+    #
+    def with_scope(&block)
+      get_current_hub&.with_scope(&block)
     end
 
+    # Takes an exception and reports it to Sentry via the currently active hub.
     def capture_exception(exception, **options, &block)
       get_current_hub&.capture_exception(exception, **options, &block)
     end
 
+    # Takes a message string and reports it to Sentry via the currently active hub.
     def capture_message(message, **options, &block)
       get_current_hub&.capture_message(message, **options, &block)
     end
 
+    # Takes an instance of Sentry::Event and dispatches it to the currently active hub.
+    def capture_event(event)
+      get_current_hub&.capture_event(event)
+    end
+
+    # Takes or initializes a new Sentry::Transaction and makes a sampling decision for it.
     def start_transaction(**options)
       get_current_hub&.start_transaction(**options)
     end
 
+    # Returns the id of the lastly reported Sentry::Event.
     def last_event_id
       get_current_hub&.last_event_id
     end
@@ -141,5 +178,13 @@ module Sentry
 
       result.strip
     end
+
+    def initialized?
+      !!@main_hub
+    end
+
+    def logger
+      configuration.logger
+    end
   end
 end

data/lib/sentry/hub.rb

@@ -3,6 +3,8 @@ require "sentry/client"
 
 module Sentry
   class Hub
+    include ArgumentCheckingHelper
+
     attr_reader :last_event_id
 
     def initialize(client, scope)
@@ -76,6 +78,8 @@ module Sentry
     def capture_exception(exception, **options, &block)
       return unless current_client
 
+      check_argument_type!(exception, ::Exception)
+
       options[:hint] ||= {}
       options[:hint][:exception] = exception
       event = current_client.event_from_exception(exception, options[:hint])
@@ -97,6 +101,8 @@ module Sentry
     def capture_event(event, **options, &block)
       return unless current_client
 
+      check_argument_type!(event, Sentry::Event)
+
       hint = options.delete(:hint) || {}
       scope = current_scope.dup
 

data/lib/sentry/interfaces/request.rb

@@ -68,7 +68,6 @@ module Sentry
       env.each_with_object({}) do |(key, value), memo|
         begin
           key = key.to_s # rack env can contain symbols
-          value = value.to_s
           next memo['X-Request-Id'] ||= Utils::RequestId.read_from(env) if Utils::RequestId::REQUEST_ID_HEADERS.include?(key)
           next if is_server_protocol?(key, value, env["SERVER_PROTOCOL"])
           next if is_skippable_header?(key)
@@ -76,7 +75,7 @@ module Sentry
           # Rack stores headers as HTTP_WHAT_EVER, we need What-Ever
           key = key.sub(/^HTTP_/, "")
           key = key.split('_').map(&:capitalize).join('-')
-          memo[key] = value
+          memo[key] = value.to_s
         rescue StandardError => e
           # Rails adds objects to the Rack env that can sometimes raise exceptions
           # when `to_s` is called.

data/lib/sentry/rack/capture_exceptions.rb

@@ -16,7 +16,13 @@ module Sentry
           scope.set_transaction_name(env["PATH_INFO"]) if env["PATH_INFO"]
           scope.set_rack_env(env)
 
-          span = Sentry.start_transaction(name: scope.transaction_name, op: transaction_op)
+          span =
+            if sentry_trace = env["sentry-trace"]
+              Sentry::Transaction.from_sentry_trace(sentry_trace, name: scope.transaction_name, op: transaction_op)
+            else
+              Sentry.start_transaction(name: scope.transaction_name, op: transaction_op)
+            end
+
           scope.set_span(span)
 
           begin

data/lib/sentry/scope.rb

@@ -3,6 +3,8 @@ require "etc"
 
 module Sentry
   class Scope
+    include ArgumentCheckingHelper
+
     ATTRIBUTES = [:transaction_names, :contexts, :extra, :tags, :user, :level, :breadcrumbs, :fingerprint, :event_processors, :rack_env, :span]
 
     attr_reader(*ATTRIBUTES)
@@ -168,12 +170,6 @@ module Sentry
 
     private
 
-    def check_argument_type!(argument, expected_type)
-      unless argument.is_a?(expected_type)
-        raise ArgumentError, "expect the argument to be a #{expected_type}, got #{argument.class} (#{argument})"
-      end
-    end
-
     def set_default_value
       @breadcrumbs = BreadcrumbBuffer.new
       @contexts = { :os => self.class.os_context, :runtime => self.class.runtime_context }

data/lib/sentry/span.rb

@@ -69,6 +69,7 @@ module Sentry
       {
         trace_id: @trace_id,
         span_id: @span_id,
+        parent_span_id: @parent_span_id,
         description: @description,
         op: @op,
         status: @status

data/lib/sentry/transaction.rb

@@ -123,7 +123,7 @@ module Sentry
         @name = UNLABELD_NAME
       end
 
-      return unless @sampled
+      return unless @sampled || @parent_sampled
 
       hub ||= Sentry.get_current_hub
       event = hub.current_client.event_from_transaction(self)

data/lib/sentry/utils/argument_checking_helper.rb

@@ -0,0 +1,11 @@
+module Sentry
+  module ArgumentCheckingHelper
+    private
+
+    def check_argument_type!(argument, expected_type)
+      unless argument.is_a?(expected_type)
+        raise ArgumentError, "expect the argument to be a #{expected_type}, got #{argument.class} (#{argument.inspect})"
+      end
+    end
+  end
+end

data/lib/sentry/version.rb

@@ -1,3 +1,3 @@
 module Sentry
-  VERSION = "4.1.3"
+  VERSION = "4.1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-ruby
 version: !ruby/object:Gem::Version
-  version: 4.1.3
+  version: 4.1.4
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-11 00:00:00.000000000 Z
+date: 2021-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -98,6 +98,7 @@ files:
 - lib/sentry/transport/configuration.rb
 - lib/sentry/transport/dummy_transport.rb
 - lib/sentry/transport/http_transport.rb
+- lib/sentry/utils/argument_checking_helper.rb
 - lib/sentry/utils/exception_cause_chain.rb
 - lib/sentry/utils/real_ip.rb
 - lib/sentry/utils/request_id.rb