Class: Sentry::Client

Inherits:
Object
  • Object
show all
Includes:
LoggingHelper
Defined in:
lib/sentry/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(configuration) ⇒ Client

Returns a new instance of Client.

Parameters:



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
 
# File 'lib/sentry/client.rb', line 33

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

Instance Attribute Details

#configuration ⇒ Configuration (readonly)

The Configuration object that’s used for configuring the client and its transport.

Returns:



30
31
32
 
# File 'lib/sentry/client.rb', line 30

def configuration
  @configuration
end

#spotlight_transport ⇒ SpotlightTransport? (readonly)

The Transport object that’ll send events for the client.

Returns:



21
22
23
 
# File 'lib/sentry/client.rb', line 21

def spotlight_transport
  @spotlight_transport
end

#transport ⇒ Transport (readonly)

The Transport object that’ll send events for the client.

Returns:



17
18
19
 
# File 'lib/sentry/client.rb', line 17

def transport
  @transport
end

Instance Method Details

#buffer_log_event(event, scope) ⇒ LogEvent

Buffer a log event to be sent later with other logs in a single envelope

Parameters:

  • event (LogEvent) —

    the log event to be buffered

Returns:



108
109
110
111
112
 
# File 'lib/sentry/client.rb', line 108

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_metric_event(event, scope) ⇒ MetricEvent

Buffer a metric event to be sent later with other metrics in a single envelope

Parameters:

  • event (MetricEvent) —

    the metric event to be buffered

Returns:



117
118
119
120
121
122
 
# File 'lib/sentry/client.rb', line 117

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_envelope(envelope) ⇒ void

This method returns an undefined value.

Capture an envelope directly.

Parameters:

  • envelope (Envelope) —

    the envelope to be captured.



127
128
129
 
# File 'lib/sentry/client.rb', line 127

def capture_envelope(envelope)
  Sentry.background_worker.perform { send_envelope(envelope) }
end

#capture_event(event, scope, hint = {}) ⇒ Event?

Applies the given scope’s data to the event and sends it to Sentry.

Parameters:

  • event (Event) —

    the event to be sent.

  • scope (Scope) —

    the scope with contextual data that’ll be applied to the event before it’s sent.

  • hint (Hash) (defaults to: {}) —

    the hint data that’ll be passed to before_send callback and the scope’s event processors.

Returns:



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
 
# File 'lib/sentry/client.rb', line 65

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

#event_from_check_in(slug, status, hint = {}, duration: nil, monitor_config: nil, check_in_id: nil) ⇒ Event

Initializes a CheckInEvent object with the given options.

Parameters:

  • slug (String) —

    identifier of this monitor

  • status (Symbol) —

    status of this check-in, one of Sentry::CheckInEvent::VALID_STATUSES

  • hint (Hash) (defaults to: {}) —

    the hint data that’ll be passed to before_send callback and the scope’s event processors.

  • duration (Integer, nil) (defaults to: nil) —

    seconds elapsed since this monitor started

  • monitor_config (Cron::MonitorConfig, nil) (defaults to: nil) —

    configuration for this monitor

  • check_in_id (String, nil) (defaults to: nil) —

    for updating the status of an existing monitor

Returns:



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/sentry/client.rb', line 184

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

#event_from_exception(exception, hint = {}) ⇒ Event?

Initializes an Event object with the given exception. Returns nil if the exception’s class is excluded from reporting.

Parameters:

  • exception (Exception) —

    the exception to be reported.

  • hint (Hash) (defaults to: {}) —

    the hint data that’ll be passed to before_send callback and the scope’s event processors.

Returns:



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/sentry/client.rb', line 144

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

#event_from_log(message, level:, **options) ⇒ LogEvent

Initializes a LogEvent object with the given message and options

Parameters:

  • message (String) —

    the log message

  • level (Symbol) —

    the log level (:trace, :debug, :info, :warn, :error, :fatal)

  • options (Hash) —

    additional options

Options Hash (**options):

  • :parameters (Array) —

    Array of values to replace template tokens in the message

Returns:



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/sentry/client.rb', line 213

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

#event_from_message(message, hint = {}, backtrace: nil) ⇒ Event

Initializes an Event object with the given message.

Parameters:

  • message (String) —

    the message to be reported.

  • hint (Hash) (defaults to: {}) —

    the hint data that’ll be passed to before_send callback and the scope’s event processors.

Returns:



164
165
166
167
168
169
170
171
172
 
# File 'lib/sentry/client.rb', line 164

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

#event_from_transaction(transaction) ⇒ TransactionEvent

Initializes an Event object with the given Transaction object.

Parameters:

  • transaction (Transaction) —

    the transaction to be recorded.

Returns:



234
235
236
 
# File 'lib/sentry/client.rb', line 234

def event_from_transaction(transaction)
  TransactionEvent.new(configuration: configuration, transaction: transaction)
end

#flush ⇒ void

This method returns an undefined value.

Flush pending events to Sentry.



133
134
135
136
137
138
 
# File 'lib/sentry/client.rb', line 133

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

#send_envelope(envelope) ⇒ void

This method returns an undefined value.

Send an envelope directly to Sentry.

Parameters:

  • envelope (Envelope) —

    the envelope to be sent.



301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/sentry/client.rb', line 301

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

#send_event(event, hint = nil) ⇒ Event

Sends the event to Sentry.

Parameters:

  • event (Event) —

    the event to be sent.

  • hint (Hash) (defaults to: nil) —

    the hint data that’ll be passed to before_send callback.

Returns:



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
 
# File 'lib/sentry/client.rb', line 239

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