Class: Sentry::Hub

Inherits:
Object
  • Object
show all
Includes:
ArgumentCheckingHelper
Defined in:
lib/sentry/hub.rb

Defined Under Namespace

Classes: Layer

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client, scope) ⇒ Hub

Returns a new instance of Hub.



13
14
15
16
17
 
# File 'lib/sentry/hub.rb', line 13

def initialize(client, scope)
  first_layer = Layer.new(client, scope)
  @stack = [first_layer]
  @last_event_id = nil
end

Instance Attribute Details

#last_event_id ⇒ Object (readonly)

Returns the value of attribute last_event_id.



11
12
13
 
# File 'lib/sentry/hub.rb', line 11

def last_event_id
  @last_event_id
end

Instance Method Details

#add_breadcrumb(breadcrumb, hint: {}) ⇒ Object 



222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/sentry/hub.rb', line 222

def add_breadcrumb(breadcrumb, hint: {})
  return unless current_client
  return unless configuration.enabled_in_current_env?

  if before_breadcrumb = current_client.configuration.before_breadcrumb
    breadcrumb = before_breadcrumb.call(breadcrumb, hint)
  end

  return unless breadcrumb

  current_scope.add_breadcrumb(breadcrumb)
end

#bind_client(client) ⇒ Object 



45
46
47
48
49
50
51
 
# File 'lib/sentry/hub.rb', line 45

def bind_client(client)
  layer = current_layer

  if layer
    layer.client = client
  end
end

#capture_check_in(slug, status, **options) ⇒ Object 



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/sentry/hub.rb', line 165

def capture_check_in(slug, status, **options)
  check_argument_type!(slug, ::String)
  check_argument_includes!(status, Sentry::CheckInEvent::VALID_STATUSES)

  return unless current_client

  options[:hint] ||= {}
  options[:hint][:slug] = slug

  event = current_client.event_from_check_in(
    slug,
    status,
    options[:hint],
    duration: options.delete(:duration),
    monitor_config: options.delete(:monitor_config),
    check_in_id: options.delete(:check_in_id)
  )

  return unless event

  capture_event(event, **options)
  event.check_in_id
end

#capture_event(event, **options, &block) ⇒ Object 



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

def capture_event(event, **options, &block)
  check_argument_type!(event, Sentry::Event)

  return unless current_client

  hint = options.delete(:hint) || {}
  scope = current_scope.dup

  if block
    block.call(scope)
  elsif custom_scope = options[:scope]
    scope.update_from_scope(custom_scope)
  elsif !options.empty?
    unsupported_option_keys = scope.update_from_options(**options)

    unless unsupported_option_keys.empty?
      configuration.log_debug <<~MSG
        Options #{unsupported_option_keys} are not supported and will not be applied to the event.
        You may want to set them under the `extra` option.
      MSG
    end
  end

  event = current_client.capture_event(event, scope, hint)

  if event && configuration.debug
    configuration.log_debug(event.to_json_compatible)
  end

  @last_event_id = event&.event_id if event.is_a?(Sentry::ErrorEvent)
  event
end

#capture_exception(exception, **options, &block) ⇒ Object 



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

def capture_exception(exception, **options, &block)
  if RUBY_PLATFORM == "java"
    check_argument_type!(exception, ::Exception, ::Java::JavaLang::Throwable)
  else
    check_argument_type!(exception, ::Exception)
  end

  return if Sentry.exception_captured?(exception)

  return unless current_client

  options[:hint] ||= {}
  options[:hint][:exception] = exception

  event = current_client.event_from_exception(exception, options[:hint])

  return unless event

  current_scope.session&.update_from_exception(event.exception)

  capture_event(event, **options, &block).tap do
    # mark the exception as captured so we can use this information to avoid duplicated capturing
    exception.instance_variable_set(Sentry::CAPTURED_SIGNATURE, true)
  end
end

#capture_message(message, **options, &block) ⇒ Object 



150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/sentry/hub.rb', line 150

def capture_message(message, **options, &block)
  check_argument_type!(message, ::String)

  return unless current_client

  options[:hint] ||= {}
  options[:hint][:message] = message
  backtrace = options.delete(:backtrace)
  event = current_client.event_from_message(message, options[:hint], backtrace: backtrace)

  return unless event

  capture_event(event, **options, &block)
end

#clone ⇒ Object 



35
36
37
38
39
40
41
42
43
 
# File 'lib/sentry/hub.rb', line 35

def clone
  layer = current_layer

  if layer
    scope = layer.scope&.dup

    Hub.new(layer.client, scope)
  end
end

#configuration ⇒ Object 



27
28
29
 
# File 'lib/sentry/hub.rb', line 27

def configuration
  current_client.configuration
end

#configure_scope(&block) ⇒ Object 



53
54
55
 
# File 'lib/sentry/hub.rb', line 53

def configure_scope(&block)
  block.call(current_scope)
end

#continue_trace(env, **options) ⇒ Object 



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/sentry/hub.rb', line 302

def continue_trace(env, **options)
  configure_scope { |s| s.generate_propagation_context(env) }

  return nil unless configuration.tracing_enabled?

  propagation_context = current_scope.propagation_context
  return nil unless propagation_context.incoming_trace

  Transaction.new(
    hub: self,
    trace_id: propagation_context.trace_id,
    parent_span_id: propagation_context.parent_span_id,
    parent_sampled: propagation_context.parent_sampled,
    baggage: propagation_context.baggage,
    **options
  )
end

#current_client ⇒ Object 



23
24
25
 
# File 'lib/sentry/hub.rb', line 23

def current_client
  current_layer&.client
end

#current_scope ⇒ Object 



31
32
33
 
# File 'lib/sentry/hub.rb', line 31

def current_scope
  current_layer&.scope
end

#end_session ⇒ Object 



251
252
253
254
255
256
257
258
259
 
# File 'lib/sentry/hub.rb', line 251

def end_session
  return unless current_scope
  session = current_scope.session
  current_scope.set_session(nil)

  return unless session
  session.close
  Sentry.session_flusher.add_session(session)
end

#get_baggage ⇒ Object 



277
278
279
280
281
282
 
# File 'lib/sentry/hub.rb', line 277

def get_baggage
  return nil unless current_scope

  current_scope.get_span&.to_baggage ||
    current_scope.propagation_context.get_baggage&.serialize
end

#get_trace_propagation_headers ⇒ Object 



284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/sentry/hub.rb', line 284

def get_trace_propagation_headers
  headers = {}

  traceparent = get_traceparent
  headers[SENTRY_TRACE_HEADER_NAME] = traceparent if traceparent

  baggage = get_baggage
  headers[BAGGAGE_HEADER_NAME] = baggage if baggage && !baggage.empty?

  headers
end

#get_trace_propagation_meta ⇒ Object 



296
297
298
299
300
 
# File 'lib/sentry/hub.rb', line 296

def get_trace_propagation_meta
  get_trace_propagation_headers.map do |k, v|
    "<meta name=\"#{k}\" content=\"#{v}\">"
  end.join("\n")
end

#get_traceparent ⇒ Object 



270
271
272
273
274
275
 
# File 'lib/sentry/hub.rb', line 270

def get_traceparent
  return nil unless current_scope

  current_scope.get_span&.to_sentry_trace ||
    current_scope.propagation_context.get_traceparent
end

#new_from_top ⇒ Object 



19
20
21
 
# File 'lib/sentry/hub.rb', line 19

def new_from_top
  Hub.new(current_client, current_scope)
end

#pop_scope ⇒ Object 



75
76
77
78
79
80
81
82
83
 
# File 'lib/sentry/hub.rb', line 75

def pop_scope
  if @stack.size > 1
    @stack.pop
  else
    # We never want to enter a situation where we have no scope and no client
    client = current_client
    @stack = [Layer.new(client, Scope.new)]
  end
end

#push_scope ⇒ Object 



64
65
66
67
68
69
70
71
72
73
 
# File 'lib/sentry/hub.rb', line 64

def push_scope
  new_scope =
    if current_scope
      current_scope.dup
    else
      Scope.new
    end

  @stack << Layer.new(current_client, new_scope)
end

#start_session ⇒ Object 



246
247
248
249
 
# File 'lib/sentry/hub.rb', line 246

def start_session
  return unless current_scope
  current_scope.set_session(Session.new)
end

#start_transaction(transaction: nil, custom_sampling_context: {}, instrumenter: :sentry, **options) ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/sentry/hub.rb', line 85

def start_transaction(transaction: nil, custom_sampling_context: {}, instrumenter: :sentry, **options)
  return unless configuration.tracing_enabled?
  return unless instrumenter == configuration.instrumenter

  transaction ||= Transaction.new(**options.merge(hub: self))

  sampling_context = {
    transaction_context: transaction.to_hash,
    parent_sampled: transaction.parent_sampled
  }

  sampling_context.merge!(custom_sampling_context)
  transaction.set_initial_sample_decision(sampling_context: sampling_context)

  transaction.start_profiler!

  transaction
end

#with_background_worker_disabled(&block) ⇒ Object

this doesn’t do anything to the already initialized background worker but it temporarily disables dispatching events to it



237
238
239
240
241
242
243
244
 
# File 'lib/sentry/hub.rb', line 237

def with_background_worker_disabled(&block)
  original_background_worker_threads = configuration.background_worker_threads
  configuration.background_worker_threads = 0

  block.call
ensure
  configuration.background_worker_threads = original_background_worker_threads
end

#with_child_span(instrumenter: :sentry, **attributes, &block) ⇒ Object 



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/sentry/hub.rb', line 104

def with_child_span(instrumenter: :sentry, **attributes, &block)
  return yield(nil) unless instrumenter == configuration.instrumenter

  current_span = current_scope.get_span
  return yield(nil) unless current_span

  result = nil

  begin
    current_span.with_child_span(**attributes) do |child_span|
      current_scope.set_span(child_span)
      result = yield(child_span)
    end
  ensure
    current_scope.set_span(current_span)
  end

  result
end

#with_scope(&block) ⇒ Object 



57
58
59
60
61
62
 
# File 'lib/sentry/hub.rb', line 57

def with_scope(&block)
  push_scope
  yield(current_scope)
ensure
  pop_scope
end

#with_session_tracking(&block) ⇒ Object 



261
262
263
264
265
266
267
268
 
# File 'lib/sentry/hub.rb', line 261

def with_session_tracking(&block)
  return yield unless configuration.session_tracking?

  start_session
  yield
ensure
  end_session
end