sentry-ruby 5.1.0 → 5.4.2

data/lib/sentry/rake.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "rake"
+require "rake/task"
+
+module Sentry
+  module Rake
+    module Application
+      # @api private
+      def display_error_message(ex)
+        Sentry.capture_exception(ex) 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? && !Sentry.configuration.skip_rake_integration
+
+        super
+      end
+    end
+
+    module Task
+      # @api private
+      def execute(args=nil)
+        return super unless Sentry.initialized? && Sentry.get_current_hub
+
+        super
+      end
+    end
+  end
+end
+
+# @api private
+module Rake
+  class Application
+    prepend(Sentry::Rake::Application)
+  end
+
+  class Task
+    prepend(Sentry::Rake::Task)
+  end
+end

data/lib/sentry/redis.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Sentry
+  # @api private
+  class Redis
+    OP_NAME = "db.redis.command"
+    LOGGER_NAME = :redis_logger
+
+    def initialize(commands, host, port, db)
+      @commands, @host, @port, @db = commands, host, port, db
+    end
+
+    def instrument
+      return yield unless Sentry.initialized?
+
+      record_span do
+        yield.tap do
+          record_breadcrumb
+        end
+      end
+    end
+
+    private
+
+    attr_reader :commands, :host, :port, :db
+
+    def record_span
+      return yield unless (transaction = Sentry.get_current_scope.get_transaction) && transaction.sampled
+
+      sentry_span = transaction.start_child(op: OP_NAME, start_timestamp: Sentry.utc_now.to_f)
+
+      yield.tap do
+        sentry_span.set_description(commands_description)
+        sentry_span.set_data(:server, server_description)
+        sentry_span.set_timestamp(Sentry.utc_now.to_f)
+      end
+    end
+
+    def record_breadcrumb
+      return unless Sentry.configuration.breadcrumbs_logger.include?(LOGGER_NAME)
+
+      Sentry.add_breadcrumb(
+        Sentry::Breadcrumb.new(
+          level: :info,
+          category: OP_NAME,
+          type: :info,
+          data: {
+            commands: parsed_commands,
+            server: server_description
+          }
+        )
+      )
+    end
+
+    def commands_description
+      parsed_commands.map do |statement|
+        statement.values.join(" ").strip
+      end.join(", ")
+    end
+
+    def parsed_commands
+      commands.map do |statement|
+        command, key, *arguments = statement
+
+        { command: command.to_s.upcase, key: key }.tap do |command_set|
+          command_set[:arguments] = arguments.join(" ") if Sentry.configuration.send_default_pii
+        end
+      end
+    end
+
+    def server_description
+      "#{host}:#{port}/#{db}"
+    end
+
+    module Client
+      def logging(commands, &block)
+        Sentry::Redis.new(commands, host, port, db).instrument do
+          super
+        end
+      end
+    end
+  end
+end
+
+if defined?(::Redis::Client)
+  Sentry.register_patch do
+    patch = Sentry::Redis::Client
+    Redis::Client.prepend(patch) unless Redis::Client.ancestors.include?(patch)
+  end
+end

data/lib/sentry/release_detector.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Sentry
+  # @api private
+  class ReleaseDetector
+    class << self
+      def detect_release(project_root:, running_on_heroku:)
+        detect_release_from_env ||
+        detect_release_from_git ||
+        detect_release_from_capistrano(project_root) ||
+        detect_release_from_heroku(running_on_heroku)
+      end
+
+      def detect_release_from_heroku(running_on_heroku)
+        return unless running_on_heroku
+        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')
+
+        if File.exist?(revision_file)
+          File.read(revision_file).strip
+        elsif File.exist?(revision_log)
+          File.open(revision_log).to_a.last.strip.sub(/.*as release ([0-9]+).*/, '\1')
+        end
+      end
+
+      def detect_release_from_git
+        Sentry.sys_command("git rev-parse --short HEAD") if File.directory?(".git")
+      end
+
+      def detect_release_from_env
+        ENV['SENTRY_RELEASE']
+      end
+    end
+  end
+end

data/lib/sentry/scope.rb

@@ -0,0 +1,295 @@
+# frozen_string_literal: true
+
+require "sentry/breadcrumb_buffer"
+require "etc"
+
+module Sentry
+  class Scope
+    include ArgumentCheckingHelper
+
+    ATTRIBUTES = [:transaction_names, :contexts, :extra, :tags, :user, :level, :breadcrumbs, :fingerprint, :event_processors, :rack_env, :span, :session]
+
+    attr_reader(*ATTRIBUTES)
+
+    # @param max_breadcrumbs [Integer] the maximum number of breadcrumbs to be stored in the scope.
+    def initialize(max_breadcrumbs: nil)
+      @max_breadcrumbs = max_breadcrumbs
+      set_default_value
+    end
+
+    # Resets the scope's attributes to defaults.
+    # @return [void]
+    def clear
+      set_default_value
+    end
+
+    # Applies stored attributes and event processors to the given event.
+    # @param event [Event]
+    # @param hint [Hash] the hint data that'll be passed to event processors.
+    # @return [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)
+      event.transaction = transaction_name if transaction_name
+
+      if span
+        event.contexts[:trace] = span.get_trace_context
+      end
+
+      event.fingerprint = fingerprint
+      event.level = level
+      event.breadcrumbs = breadcrumbs
+      event.rack_env = rack_env if rack_env
+
+      unless @event_processors.empty?
+        @event_processors.each do |processor_block|
+          event = processor_block.call(event, hint)
+        end
+      end
+
+      event
+    end
+
+    # Adds the breadcrumb to the scope's breadcrumbs buffer.
+    # @param breadcrumb [Breadcrumb]
+    # @return [void]
+    def add_breadcrumb(breadcrumb)
+      breadcrumbs.record(breadcrumb)
+    end
+
+    # Clears the scope's breadcrumbs buffer
+    # @return [void]
+    def clear_breadcrumbs
+      set_new_breadcrumb_buffer
+    end
+
+    # @return [Scope]
+    def dup
+      copy = super
+      copy.breadcrumbs = breadcrumbs.dup
+      copy.contexts = contexts.deep_dup
+      copy.extra = extra.deep_dup
+      copy.tags = tags.deep_dup
+      copy.user = user.deep_dup
+      copy.transaction_names = transaction_names.deep_dup
+      copy.fingerprint = fingerprint.deep_dup
+      copy.span = span.deep_dup
+      copy.session = session.deep_dup
+      copy
+    end
+
+    # Updates the scope's data from a given scope.
+    # @param scope [Scope]
+    # @return [void]
+    def update_from_scope(scope)
+      self.breadcrumbs = scope.breadcrumbs
+      self.contexts = scope.contexts
+      self.extra = scope.extra
+      self.tags = scope.tags
+      self.user = scope.user
+      self.transaction_names = scope.transaction_names
+      self.fingerprint = scope.fingerprint
+      self.span = scope.span
+    end
+
+    # Updates the scope's data from the given options.
+    # @param contexts [Hash]
+    # @param extras [Hash]
+    # @param tags [Hash]
+    # @param user [Hash]
+    # @param level [String, Symbol]
+    # @param fingerprint [Array]
+    # @return [void]
+    def update_from_options(
+      contexts: nil,
+      extra: nil,
+      tags: nil,
+      user: nil,
+      level: nil,
+      fingerprint: nil
+    )
+      self.contexts.merge!(contexts) if contexts
+      self.extra.merge!(extra) if extra
+      self.tags.merge!(tags) if tags
+      self.user = user if user
+      self.level = level if level
+      self.fingerprint = fingerprint if fingerprint
+    end
+
+    # Sets the scope's rack_env attribute.
+    # @param env [Hash]
+    # @return [Hash]
+    def set_rack_env(env)
+      env = env || {}
+      @rack_env = env
+    end
+
+    # Sets the scope's span attribute.
+    # @param span [Span]
+    # @return [Span]
+    def set_span(span)
+      check_argument_type!(span, Span)
+      @span = span
+    end
+
+    # @!macro set_user
+    def set_user(user_hash)
+      check_argument_type!(user_hash, Hash)
+      @user = user_hash
+    end
+
+    # @!macro set_extras
+    def set_extras(extras_hash)
+      check_argument_type!(extras_hash, Hash)
+      @extra.merge!(extras_hash)
+    end
+
+    # Adds a new key-value pair to current extras.
+    # @param key [String, Symbol]
+    # @param value [Object]
+    # @return [Hash]
+    def set_extra(key, value)
+      set_extras(key => value)
+    end
+
+    # @!macro set_tags
+    def set_tags(tags_hash)
+      check_argument_type!(tags_hash, Hash)
+      @tags.merge!(tags_hash)
+    end
+
+    # Adds a new key-value pair to current tags.
+    # @param key [String, Symbol]
+    # @param value [Object]
+    # @return [Hash]
+    def set_tag(key, value)
+      set_tags(key => value)
+    end
+
+    # Updates the scope's contexts attribute by merging with the old value.
+    # @param contexts [Hash]
+    # @return [Hash]
+    def set_contexts(contexts_hash)
+      check_argument_type!(contexts_hash, Hash)
+      @contexts.merge!(contexts_hash) do |key, old, new|
+        old.merge(new)
+      end
+    end
+
+    # @!macro set_context
+    def set_context(key, value)
+      check_argument_type!(value, Hash)
+      set_contexts(key => value)
+    end
+
+    # Sets the scope's level attribute.
+    # @param level [String, Symbol]
+    # @return [void]
+    def set_level(level)
+      @level = level
+    end
+
+    # Appends a new transaction name to the scope.
+    # The "transaction" here does not refer to `Transaction` objects.
+    # @param transaction_name [String]
+    # @return [void]
+    def set_transaction_name(transaction_name)
+      @transaction_names << transaction_name
+    end
+
+    # Sets the currently active session on the scope.
+    # @param session [Session, nil]
+    # @return [void]
+    def set_session(session)
+      @session = session
+    end
+
+    # Returns current transaction name.
+    # The "transaction" here does not refer to `Transaction` objects.
+    # @return [String, nil]
+    def transaction_name
+      @transaction_names.last
+    end
+
+    # Returns the associated Transaction object.
+    # @return [Transaction, nil]
+    def get_transaction
+      span.transaction if span
+    end
+
+    # Returns the associated Span object.
+    # @return [Span, nil]
+    def get_span
+      span
+    end
+
+    # Sets the scope's fingerprint attribute.
+    # @param fingerprint [Array]
+    # @return [Array]
+    def set_fingerprint(fingerprint)
+      check_argument_type!(fingerprint, Array)
+
+      @fingerprint = fingerprint
+    end
+
+    # Adds a new event processor [Proc] to the scope.
+    # @param block [Proc]
+    # @return [void]
+    def add_event_processor(&block)
+      @event_processors << block
+    end
+
+    protected
+
+    # for duplicating scopes internally
+    attr_writer(*ATTRIBUTES)
+
+    private
+
+    def set_default_value
+      @contexts = { :os => self.class.os_context, :runtime => self.class.runtime_context }
+      @extra = {}
+      @tags = {}
+      @user = {}
+      @level = :error
+      @fingerprint = []
+      @transaction_names = []
+      @event_processors = []
+      @rack_env = {}
+      @span = nil
+      @session = nil
+      set_new_breadcrumb_buffer
+    end
+
+    def set_new_breadcrumb_buffer
+      @breadcrumbs = BreadcrumbBuffer.new(@max_breadcrumbs)
+    end
+
+    class << self
+      # @return [Hash]
+      def os_context
+        @os_context ||=
+          begin
+            uname = Etc.uname
+            {
+              name: uname[:sysname] || RbConfig::CONFIG["host_os"],
+              version: uname[:version],
+              build: uname[:release],
+              kernel_version: uname[:version]
+            }
+          end
+      end
+
+      # @return [Hash]
+      def runtime_context
+        @runtime_context ||= {
+          name: RbConfig::CONFIG["ruby_install_name"],
+          version: RUBY_DESCRIPTION || Sentry.sys_command("ruby -v")
+        }
+      end
+    end
+
+  end
+end

data/lib/sentry/session.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Sentry
+  class Session
+    attr_reader :started, :status
+
+    # TODO-neel add :crashed after adding handled mechanism
+    STATUSES = %i(ok errored exited)
+    AGGREGATE_STATUSES = %i(errored exited)
+
+    def initialize
+      @started = Sentry.utc_now
+      @status = :ok
+    end
+
+    # TODO-neel add :crashed after adding handled mechanism
+    def update_from_exception(_exception = nil)
+      @status = :errored
+    end
+
+    def close
+      @status = :exited if @status == :ok
+    end
+
+    # truncate seconds from the timestamp since we only care about
+    # minute level granularity for aggregation
+    def aggregation_key
+      Time.utc(started.year, started.month, started.day, started.hour, started.min)
+    end
+
+    def deep_dup
+      dup
+    end
+  end
+end

data/lib/sentry/session_flusher.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Sentry
+  class SessionFlusher
+    include LoggingHelper
+
+    FLUSH_INTERVAL = 60
+
+    def initialize(configuration, client)
+      @thread = nil
+      @exited = false
+      @client = client
+      @pending_aggregates = {}
+      @release = configuration.release
+      @environment = configuration.environment
+      @logger = configuration.logger
+
+      log_debug("[Sessions] Sessions won't be captured without a valid release") unless @release
+    end
+
+    def flush
+      return if @pending_aggregates.empty?
+      envelope = pending_envelope
+
+      Sentry.background_worker.perform do
+        @client.transport.send_envelope(envelope)
+      end
+
+      @pending_aggregates = {}
+    end
+
+    def add_session(session)
+      return if @exited
+      return unless @release
+
+      begin
+        ensure_thread
+      rescue ThreadError
+        log_debug("Session flusher thread creation failed")
+        @exited = true
+        return
+      end
+
+      return unless Session::AGGREGATE_STATUSES.include?(session.status)
+      @pending_aggregates[session.aggregation_key] ||= init_aggregates(session.aggregation_key)
+      @pending_aggregates[session.aggregation_key][session.status] += 1
+    end
+
+    def kill
+      log_debug("Killing session flusher")
+
+      @exited = true
+      @thread&.kill
+    end
+
+    private
+
+    def init_aggregates(aggregation_key)
+      aggregates = { started: aggregation_key.iso8601 }
+      Session::AGGREGATE_STATUSES.each { |k| aggregates[k] = 0 }
+      aggregates
+    end
+
+    def pending_envelope
+      envelope = Envelope.new
+
+      header = { type: 'sessions' }
+      payload = { attrs: attrs, aggregates: @pending_aggregates.values }
+
+      envelope.add_item(header, payload)
+      envelope
+    end
+
+    def attrs
+      { release: @release, environment: @environment }
+    end
+
+    def ensure_thread
+      return if @thread&.alive?
+
+      @thread = Thread.new do
+        loop do
+          sleep(FLUSH_INTERVAL)
+          flush
+        end
+      end
+    end
+
+  end
+end