sentry-ruby 5.3.0 → 5.8.0

data/lib/sentry/scope.rb

@@ -0,0 +1,339 @@
+# frozen_string_literal: true
+
+require "sentry/breadcrumb_buffer"
+require "etc"
+
+module Sentry
+  class Scope
+    include ArgumentCheckingHelper
+
+    ATTRIBUTES = [
+      :transaction_names,
+      :transaction_sources,
+      :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
+      event.transaction_info = { source: transaction_source } if transaction_source
+
+      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
+
+      all_event_processors = self.class.global_event_processors + @event_processors
+
+      unless all_event_processors.empty?
+        all_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.dup
+      copy.transaction_sources = transaction_sources.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.transaction_sources = scope.transaction_sources
+      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, source: :custom)
+      @transaction_names << transaction_name
+      @transaction_sources << source
+    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 current transaction source.
+    # The "transaction" here does not refer to `Transaction` objects.
+    # @return [String, nil]
+    def transaction_source
+      @transaction_sources.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 = []
+      @transaction_sources = []
+      @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
+
+      # Returns the global event processors array.
+      # @return [Array<Proc>]
+      def global_event_processors
+        @global_event_processors ||= []
+      end
+
+      # Adds a new global event processor [Proc].
+      # Sometimes we need a global event processor without needing to configure scope.
+      # These run before scope event processors.
+      #
+      # @param block [Proc]
+      # @return [void]
+      def add_global_event_processor(&block)
+        global_event_processors << block
+      end
+    end
+
+  end
+end

data/lib/sentry/session.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Sentry
+  class Session
+    attr_reader :started, :status, :aggregation_key
+
+    # 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
+
+      # truncate seconds from the timestamp since we only care about
+      # minute level granularity for aggregation
+      @aggregation_key = Time.utc(@started.year, @started.month, @started.day, @started.hour, @started.min)
+    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
+
+    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

data/lib/sentry/span.rb

@@ -0,0 +1,236 @@
+# 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"
+    }
+
+    # An uuid that can be used to identify a trace.
+    # @return [String]
+    attr_reader :trace_id
+    # An uuid that can be used to identify the span.
+    # @return [String]
+    attr_reader :span_id
+    # Span parent's span_id.
+    # @return [String]
+    attr_reader :parent_span_id
+    # Sampling result of the span.
+    # @return [Boolean, nil]
+    attr_reader :sampled
+    # Starting timestamp of the span.
+    # @return [Float]
+    attr_reader :start_timestamp
+    # Finishing timestamp of the span.
+    # @return [Float]
+    attr_reader :timestamp
+    # Span description
+    # @return [String]
+    attr_reader :description
+    # Span operation
+    # @return [String]
+    attr_reader :op
+    # Span status
+    # @return [String]
+    attr_reader :status
+    # Span tags
+    # @return [Hash]
+    attr_reader :tags
+    # Span data
+    # @return [Hash]
+    attr_reader :data
+
+    # The SpanRecorder the current span belongs to.
+    # SpanRecorder holds all spans under the same Transaction object (including the Transaction itself).
+    # @return [SpanRecorder]
+    attr_accessor :span_recorder
+
+    # The Transaction object the Span belongs to.
+    # Every span needs to be attached to a Transaction and their child spans will also inherit the same transaction.
+    # @return [Transaction]
+    attr_reader :transaction
+
+    def initialize(
+      transaction:,
+      description: nil,
+      op: nil,
+      status: nil,
+      trace_id: nil,
+      span_id: nil,
+      parent_span_id: nil,
+      sampled: nil,
+      start_timestamp: nil,
+      timestamp: nil
+    )
+      @trace_id = trace_id || SecureRandom.uuid.delete("-")
+      @span_id = 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
+      @transaction = transaction
+      @op = op
+      @status = status
+      @data = {}
+      @tags = {}
+    end
+
+    # Finishes the span by adding a timestamp.
+    # @return [self]
+    def finish(end_timestamp: nil)
+      @timestamp = end_timestamp || @timestamp || Sentry.utc_now.to_f
+      self
+    end
+
+    # Generates a trace string that can be used to connect other transactions.
+    # @return [String]
+    def to_sentry_trace
+      sampled_flag = ""
+      sampled_flag = @sampled ? 1 : 0 unless @sampled.nil?
+
+      "#{@trace_id}-#{@span_id}-#{sampled_flag}"
+    end
+
+    # Generates a W3C Baggage header string for distributed tracing
+    # from the incoming baggage stored on the transaction.
+    # @return [String, nil]
+    def to_baggage
+      transaction.get_baggage&.serialize
+    end
+
+    # @return [Hash]
+    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
+
+    # Returns the span's context that can be used to embed in an Event.
+    # @return [Hash]
+    def get_trace_context
+      {
+        trace_id: @trace_id,
+        span_id: @span_id,
+        parent_span_id: @parent_span_id,
+        description: @description,
+        op: @op,
+        status: @status
+      }
+    end
+
+    # Starts a child span with given attributes.
+    # @param attributes [Hash] the attributes for the child span.
+    def start_child(**attributes)
+      attributes = attributes.dup.merge(transaction: @transaction, trace_id: @trace_id, parent_span_id: @span_id, sampled: @sampled)
+      new_span = Span.new(**attributes)
+      new_span.span_recorder = span_recorder
+
+      if span_recorder
+        span_recorder.add(new_span)
+      end
+
+      new_span
+    end
+
+    # Starts a child span, yield it to the given block, and then finish the span after the block is executed.
+    # @example
+    #   span.with_child_span do |child_span|
+    #     # things happen here will be recorded in a child span
+    #   end
+    #
+    # @param attributes [Hash] the attributes for the child span.
+    # @param block [Proc] the action to be recorded in the child span.
+    # @yieldparam child_span [Span]
+    def with_child_span(**attributes, &block)
+      child_span = start_child(**attributes)
+
+      yield(child_span)
+
+      child_span.finish
+    rescue
+      child_span.set_http_status(500)
+      child_span.finish
+      raise
+    end
+
+    def deep_dup
+      dup
+    end
+
+    # Sets the span's operation.
+    # @param op [String] operation of the span.
+    def set_op(op)
+      @op = op
+    end
+
+    # Sets the span's description.
+    # @param description [String] description of the span.
+    def set_description(description)
+      @description = description
+    end
+
+
+    # Sets the span's status.
+    # @param satus [String] status of the span.
+    def set_status(status)
+      @status = status
+    end
+
+    # Sets the span's finish timestamp.
+    # @param timestamp [Float] finished time in float format (most precise).
+    def set_timestamp(timestamp)
+      @timestamp = timestamp
+    end
+
+    # Sets the span's status with given http status code.
+    # @param status_code [String] example: "500".
+    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
+
+    # Inserts a key-value pair to the span's data payload.
+    # @param key [String, Symbol]
+    # @param value [Object]
+    def set_data(key, value)
+      @data[key] = value
+    end
+
+    # Sets a tag to the span.
+    # @param key [String, Symbol]
+    # @param value [String]
+    def set_tag(key, value)
+      @tags[key] = value
+    end
+  end
+end