sentry-ruby 0.1.3 → 4.1.0

data/lib/sentry/hub.rb

@@ -67,6 +67,12 @@ module Sentry
       @stack.pop
     end
 
+    def start_transaction(transaction: nil, **options)
+      transaction ||= Transaction.new(**options)
+      transaction.set_initial_sample_desicion
+      transaction
+    end
+
     def capture_exception(exception, **options, &block)
       return unless current_client
 
@@ -74,12 +80,16 @@ module Sentry
 
       return unless event
 
+      options[:hint] ||= {}
+      options[:hint] = options[:hint].merge(exception: exception)
       capture_event(event, **options, &block)
     end
 
     def capture_message(message, **options, &block)
       return unless current_client
 
+      options[:hint] ||= {}
+      options[:hint] = options[:hint].merge(message: message)
       event = current_client.event_from_message(message)
       capture_event(event, **options, &block)
     end
@@ -87,6 +97,7 @@ module Sentry
     def capture_event(event, **options, &block)
       return unless current_client
 
+      hint = options.delete(:hint) || {}
       scope = current_scope.dup
 
       if block
@@ -97,9 +108,9 @@ module Sentry
         scope.update_from_options(**options)
       end
 
-      event = current_client.capture_event(event, scope)
+      event = current_client.capture_event(event, scope, hint)
 
-      @last_event_id = event.id
+      @last_event_id = event.event_id
       event
     end
 

data/lib/sentry/interfaces/request.rb

@@ -1,5 +1,3 @@
-require 'rack'
-
 module Sentry
   class RequestInterface < Interface
     REQUEST_ID_HEADERS = %w(action_dispatch.request_id HTTP_X_REQUEST_ID).freeze
@@ -18,36 +16,8 @@ module Sentry
       self.cookies = nil
     end
 
-    def from_rack(env_hash)
-      req = ::Rack::Request.new(env_hash)
-
-      if Sentry.configuration.send_default_pii
-        self.data = read_data_from(req)
-        self.cookies = req.cookies
-      else
-        # need to completely wipe out ip addresses
-        IP_HEADERS.each { |h| env_hash.delete(h) }
-      end
-
-      self.url = req.scheme && req.url.split('?').first
-      self.method = req.request_method
-      self.query_string = req.query_string
-
-      self.headers = format_headers_for_sentry(env_hash)
-      self.env     = format_env_for_sentry(env_hash)
-    end
-
     private
 
-    # Request ID based on ActionDispatch::RequestId
-    def read_request_id_from(env_hash)
-      REQUEST_ID_HEADERS.each do |key|
-        request_id = env_hash[key]
-        return request_id if request_id
-      end
-      nil
-    end
-
     # See Sentry server default limits at
     # https://github.com/getsentry/sentry/blob/master/src/sentry/conf/server.py
     def read_data_from(request)
@@ -67,7 +37,7 @@ module Sentry
         begin
           key = key.to_s # rack env can contain symbols
           value = value.to_s
-          next memo['X-Request-Id'] ||= read_request_id_from(env_hash) if REQUEST_ID_HEADERS.include?(key)
+          next memo['X-Request-Id'] ||= Utils::RequestId.read_from(env_hash) if Utils::RequestId::REQUEST_ID_HEADERS.include?(key)
           next unless key.upcase == key # Non-upper case stuff isn't either
 
           # Rack adds in an incorrect HTTP_VERSION key, which causes downstream

data/lib/sentry/rack.rb

@@ -1,4 +1,4 @@
-require 'time'
 require 'rack'
 
-require 'sentry/rack/capture_exception'
+require 'sentry/rack/capture_exceptions'
+require 'sentry/rack/interface'

data/lib/sentry/rack/{capture_exception.rb → capture_exceptions.rb}

@@ -1,45 +1,54 @@
 module Sentry
   module Rack
-    class CaptureException
+    class CaptureExceptions
       def initialize(app)
         @app = app
       end
 
       def call(env)
-        # this call clones the main (global) hub
-        # and assigns it to the current thread's Sentry#get_current_hub
-        # it's essential for multi-thread servers (e.g. puma)
-        Sentry.clone_hub_to_current_thread unless Sentry.get_current_hub
-        # this call creates an isolated scope for every request
-        # it's essential for multi-process servers (e.g. unicorn)
+        return @app.call(env) unless Sentry.initialized?
+
+        # make sure the current thread has a clean hub
+        Sentry.clone_hub_to_current_thread
+
         Sentry.with_scope do |scope|
-          # there could be some breadcrumbs already stored in the top-level scope
-          # and for request information, we don't need those breadcrumbs
           scope.clear_breadcrumbs
-          env['sentry.client'] = Sentry.get_current_client
-
           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: "rack.request")
+          scope.set_span(span)
+
           begin
             response = @app.call(env)
           rescue Sentry::Error
+            finish_span(span, 500)
             raise # Don't capture Sentry errors
           rescue Exception => e
             Sentry.capture_exception(e)
+            finish_span(span, 500)
             raise
           end
 
           exception = collect_exception(env)
           Sentry.capture_exception(exception) if exception
 
+          finish_span(span, response[0])
+
           response
         end
       end
 
+      private
+
       def collect_exception(env)
         env['rack.exception'] || env['sinatra.error']
       end
+
+      def finish_span(span, status_code)
+        span.set_http_status(status_code)
+        span.finish
+      end
     end
   end
 end

data/lib/sentry/rack/interface.rb

@@ -0,0 +1,22 @@
+module Sentry
+  class RequestInterface
+    def from_rack(env_hash)
+      req = ::Rack::Request.new(env_hash)
+
+      if Sentry.configuration.send_default_pii
+        self.data = read_data_from(req)
+        self.cookies = req.cookies
+      else
+        # need to completely wipe out ip addresses
+        IP_HEADERS.each { |h| env_hash.delete(h) }
+      end
+
+      self.url = req.scheme && req.url.split('?').first
+      self.method = req.request_method
+      self.query_string = req.query_string
+
+      self.headers = format_headers_for_sentry(env_hash)
+      self.env     = format_env_for_sentry(env_hash)
+    end
+  end
+end

data/lib/sentry/rake.rb

@@ -0,0 +1,17 @@
+require "rake"
+require "rake/task"
+
+module Rake
+  class Application
+    alias orig_display_error_messsage display_error_message
+    def display_error_message(ex)
+      Sentry.capture_exception(ex, hint: { background: false }) do |scope|
+        task_name = top_level_tasks.join(' ')
+        scope.set_transaction_name(task_name)
+        scope.set_tag("rake_task", task_name)
+      end if Sentry.initialized?
+
+      orig_display_error_messsage(ex)
+    end
+  end
+end

data/lib/sentry/scope.rb

@@ -3,7 +3,7 @@ require "etc"
 
 module Sentry
   class Scope
-    ATTRIBUTES = [:transaction_names, :contexts, :extra, :tags, :user, :level, :breadcrumbs, :fingerprint, :event_processors, :rack_env]
+    ATTRIBUTES = [:transaction_names, :contexts, :extra, :tags, :user, :level, :breadcrumbs, :fingerprint, :event_processors, :rack_env, :span]
 
     attr_reader(*ATTRIBUTES)
 
@@ -15,20 +15,25 @@ module Sentry
       set_default_value
     end
 
-    def apply_to_event(event)
+    def apply_to_event(event, hint = nil)
       event.tags = tags.merge(event.tags)
       event.user = user.merge(event.user)
       event.extra = extra.merge(event.extra)
       event.contexts = contexts.merge(event.contexts)
+
+      if span
+        event.contexts[:trace] = span.get_trace_context
+      end
+
       event.fingerprint = fingerprint
-      event.level ||= level
+      event.level = level
       event.transaction = transaction_names.last
       event.breadcrumbs = breadcrumbs
-      event.rack_env = rack_env
+      event.rack_env = rack_env if rack_env
 
       unless @event_processors.empty?
         @event_processors.each do |processor_block|
-          event = processor_block.call(event)
+          event = processor_block.call(event, hint)
         end
       end
 
@@ -52,6 +57,7 @@ module Sentry
       copy.user = user.deep_dup
       copy.transaction_names = transaction_names.deep_dup
       copy.fingerprint = fingerprint.deep_dup
+      copy.span = span.deep_dup
       copy
     end
 
@@ -63,6 +69,7 @@ module Sentry
       self.user = scope.user
       self.transaction_names = scope.transaction_names
       self.fingerprint = scope.fingerprint
+      self.span = scope.span
     end
 
     def update_from_options(
@@ -86,6 +93,11 @@ module Sentry
       @rack_env = env
     end
 
+    def set_span(span)
+      check_argument_type!(span, Span)
+      @span = span
+    end
+
     def set_user(user_hash)
       check_argument_type!(user_hash, Hash)
       @user = user_hash
@@ -130,6 +142,15 @@ module Sentry
       @transaction_names.last
     end
 
+    def get_transaction
+      # transaction will always be the first in the span_recorder
+      span.span_recorder.spans.first if span
+    end
+
+    def get_span
+      span
+    end
+
     def set_fingerprint(fingerprint)
       check_argument_type!(fingerprint, Array)
 
@@ -164,6 +185,7 @@ module Sentry
       @transaction_names = []
       @event_processors = []
       @rack_env = {}
+      @span = nil
     end
 
     class << self

data/lib/sentry/span.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+require "securerandom"
+
+module Sentry
+  class Span
+    STATUS_MAP = {
+      400 => "invalid_argument",
+      401 => "unauthenticated",
+      403 => "permission_denied",
+      404 => "not_found",
+      409 => "already_exists",
+      429 => "resource_exhausted",
+      499 => "cancelled",
+      500 => "internal_error",
+      501 => "unimplemented",
+      503 => "unavailable",
+      504 => "deadline_exceeded"
+    }
+
+
+    attr_reader :trace_id, :span_id, :parent_span_id, :sampled, :start_timestamp, :timestamp, :description, :op, :status, :tags, :data
+    attr_accessor :span_recorder
+
+    def initialize(description: nil, op: nil, status: nil, trace_id: nil, parent_span_id: nil, sampled: nil, start_timestamp: nil, timestamp: nil)
+      @trace_id = trace_id || SecureRandom.uuid.delete("-")
+      @span_id = SecureRandom.hex(8)
+      @parent_span_id = parent_span_id
+      @sampled = sampled
+      @start_timestamp = start_timestamp || Sentry.utc_now.to_f
+      @timestamp = timestamp
+      @description = description
+      @op = op
+      @status = status
+      @data = {}
+      @tags = {}
+    end
+
+    def finish
+      # already finished
+      return if @timestamp
+
+      @timestamp = Sentry.utc_now.to_f
+      self
+    end
+
+    def to_sentry_trace
+      sampled_flag = ""
+      sampled_flag = @sampled ? 1 : 0 unless @sampled.nil?
+
+      "#{@trace_id}-#{@span_id}-#{sampled_flag}"
+    end
+
+    def to_hash
+      {
+        trace_id: @trace_id,
+        span_id: @span_id,
+        parent_span_id: @parent_span_id,
+        start_timestamp: @start_timestamp,
+        timestamp: @timestamp,
+        description: @description,
+        op: @op,
+        status: @status,
+        tags: @tags,
+        data: @data
+      }
+    end
+
+    def get_trace_context
+      {
+        trace_id: @trace_id,
+        span_id: @span_id,
+        description: @description,
+        op: @op,
+        status: @status
+      }
+    end
+
+    def start_child(**options)
+      options = options.dup.merge(trace_id: @trace_id, parent_span_id: @span_id, sampled: @sampled)
+      Span.new(options)
+    end
+
+    def with_child_span(**options, &block)
+      child_span = start_child(**options)
+
+      yield(child_span)
+
+      child_span.finish
+    end
+
+    def deep_dup
+      dup
+    end
+
+    def set_op(op)
+      @op = op
+    end
+
+    def set_description(description)
+      @description = description
+    end
+
+    def set_status(status)
+      @status = status
+    end
+
+    def set_timestamp(timestamp)
+      @timestamp = timestamp
+    end
+
+    def set_http_status(status_code)
+      status_code = status_code.to_i
+      set_data("status_code", status_code)
+
+      status =
+        if status_code >= 200 && status_code < 299
+          "ok"
+        else
+          STATUS_MAP[status_code]
+        end
+      set_status(status)
+    end
+
+    def set_data(key, value)
+      @data[key] = value
+    end
+
+    def set_tag(key, value)
+      @tags[key] = value
+    end
+  end
+end

data/lib/sentry/transaction.rb

@@ -0,0 +1,157 @@
+module Sentry
+  class Transaction < Span
+    SENTRY_TRACE_REGEXP = Regexp.new(
+      "^[ \t]*" +  # whitespace
+      "([0-9a-f]{32})?" +  # trace_id
+      "-?([0-9a-f]{16})?" +  # span_id
+      "-?([01])?" +  # sampled
+      "[ \t]*$"  # whitespace
+    )
+    UNLABELD_NAME = "<unlabeled transaction>".freeze
+    MESSAGE_PREFIX = "[Tracing]"
+
+    attr_reader :name, :parent_sampled
+
+    def initialize(name: nil, parent_sampled: nil, **options)
+      super(**options)
+
+      @name = name
+      @parent_sampled = parent_sampled
+      set_span_recorder
+    end
+
+    def set_span_recorder
+      @span_recorder = SpanRecorder.new(1000)
+      @span_recorder.add(self)
+    end
+
+    def self.from_sentry_trace(sentry_trace, **options)
+      return unless sentry_trace
+
+      match = SENTRY_TRACE_REGEXP.match(sentry_trace)
+      trace_id, parent_span_id, sampled_flag = match[1..3]
+
+      sampled = sampled_flag != "0"
+
+      new(trace_id: trace_id, parent_span_id: parent_span_id, parent_sampled: sampled, **options)
+    end
+
+    def to_hash
+      hash = super
+      hash.merge!(name: @name, sampled: @sampled, parent_sampled: @parent_sampled)
+      hash
+    end
+
+    def start_child(**options)
+      child_span = super
+      child_span.span_recorder = @span_recorder
+
+      if @sampled
+        @span_recorder.add(child_span)
+      end
+
+      child_span
+    end
+
+    def deep_dup
+      copy = super
+      copy.set_span_recorder
+
+      @span_recorder.spans.each do |span|
+        # span_recorder's first span is the current span, which should not be added to the copy's spans
+        next if span == self
+        copy.span_recorder.add(span.dup)
+      end
+
+      copy
+    end
+
+    def set_initial_sample_desicion(sampling_context = {})
+      unless Sentry.configuration.tracing_enabled?
+        @sampled = false
+        return
+      end
+
+      return unless @sampled.nil?
+
+      transaction_description = generate_transaction_description
+
+      logger = Sentry.configuration.logger
+      sample_rate = Sentry.configuration.traces_sample_rate
+      traces_sampler = Sentry.configuration.traces_sampler
+
+      if traces_sampler.is_a?(Proc)
+        sampling_context = sampling_context.merge(
+          parent_sampled: @parent_sampled,
+          transaction_context: self.to_hash
+        )
+
+        sample_rate = traces_sampler.call(sampling_context)
+      end
+
+      unless [true, false].include?(sample_rate) || (sample_rate.is_a?(Float) && sample_rate >= 0.0 && sample_rate <= 1.0)
+        @sampled = false
+        logger.warn("#{MESSAGE_PREFIX} Discarding #{transaction_description} because of invalid sample_rate: #{sample_rate}")
+        return
+      end
+
+      if sample_rate == 0.0 || sample_rate == false
+        @sampled = false
+        logger.debug("#{MESSAGE_PREFIX} Discarding #{transaction_description} because traces_sampler returned 0 or false")
+        return
+      end
+
+      if sample_rate == true
+        @sampled = true
+      else
+        @sampled = Random.rand < sample_rate
+      end
+
+      if @sampled
+        logger.debug("#{MESSAGE_PREFIX} Starting #{transaction_description}")
+      else
+        logger.debug(
+          "#{MESSAGE_PREFIX} Discarding #{transaction_description} because it's not included in the random sample (sampling rate = #{sample_rate})"
+        )
+      end
+    end
+
+    def finish(hub: nil)
+      super() # Span#finish doesn't take arguments
+
+      if @name.nil?
+        @name = UNLABELD_NAME
+      end
+
+      return unless @sampled
+
+      hub ||= Sentry.get_current_hub
+      event = hub.current_client.event_from_transaction(self)
+      hub.capture_event(event)
+    end
+
+    private
+
+    def generate_transaction_description
+      result = op.nil? ? "" : "<#{@op}> "
+      result += "transaction"
+      result += " <#{@name}>" if @name
+      result
+    end
+
+    class SpanRecorder
+      attr_reader :max_length, :spans
+
+      def initialize(max_length)
+        @max_length = max_length
+        @spans = []
+      end
+
+      def add(span)
+        if @spans.count < @max_length
+          @spans << span
+        end
+      end
+    end
+  end
+end