forked from getsentry/sentry-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathscope.py
More file actions
220 lines (166 loc) · 6.19 KB
/
scope.py
File metadata and controls
220 lines (166 loc) · 6.19 KB
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
from copy import copy
from collections import deque
from functools import wraps
from itertools import chain
from sentry_sdk.utils import logger, capture_internal_exceptions, object_to_json
global_event_processors = []
def add_global_event_processor(processor):
global_event_processors.append(processor)
def _attr_setter(fn):
return property(fset=fn, doc=fn.__doc__)
def _disable_capture(fn):
@wraps(fn)
def wrapper(self, *args, **kwargs):
if not self._should_capture:
return
try:
self._should_capture = False
return fn(self, *args, **kwargs)
finally:
self._should_capture = True
return wrapper
class Scope(object):
"""The scope holds extra information that should be sent with all
events that belong to it.
"""
__slots__ = (
"_level",
"_name",
"_fingerprint",
"_transaction",
"_user",
"_tags",
"_contexts",
"_extras",
"_breadcrumbs",
"_event_processors",
"_error_processors",
"_should_capture",
)
def __init__(self):
self._event_processors = []
self._error_processors = []
self._name = None
self.clear()
@_attr_setter
def level(self, value):
"""When set this overrides the level."""
self._level = value
@_attr_setter
def fingerprint(self, value):
"""When set this overrides the default fingerprint."""
self._fingerprint = value
@_attr_setter
def transaction(self, value):
"""When set this forces a specific transaction name to be set."""
self._transaction = value
@_attr_setter
def user(self, value):
"""When set a specific user is bound to the scope."""
self._user = value
def set_tag(self, key, value):
"""Sets a tag for a key to a specific value."""
self._tags[key] = value
def remove_tag(self, key):
"""Removes a specific tag."""
self._tags.pop(key, None)
def set_context(self, key, value):
"""Binds a context at a certain key to a specific value."""
self._contexts[key] = value
def remove_context(self, key):
"""Removes a context."""
self._contexts.pop(key, None)
def set_extra(self, key, value):
"""Sets an extra key to a specific value."""
self._extras[key] = value
def remove_extra(self, key):
"""Removes a specific extra key."""
self._extras.pop(key, None)
def clear(self):
"""Clears the entire scope."""
self._level = None
self._fingerprint = None
self._transaction = None
self._user = None
self._tags = {}
self._contexts = {}
self._extras = {}
self._breadcrumbs = deque()
self._should_capture = True
def add_event_processor(self, func):
""""Register a scope local event processor on the scope.
This function behaves like `before_send.`
"""
self._event_processors.append(func)
def add_error_processor(self, func, cls=None):
""""Register a scope local error processor on the scope.
The error processor works similar to an event processor but is
invoked with the original exception info triple as second argument.
"""
if cls is not None:
real_func = func
def func(event, exc_info):
try:
is_inst = isinstance(exc_info[1], cls)
except Exception:
is_inst = False
if is_inst:
return real_func(event, exc_info)
return event
self._error_processors.append(func)
@_disable_capture
def apply_to_event(self, event, hint=None):
"""Applies the information contained on the scope to the given event."""
def _drop(event, cause, ty):
logger.info("%s (%s) dropped event (%s)", ty, cause, event)
if self._level is not None:
event["level"] = self._level
event.setdefault("breadcrumbs", []).extend(self._breadcrumbs)
if event.get("user") is None and self._user is not None:
event["user"] = self._user
if event.get("transaction") is None and self._transaction is not None:
event["transaction"] = self._transaction
if event.get("fingerprint") is None and self._fingerprint is not None:
event["fingerprint"] = self._fingerprint
if self._extras:
event.setdefault("extra", {}).update(object_to_json(self._extras))
if self._tags:
event.setdefault("tags", {}).update(self._tags)
if self._contexts:
event.setdefault("contexts", {}).update(self._contexts)
exc_info = hint.get("exc_info") if hint is not None else None
if exc_info is not None:
for processor in self._error_processors:
new_event = processor(event, exc_info)
if new_event is None:
return _drop(event, processor, "error processor")
event = new_event
for processor in chain(global_event_processors, self._event_processors):
new_event = event
with capture_internal_exceptions():
new_event = processor(event, hint)
if new_event is None:
return _drop(event, processor, "event processor")
event = new_event
return event
def __copy__(self):
rv = object.__new__(self.__class__)
rv._level = self._level
rv._name = self._name
rv._fingerprint = self._fingerprint
rv._transaction = self._transaction
rv._user = self._user
rv._tags = dict(self._tags)
rv._contexts = dict(self._contexts)
rv._extras = dict(self._extras)
rv._breadcrumbs = copy(self._breadcrumbs)
rv._event_processors = list(self._event_processors)
rv._error_processors = list(self._error_processors)
rv._should_capture = self._should_capture
return rv
def __repr__(self):
return "<%s id=%s name=%s>" % (
self.__class__.__name__,
hex(id(self)),
self._name,
)