1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322
|
# frozen_string_literal: true
require "sentry/transport"
require "sentry/log_event"
require "sentry/log_event_buffer"
require "sentry/metric_event"
require "sentry/metric_event_buffer"
require "sentry/utils/uuid"
require "sentry/utils/encoding_helper"
module Sentry
class Client
include LoggingHelper
# The Transport object that'll send events for the client.
# @return [Transport]
attr_reader :transport
# The Transport object that'll send events for the client.
# @return [SpotlightTransport, nil]
attr_reader :spotlight_transport
# @!visibility private
attr_reader :log_event_buffer
# @!visibility private
attr_reader :metric_event_buffer
# @!macro configuration
attr_reader :configuration
# @param configuration [Configuration]
def initialize(configuration)
@configuration = configuration
@sdk_logger = configuration.sdk_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
@spotlight_transport = SpotlightTransport.new(configuration) if configuration.spotlight
if configuration.enable_logs
@log_event_buffer = LogEventBuffer.new(configuration, self)
end
if configuration.enable_metrics
@metric_event_buffer = MetricEventBuffer.new(configuration, self)
end
end
# Applies the given scope's data to the event and sends it to Sentry.
# @param event [Event] the event to be sent.
# @param scope [Scope] the scope with contextual data that'll be applied to the event before it's sent.
# @param hint [Hash] the hint data that'll be passed to `before_send` callback and the scope's event processors.
# @return [Event, nil]
def capture_event(event, scope, hint = {})
return unless configuration.sending_allowed?
if event.is_a?(ErrorEvent) && !configuration.sample_allowed?
transport.record_lost_event(:sample_rate, "error")
return
end
data_category = Envelope::Item.data_category(event.type)
is_transaction = event.is_a?(TransactionEvent)
spans_before = is_transaction ? event.spans.size : 0
event = scope.apply_to_event(event, hint)
if event.nil?
log_debug("Discarded event because one of the event processors returned nil")
transport.record_lost_event(:event_processor, data_category)
transport.record_lost_event(:event_processor, "span", num: spans_before + 1) if is_transaction
return
elsif is_transaction
spans_delta = spans_before - event.spans.size
transport.record_lost_event(:event_processor, "span", num: spans_delta) if spans_delta > 0
end
if configuration.background_worker_threads != 0 && hint.fetch(:background, true)
unless dispatch_background_event(event, hint)
transport.record_lost_event(:queue_overflow, data_category)
transport.record_lost_event(:queue_overflow, "span", num: spans_before + 1) if is_transaction
end
else
send_event(event, hint)
end
event
rescue => e
log_error("Event capturing failed", e, debug: configuration.debug)
nil
end
# Buffer a log event to be sent later with other logs in a single envelope
# @param event [LogEvent] the log event to be buffered
# @return [LogEvent]
def buffer_log_event(event, scope)
return unless event.is_a?(LogEvent)
@log_event_buffer.add_item(scope.apply_to_telemetry(event))
event
end
# Buffer a metric event to be sent later with other metrics in a single envelope
# @param event [MetricEvent] the metric event to be buffered
# @return [MetricEvent]
def buffer_metric_event(event, scope)
return unless event.is_a?(MetricEvent)
event = scope.apply_to_telemetry(event)
@metric_event_buffer.add_item(event)
event
end
# Capture an envelope directly.
# @param envelope [Envelope] the envelope to be captured.
# @return [void]
def capture_envelope(envelope)
Sentry.background_worker.perform { send_envelope(envelope) }
end
# Flush pending events to Sentry.
# @return [void]
def flush
transport.flush if configuration.sending_to_dsn_allowed?
spotlight_transport.flush if spotlight_transport
@log_event_buffer&.flush
@metric_event_buffer&.flush
end
# Initializes an Event object with the given exception. Returns `nil` if the exception's class is excluded from reporting.
# @param exception [Exception] the exception to be reported.
# @param hint [Hash] the hint data that'll be passed to `before_send` callback and the scope's event processors.
# @return [Event, nil]
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]]
mechanism = hint.delete(:mechanism) { Mechanism.new }
ErrorEvent.new(configuration: configuration, integration_meta: integration_meta).tap do |event|
event.add_exception_interface(exception, mechanism: mechanism)
event.add_threads_interface(crashed: true)
event.level = :error
end
end
# Initializes an Event object with the given message.
# @param message [String] the message to be reported.
# @param hint [Hash] the hint data that'll be passed to `before_send` callback and the scope's event processors.
# @return [Event]
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
# Initializes a CheckInEvent object with the given options.
#
# @param slug [String] identifier of this monitor
# @param status [Symbol] status of this check-in, one of {CheckInEvent::VALID_STATUSES}
# @param hint [Hash] the hint data that'll be passed to `before_send` callback and the scope's event processors.
# @param duration [Integer, nil] seconds elapsed since this monitor started
# @param monitor_config [Cron::MonitorConfig, nil] configuration for this monitor
# @param check_in_id [String, nil] for updating the status of an existing monitor
#
# @return [Event]
def event_from_check_in(
slug,
status,
hint = {},
duration: nil,
monitor_config: nil,
check_in_id: nil
)
return unless configuration.sending_allowed?
CheckInEvent.new(
configuration: configuration,
integration_meta: Sentry.integrations[hint[:integration]],
slug: slug,
status: status,
duration: duration,
monitor_config: monitor_config,
check_in_id: check_in_id
)
end
# Initializes a LogEvent object with the given message and options
#
# @param message [String] the log message
# @param level [Symbol] the log level (:trace, :debug, :info, :warn, :error, :fatal)
# @param options [Hash] additional options
# @option options [Array] :parameters Array of values to replace template tokens in the message
#
# @return [LogEvent] the created log event
def event_from_log(message, level:, **options)
return unless configuration.sending_allowed?
attributes = options.reject { |k, _| k == :level || k == :severity || k == :origin }
origin = options[:origin]
body = Utils::EncodingHelper.safe_utf_8_string(message)
sanitized_attributes = attributes.transform_values do |value|
if value.is_a?(String)
Utils::EncodingHelper.safe_utf_8_string(value)
else
value
end
end
LogEvent.new(level: level, body: body, attributes: sanitized_attributes, origin: origin)
end
# Initializes an Event object with the given Transaction object.
# @param transaction [Transaction] the transaction to be recorded.
# @return [TransactionEvent]
def event_from_transaction(transaction)
TransactionEvent.new(configuration: configuration, transaction: transaction)
end
# @!macro send_event
def send_event(event, hint = nil)
data_category = Envelope::Item.data_category(event.type)
spans_before = event.is_a?(TransactionEvent) ? event.spans.size : 0
if event.is_a?(ErrorEvent) && configuration.before_send
event = configuration.before_send.call(event, hint)
if !event.is_a?(ErrorEvent)
# Avoid serializing the event object in this case because we aren't sure what it is and what it contains
log_debug(<<~MSG)
Discarded event because before_send didn't return a Sentry::ErrorEvent object but an instance of #{event.class}
MSG
transport.record_lost_event(:before_send, data_category)
return
end
end
if event.is_a?(TransactionEvent) && configuration.before_send_transaction
event = configuration.before_send_transaction.call(event, hint)
if !event.is_a?(TransactionEvent)
# Avoid serializing the event object in this case because we aren't sure what it is and what it contains
log_debug(<<~MSG)
Discarded event because before_send_transaction didn't return a Sentry::TransactionEvent object but an instance of #{event.class}
MSG
transport.record_lost_event(:before_send, "transaction")
transport.record_lost_event(:before_send, "span", num: spans_before + 1)
return
end
spans_after = event.is_a?(TransactionEvent) ? event.spans.size : 0
spans_delta = spans_before - spans_after
transport.record_lost_event(:before_send, "span", num: spans_delta) if spans_delta > 0
end
if event.is_a?(CheckInEvent) && configuration.before_send_check_in
event = configuration.before_send_check_in.call(event, hint)
if !event.is_a?(CheckInEvent)
# Avoid serializing the event object in this case because we aren't sure what it is and what it contains
log_debug(<<~MSG)
Discarded event because before_send_check_in didn't return a Sentry::CheckInEvent object but an instance of #{event.class}
MSG
transport.record_lost_event(:before_send, data_category)
return
end
end
transport.send_event(event) if configuration.sending_to_dsn_allowed?
spotlight_transport.send_event(event) if spotlight_transport
event
rescue => e
log_error("Event sending failed", e, debug: configuration.debug)
transport.record_lost_event(:network_error, data_category)
transport.record_lost_event(:network_error, "span", num: spans_before + 1) if event.is_a?(TransactionEvent)
raise
end
# Send an envelope directly to Sentry.
# @param envelope [Envelope] the envelope to be sent.
# @return [void]
def send_envelope(envelope)
transport.send_envelope(envelope) if configuration.sending_to_dsn_allowed?
spotlight_transport.send_envelope(envelope) if spotlight_transport
rescue => e
log_error("Envelope sending failed", e, debug: configuration.debug)
envelope.items.map(&:data_category).each do |data_category|
transport.record_lost_event(:network_error, data_category)
end
raise
end
private
def dispatch_background_event(event, hint)
Sentry.background_worker.perform do
send_event(event, hint)
end
end
end
end
|