Repository navigation
Expand file tree
/
Copy path_types.py
More file actions
428 lines (375 loc) · 13.2 KB
/
Copy path_types.py
File metadata and controls
428 lines (375 loc) · 13.2 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
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
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
try:
from re import Pattern
except ImportError:
# 3.6
from typing import Pattern
from typing import TYPE_CHECKING, TypeVar, Union
# Re-exported for compat, since code out there in the wild might use this variable.
MYPY = TYPE_CHECKING
SENSITIVE_DATA_SUBSTITUTE = "[Filtered]"
BLOB_DATA_SUBSTITUTE = "[Blob substitute]"
OVER_SIZE_LIMIT_SUBSTITUTE = "[Exceeds maximum size]"
UNPARSABLE_RAW_DATA_SUBSTITUTE = "[Unparsable]"
class AnnotatedValue:
"""
Meta information for a data field in the event payload.
This is to tell Relay that we have tampered with the fields value.
See:
https://github.com/getsentry/relay/blob/be12cd49a0f06ea932ed9b9f93a655de5d6ad6d1/relay-general/src/types/meta.rs#L407-L423
"""
__slots__ = ("value", "metadata")
def __init__(self, value: "Optional[Any]", metadata: "Dict[str, Any]") -> None:
self.value = value
self.metadata = metadata
def __eq__(self, other: "Any") -> bool:
if not isinstance(other, AnnotatedValue):
return False
return self.value == other.value and self.metadata == other.metadata
def __str__(self: "AnnotatedValue") -> str:
return str({"value": str(self.value), "metadata": str(self.metadata)})
def __len__(self: "AnnotatedValue") -> int:
if self.value is not None:
return len(self.value)
else:
return 0
@classmethod
def removed_because_raw_data(cls) -> "AnnotatedValue":
"""The value was removed because it could not be parsed. This is done for request body values that are not json nor a form."""
# This is the legacy approach - we want to transition over to `substituted_because_raw_data` after we completely transition
# to span-first
return AnnotatedValue(
value="",
metadata={
"rem": [ # Remark
[
"!raw", # Unparsable raw data
"x", # The fields original value was removed
]
]
},
)
@classmethod
def substituted_because_raw_data(cls) -> "AnnotatedValue":
"""The value was replaced because it could not be parsed. This is done for request body values that are not json nor a form."""
return AnnotatedValue(
value=UNPARSABLE_RAW_DATA_SUBSTITUTE,
metadata={
"rem": [ # Remark
[
"!raw", # Unparsable raw data
"s", # The fields original value was substituted
]
]
},
)
@classmethod
def removed_because_over_size_limit(cls, value: "Any" = "") -> "AnnotatedValue":
"""
The actual value was removed because the size of the field exceeded the configured maximum size,
for example specified with the max_request_body_size sdk option.
"""
# This is the legacy approach - we want to transition over to `substituted_because_over_size_limit` after we completely transition
# to span-first
return AnnotatedValue(
value=value,
metadata={
"rem": [ # Remark
[
"!config", # Because of configured maximum size
"x", # The fields original value was removed
]
]
},
)
@classmethod
def substituted_because_over_size_limit(
cls, value: "Any" = OVER_SIZE_LIMIT_SUBSTITUTE
) -> "AnnotatedValue":
"""
The actual value was replaced because the size of the field exceeded the configured maximum size,
for example specified with the max_request_body_size sdk option.
"""
return AnnotatedValue(
value=value,
metadata={
"rem": [ # Remark
[
"!config", # Because of configured maximum size
"s", # The fields original value was substituted
]
]
},
)
@classmethod
def substituted_because_contains_sensitive_data(cls) -> "AnnotatedValue":
"""The actual value was removed because it contained sensitive information."""
return AnnotatedValue(
value=SENSITIVE_DATA_SUBSTITUTE,
metadata={
"rem": [ # Remark
[
"!config", # Because of SDK configuration (in this case the config is the hard coded removal of certain django cookies)
"s", # The fields original value was substituted
]
]
},
)
T = TypeVar("T")
Annotated = Union[AnnotatedValue, T]
if TYPE_CHECKING:
from collections.abc import Container, MutableMapping, Sequence
from datetime import datetime
from types import TracebackType
from typing import Any, Callable, Dict, Mapping, NotRequired, Optional, Type
from typing_extensions import Literal, TypedDict
import sentry_sdk
class SDKInfo(TypedDict):
name: str
version: str
packages: "Sequence[Mapping[str, str]]"
# "critical" is an alias of "fatal" recognized by Relay
LogLevelStr = Literal["fatal", "critical", "error", "warning", "info", "debug"]
DurationUnit = Literal[
"nanosecond",
"microsecond",
"millisecond",
"second",
"minute",
"hour",
"day",
"week",
]
InformationUnit = Literal[
"bit",
"byte",
"kilobyte",
"kibibyte",
"megabyte",
"mebibyte",
"gigabyte",
"gibibyte",
"terabyte",
"tebibyte",
"petabyte",
"pebibyte",
"exabyte",
"exbibyte",
]
FractionUnit = Literal["ratio", "percent"]
MeasurementUnit = Union[DurationUnit, InformationUnit, FractionUnit, str]
MeasurementValue = TypedDict(
"MeasurementValue",
{
"value": float,
"unit": NotRequired[Optional[MeasurementUnit]],
},
)
Event = TypedDict(
"Event",
{
"breadcrumbs": Annotated[
dict[Literal["values"], list[dict[str, Any]]]
], # TODO: We can expand on this type
"check_in_id": str,
"contexts": dict[str, dict[str, object]],
"dist": str,
"duration": Optional[float],
"environment": Optional[str],
"errors": list[dict[str, Any]], # TODO: We can expand on this type
"event_id": str,
"exception": dict[
Literal["values"], list[dict[str, Any]]
], # TODO: We can expand on this type
"extra": MutableMapping[str, object],
"fingerprint": list[str],
"level": LogLevelStr,
"logentry": Mapping[str, object],
"logger": str,
"measurements": dict[str, MeasurementValue],
"message": str,
"modules": dict[str, str],
"monitor_config": Mapping[str, object],
"monitor_slug": Optional[str],
"platform": Literal["python"],
"profile": object, # Should be sentry_sdk.profiler.Profile, but we can't import that here due to circular imports
"release": Optional[str],
"request": dict[str, object],
"sdk": Mapping[str, object],
"server_name": str,
"spans": Annotated[list[dict[str, object]]],
"stacktrace": dict[
str, object
], # We access this key in the code, but I am unsure whether we ever set it
"start_timestamp": datetime,
"status": Optional[str],
"tags": MutableMapping[
str, str
], # Tags must be less than 200 characters each
"threads": dict[
Literal["values"], list[dict[str, Any]]
], # TODO: We can expand on this type
"timestamp": Optional[datetime], # Must be set before sending the event
"transaction": str,
"transaction_info": Mapping[str, Any], # TODO: We can expand on this type
"type": Literal["check_in", "transaction"],
"user": dict[str, object],
"_dropped_spans": int,
"_has_gen_ai_span": bool,
},
total=False,
)
ExcInfo = Union[
tuple[Type[BaseException], BaseException, Optional[TracebackType]],
tuple[None, None, None],
]
# TODO: Make a proper type definition for this (PRs welcome!)
Hint = Dict[str, Any]
AttributeValue = (
str
| bool
| float
| int
| list[str]
| list[bool]
| list[float]
| list[int]
| tuple[str, ...]
| tuple[bool, ...]
| tuple[float, ...]
| tuple[int, ...]
)
Attributes = dict[str, AttributeValue]
SerializedAttributeValue = TypedDict(
# https://develop.sentry.dev/sdk/telemetry/attributes/#supported-types
"SerializedAttributeValue",
{
"type": Literal[
"string",
"boolean",
"double",
"integer",
"array",
],
"value": AttributeValue,
},
)
Log = TypedDict(
"Log",
{
"severity_text": str,
"severity_number": int,
"body": str,
"attributes": Attributes,
"time_unix_nano": int,
"trace_id": Optional[str],
"span_id": Optional[str],
},
)
MetricType = Literal["counter", "gauge", "distribution"]
MetricUnit = Union[DurationUnit, InformationUnit, str]
Metric = TypedDict(
"Metric",
{
"timestamp": float,
"trace_id": Optional[str],
"span_id": Optional[str],
"name": str,
"type": MetricType,
"value": float,
"unit": Optional[MetricUnit],
"attributes": Attributes,
},
)
MetricProcessor = Callable[[Metric, Hint], Optional[Metric]]
SpanJSON = TypedDict(
"SpanJSON",
{
"trace_id": str,
"span_id": str,
"parent_span_id": NotRequired[str],
"name": str,
"status": str,
"is_segment": bool,
"start_timestamp": float,
"end_timestamp": NotRequired[float],
"attributes": NotRequired[Attributes],
"_segment_span": NotRequired["sentry_sdk.traces.StreamedSpan"],
},
)
# TODO: Make a proper type definition for this (PRs welcome!)
Breadcrumb = Dict[str, Any]
# TODO: Make a proper type definition for this (PRs welcome!)
BreadcrumbHint = Dict[str, Any]
# TODO: Make a proper type definition for this (PRs welcome!)
SamplingContext = Dict[str, Any]
EventProcessor = Callable[[Event, Hint], Optional[Event]]
ErrorProcessor = Callable[[Event, ExcInfo], Optional[Event]]
BreadcrumbProcessor = Callable[[Breadcrumb, BreadcrumbHint], Optional[Breadcrumb]]
TransactionProcessor = Callable[[Event, Hint], Optional[Event]]
LogProcessor = Callable[[Log, Hint], Optional[Log]]
TracesSampler = Callable[[SamplingContext], Union[float, int, bool]]
# https://github.com/python/mypy/issues/5710
NotImplementedType = Any
EventDataCategory = Literal[
"default",
"error",
"crash",
"transaction",
"security",
"attachment",
"session",
"internal",
"profile",
"profile_chunk",
"monitor",
"span",
"log_item",
"log_byte",
"trace_metric",
]
SessionStatus = Literal["ok", "exited", "crashed", "abnormal"]
ContinuousProfilerMode = Literal["thread", "gevent", "unknown"]
ProfilerMode = Union[ContinuousProfilerMode, Literal["sleep"]]
MonitorConfigScheduleType = Literal["crontab", "interval"]
MonitorConfigScheduleUnit = Literal[
"year",
"month",
"week",
"day",
"hour",
"minute",
"second", # not supported in Sentry and will result in a warning
]
MonitorConfigSchedule = TypedDict(
"MonitorConfigSchedule",
{
"type": MonitorConfigScheduleType,
"value": Union[int, str],
"unit": MonitorConfigScheduleUnit,
},
total=False,
)
MonitorConfig = TypedDict(
"MonitorConfig",
{
"schedule": MonitorConfigSchedule,
"timezone": str,
"checkin_margin": int,
"max_runtime": int,
"failure_issue_threshold": int,
"recovery_threshold": int,
"owner": str,
},
total=False,
)
HttpStatusCodeRange = Union[int, Container[int]]
class TextPart(TypedDict):
type: Literal["text"]
content: str
IgnoreSpansName = Union[str, Pattern[str]]
IgnoreSpansContext = TypedDict(
"IgnoreSpansContext",
{"name": IgnoreSpansName, "attributes": Attributes},
total=False,
)
IgnoreSpansConfig = list[Union[IgnoreSpansName, IgnoreSpansContext]]