class Sentry::Client
def capture_event(event, scope, hint = {})
-
(Event, nil)
-
Parameters:
-
hint
(Hash
) -- the hint data that'll be passed to `before_send` callback and the scope's event processors. -
scope
(Scope
) -- the scope with contextual data that'll be applied to the event before it's sent. -
event
(Event
) -- the event to be sent.
def capture_event(event, scope, hint = {}) return unless configuration.sending_allowed? unless event.is_a?(TransactionEvent) || configuration.sample_allowed? transport.record_lost_event(:sample_rate, 'event') return end event_type = event.is_a?(Event) ? event.type : event["type"] event = scope.apply_to_event(event, hint) if event.nil? log_info("Discarded event because one of the event processors returned nil") transport.record_lost_event(:event_processor, event_type) return end if async_block = configuration.async dispatch_async_event(async_block, event, hint) elsif configuration.background_worker_threads != 0 && hint.fetch(:background, true) queued = dispatch_background_event(event, hint) transport.record_lost_event(:queue_overflow, event_type) unless queued else send_event(event, hint) end event rescue => e log_error("Event capturing failed", e, debug: configuration.debug) nil end
def dispatch_async_event(async_block, event, hint)
def dispatch_async_event(async_block, event, hint) # We have to convert to a JSON-like hash, because background job # processors (esp ActiveJob) may not like weird types in the event hash event_hash = begin event.to_json_compatible rescue => e log_error("Converting #{event.type} (#{event.event_id}) to JSON compatible hash failed", e, debug: configuration.debug) return end if async_block.arity == 2 hint = JSON.parse(JSON.generate(hint)) async_block.call(event_hash, hint) else async_block.call(event_hash) end rescue => e log_error("Async #{event_hash["type"]} sending failed", e, debug: configuration.debug) send_event(event, hint) end
def dispatch_background_event(event, hint)
def dispatch_background_event(event, hint) Sentry.background_worker.perform do send_event(event, hint) end end
def event_from_exception(exception, hint = {})
-
(Event, nil)
-
Parameters:
-
hint
(Hash
) -- the hint data that'll be passed to `before_send` callback and the scope's event processors. -
exception
(Exception
) -- the exception to be reported.
def event_from_exception(exception, hint = {}) return unless @configuration.sending_allowed? ignore_exclusions = hint.delete(:ignore_exclusions) { false } return if !ignore_exclusions && !@configuration.exception_class_allowed?(exception) integration_meta = Sentry.integrations[hint[:integration]] ErrorEvent.new(configuration: configuration, integration_meta: integration_meta).tap do |event| event.add_exception_interface(exception) event.add_threads_interface(crashed: true) event.level = :error end end
def event_from_message(message, hint = {}, backtrace: nil)
-
(Event)
-
Parameters:
-
hint
(Hash
) -- the hint data that'll be passed to `before_send` callback and the scope's event processors. -
message
(String
) -- the message to be reported.
def event_from_message(message, hint = {}, backtrace: nil) return unless @configuration.sending_allowed? integration_meta = Sentry.integrations[hint[:integration]] event = ErrorEvent.new(configuration: configuration, integration_meta: integration_meta, message: message) event.add_threads_interface(backtrace: backtrace || caller) event.level = :error event end
def event_from_transaction(transaction)
-
(TransactionEvent)
-
Parameters:
-
transaction
(Transaction
) -- the transaction to be recorded.
def event_from_transaction(transaction) TransactionEvent.new(configuration: configuration, transaction: transaction) end
def generate_baggage(span)
-
(String, nil)
-
Parameters:
-
span
(Span
) -- the span to generate trace from.
def generate_baggage(span) return unless configuration.propagate_traces baggage = span.to_baggage if baggage && !baggage.empty? log_debug("[Tracing] Adding #{BAGGAGE_HEADER_NAME} header to outgoing request: #{baggage}") end baggage end
def generate_sentry_trace(span)
-
(String, nil)
-
Parameters:
-
span
(Span
) -- the span to generate trace from.
def generate_sentry_trace(span) return unless configuration.propagate_traces trace = span.to_sentry_trace log_debug("[Tracing] Adding #{SENTRY_TRACE_HEADER_NAME} header to outgoing request: #{trace}") trace end
def initialize(configuration)
-
configuration
(Configuration
) --
def initialize(configuration) @configuration = configuration @logger = configuration.logger if transport_class = configuration.transport.transport_class @transport = transport_class.new(configuration) else @transport = case configuration.dsn&.scheme when 'http', 'https' HTTPTransport.new(configuration) else DummyTransport.new(configuration) end end end
def send_event(event, hint = nil)
def send_event(event, hint = nil) event_type = event.is_a?(Event) ? event.type : event["type"] if event_type != TransactionEvent::TYPE && configuration.before_send event = configuration.before_send.call(event, hint) if event.nil? log_info("Discarded event because before_send returned nil") transport.record_lost_event(:before_send, 'event') return end end if event_type == TransactionEvent::TYPE && configuration.before_send_transaction event = configuration.before_send_transaction.call(event, hint) if event.nil? log_info("Discarded event because before_send_transaction returned nil") transport.record_lost_event(:before_send, 'transaction') return end end transport.send_event(event) event rescue => e loggable_event_type = event_type.capitalize log_error("#{loggable_event_type} sending failed", e, debug: configuration.debug) event_info = Event.get_log_message(event.to_hash) log_info("Unreported #{loggable_event_type}: #{event_info}") transport.record_lost_event(:network_error, event_type) raise end