-
-
Notifications
You must be signed in to change notification settings - Fork 479
/
scope.rb
366 lines (319 loc) · 9.67 KB
/
scope.rb
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
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
# frozen_string_literal: true
require "sentry/breadcrumb_buffer"
require "sentry/propagation_context"
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,
:propagation_context
]
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)
unless event.is_a?(CheckInEvent)
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
event.fingerprint = fingerprint
event.level = level
event.breadcrumbs = breadcrumbs
event.rack_env = rack_env if rack_env
end
if span
event.contexts[:trace] ||= span.get_trace_context
else
event.contexts[:trace] ||= propagation_context.get_trace_context
event.dynamic_sampling_context ||= propagation_context.get_dynamic_sampling_context
end
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.propagation_context = propagation_context.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
self.propagation_context = scope.propagation_context
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,
**options
)
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_hash.values.each do |val|
check_argument_type!(val, Hash)
end
@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
# These are high cardinality and thus bad.
# @return [Boolean]
def transaction_source_low_quality?
transaction_source == :url
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
# Generate a new propagation context either from the incoming env headers or from scratch.
# @param env [Hash, nil]
# @return [void]
def generate_propagation_context(env = nil)
@propagation_context = PropagationContext.new(self, env)
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
generate_propagation_context
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],
machine: uname[:machine]
}
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