Repository navigation
Expand file tree
/
Copy pathstdlib.py
More file actions
654 lines (547 loc) · 23.9 KB
/
Copy pathstdlib.py
File metadata and controls
654 lines (547 loc) · 23.9 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
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
import os
import platform
import subprocess
import sys
from http.client import HTTPConnection, HTTPResponse
from typing import TYPE_CHECKING
import sentry_sdk
from sentry_sdk.consts import _SENTRY_HEADER_NAMES, OP, SPANDATA
from sentry_sdk.integrations import Integration
from sentry_sdk.scope import add_global_event_processor
from sentry_sdk.traces import StreamedSpan
from sentry_sdk.tracing import SENTRY_TRACE_HEADER_NAME, Span
from sentry_sdk.tracing_utils import (
EnvironHeaders,
add_http_breadcrumb,
add_http_request_source,
get_url_attributes,
has_span_streaming_enabled,
should_propagate_trace,
)
from sentry_sdk.utils import (
SENSITIVE_DATA_SUBSTITUTE,
_get_aws_sigv4_signed_headers_from_authorization_header,
_get_aws_sigv4_signed_headers_from_url_query_string,
capture_internal_exceptions,
ensure_integration_enabled,
is_sentry_url,
logger,
parse_url,
safe_repr,
)
if TYPE_CHECKING:
from typing import Any, Callable, Dict, List, Optional, Set, Union
from sentry_sdk._types import Event, Hint
_RUNTIME_CONTEXT: "dict[str, object]" = {
"name": platform.python_implementation(),
"version": "%s.%s.%s" % (sys.version_info[:3]),
"build": sys.version,
}
try:
from botocore.awsrequest import AWSHTTPConnection, AWSHTTPSConnection
except ImportError:
AWSHTTPConnection = None # type: ignore[misc,assignment]
AWSHTTPSConnection = None # type: ignore[misc,assignment]
class StdlibIntegration(Integration):
identifier = "stdlib"
@staticmethod
def setup_once() -> None:
_install_httplib()
_install_subprocess()
@add_global_event_processor
def add_python_runtime_context(
event: "Event", hint: "Hint"
) -> "Optional[Event]":
client = sentry_sdk.get_client()
if client.get_integration(StdlibIntegration) is not None:
contexts = event.setdefault("contexts", {})
if isinstance(contexts, dict) and "runtime" not in contexts:
contexts["runtime"] = _RUNTIME_CONTEXT
return event
def _complete_span(span: "Union[Span, StreamedSpan]") -> None:
if isinstance(span, StreamedSpan):
with capture_internal_exceptions():
add_http_request_source(span)
span.end()
else:
span.finish()
with capture_internal_exceptions():
add_http_request_source(span)
def _get_wrapped_putheader(
original_putheader: "Callable[..., Any]",
) -> "Callable[..., Any]":
"""Record existing `sentry-trace` and SigV4-signed propagation headers to skip."""
def putheader(self: "HTTPConnection", header: "Any", *values: "Any") -> "Any":
rv = original_putheader(self, header, *values)
headers_to_skip: "Optional[Set[str]]" = getattr(
self, "_sentrysdk_headers_to_skip", None
)
if headers_to_skip is None:
return rv
if isinstance(header, bytes):
normalized_header = header.decode("ascii", "ignore").lower()
elif isinstance(header, str):
normalized_header = header.lower()
else:
return rv
# existing `sentry-trace`: skip so it is not duplicated.
if normalized_header == SENTRY_TRACE_HEADER_NAME:
headers_to_skip.add(normalized_header)
if normalized_header == "authorization" and values:
with capture_internal_exceptions():
authorization = values[0]
if isinstance(authorization, bytes):
authorization = authorization.decode("latin-1")
# `SignedHeaders` lists fields covered by SigV4.
signed_headers = (
_get_aws_sigv4_signed_headers_from_authorization_header(
authorization
)
)
# skip signed `sentry-trace` and `baggage`.
headers_to_skip.update(
_SENTRY_HEADER_NAMES.intersection(signed_headers)
)
return rv
return putheader
def _get_wrapped_endheaders(
original_endheaders: "Callable[..., Any]",
) -> "Callable[..., Any]":
"""
Add unsigned propagation headers immediately before sending.
`sentry-trace`: add if missing; leave an existing or signed value as-is.
`baggage`: add if missing; append if unsigned since multiple fields are
allowed and combined (https://www.w3.org/TR/baggage/#baggage-http-header-format);
leave a signed value as-is since it is part of the SigV4 signature.
"""
def endheaders(self: "HTTPConnection", *args: "Any", **kwargs: "Any") -> "Any":
real_url = getattr(self, "_sentrysdk_real_url", None)
span = getattr(self, "_sentrysdk_span", None)
try:
if real_url is not None:
with capture_internal_exceptions():
headers_to_skip = getattr(self, "_sentrysdk_headers_to_skip", None)
if headers_to_skip is not None:
# presigned URLs list signed names in the query string.
query_signed_headers = (
_get_aws_sigv4_signed_headers_from_url_query_string(
real_url
)
)
headers_to_skip.update(
_SENTRY_HEADER_NAMES.intersection(query_signed_headers)
)
for (
header_name,
header_value,
) in sentry_sdk.get_current_scope().iter_trace_propagation_headers(
span=span
):
# skip signed headers and an existing `sentry-trace`.
if header_name.lower() in headers_to_skip:
continue
logger.debug(
"[Tracing] Adding `{key}` header {value} to outgoing request to {real_url}.".format(
key=header_name,
value=header_value,
real_url=real_url,
)
)
self.putheader(header_name, header_value)
return original_endheaders(self, *args, **kwargs)
finally:
self._sentrysdk_real_url = None # type: ignore[attr-defined]
return endheaders
def _get_wrapped_putrequest(
original_putrequest: "Callable[..., Any]",
) -> "Callable[..., Any]":
"""Start `headers_to_skip` before headers are written."""
def putrequest(
self: "HTTPConnection", method: str, url: str, *args: "Any", **kwargs: "Any"
) -> "Any":
# existing `sentry-trace` and SigV4-signed propagation headers are skipped.
self._sentrysdk_headers_to_skip = set() # type: ignore[attr-defined]
try:
rv = original_putrequest(self, method, url, *args, **kwargs)
except BaseException:
# do not leave partial request state on a reusable connection when
# the underlying request setup fails.
self._sentrysdk_headers_to_skip = None # type: ignore[attr-defined]
raise
return rv
return putrequest
def _patch_aws_connection() -> None:
"""
Patch AWS connection classes so trace propagation does not break SigV4.
Botocore signs the request before headers reach HTTPConnection. Wait until
`endheaders()` to add unsigned propagation headers, after `putheader()` has
recorded existing `sentry-trace` and signed field names.
"""
if AWSHTTPConnection is not None:
AWSHTTPConnection.putheader = _get_wrapped_putheader( # type: ignore[method-assign]
AWSHTTPConnection.putheader
)
AWSHTTPConnection.endheaders = _get_wrapped_endheaders( # type: ignore[method-assign]
AWSHTTPConnection.endheaders
)
AWSHTTPConnection.putrequest = _get_wrapped_putrequest( # type: ignore[method-assign]
AWSHTTPConnection.putrequest
)
if AWSHTTPSConnection is not None:
AWSHTTPSConnection.putheader = _get_wrapped_putheader( # type: ignore[method-assign]
AWSHTTPSConnection.putheader
)
AWSHTTPSConnection.endheaders = _get_wrapped_endheaders( # type: ignore[method-assign]
AWSHTTPSConnection.endheaders
)
AWSHTTPSConnection.putrequest = _get_wrapped_putrequest( # type: ignore[method-assign]
AWSHTTPSConnection.putrequest
)
def _install_httplib() -> None:
real_putrequest = HTTPConnection.putrequest
real_getresponse = HTTPConnection.getresponse
real_read = HTTPResponse.read
real_close = HTTPResponse.close
def putrequest(
self: "HTTPConnection", method: str, url: str, *args: "Any", **kwargs: "Any"
) -> "Any":
default_port = self.default_port
# proxies go through set_tunnel
tunnel_host = getattr(self, "_tunnel_host", None)
if tunnel_host:
host = tunnel_host
port = getattr(self, "_tunnel_port", default_port)
else:
host = self.host
port = self.port
client = sentry_sdk.get_client()
if client.get_integration(StdlibIntegration) is None or is_sentry_url(
client, host
):
return real_putrequest(self, method, url, *args, **kwargs)
real_url = url
if real_url is None or not real_url.startswith(("http://", "https://")):
real_url = "%s://%s%s%s" % (
default_port == 443 and "https" or "http",
host,
port != default_port and ":%s" % port or "",
url,
)
parsed_url = None
with capture_internal_exceptions():
parsed_url = parse_url(real_url, sanitize=False)
span_streaming = has_span_streaming_enabled(client.options)
span: "Union[Span, StreamedSpan, None]" = None
breadcrumb: "dict[str, Any]" = {}
if span_streaming:
url_attributes = get_url_attributes(client, parsed_url)
breadcrumb[SPANDATA.HTTP_REQUEST_METHOD] = method
breadcrumb.update(url_attributes)
parent_span = sentry_sdk.traces.get_current_span()
if parent_span is not None:
is_inactive_boto3_span = (
client.get_integration("boto3") is not None
and parent_span.get_attributes().get(SPANDATA.SENTRY_ORIGIN)
== getattr(client.get_integration("boto3"), "origin", None)
and not getattr(parent_span, "active", True)
)
# fmt: off
span = sentry_sdk.traces.start_span(
name="%s %s"
% (
method,
parsed_url.url if parsed_url else SENSITIVE_DATA_SUBSTITUTE,
),
attributes={
"sentry.origin": "auto.http.stdlib.httplib",
"sentry.op": OP.HTTP_CLIENT,
SPANDATA.HTTP_REQUEST_METHOD: method,
},
# boto3 integration owns span's lifecycle; keep child inactive so it
# can't restore boto3 span later on.
active = not is_inactive_boto3_span,
)
# fmt: on
for key, value in url_attributes.items():
span.set_attribute(key, value)
set_on_span = span.set_attribute
else:
span = sentry_sdk.start_span(
op=OP.HTTP_CLIENT,
name="%s %s"
% (method, parsed_url.url if parsed_url else SENSITIVE_DATA_SUBSTITUTE),
origin="auto.http.stdlib.httplib",
)
span.set_data(SPANDATA.HTTP_METHOD, method)
breadcrumb[SPANDATA.HTTP_METHOD] = method
if parsed_url is not None:
span.set_data(SPANDATA.HTTP_FRAGMENT, parsed_url.fragment)
span.set_data("url", parsed_url.url)
span.set_data(SPANDATA.HTTP_QUERY, parsed_url.query)
breadcrumb.update(
{
SPANDATA.HTTP_FRAGMENT: parsed_url.fragment,
"url": parsed_url.url,
SPANDATA.HTTP_QUERY: parsed_url.query,
}
)
set_on_span = span.set_data
# for proxies, these point to the proxy host/port
if tunnel_host:
if span:
set_on_span(SPANDATA.NETWORK_PEER_ADDRESS, self.host)
set_on_span(SPANDATA.NETWORK_PEER_PORT, self.port)
breadcrumb.update(
{
SPANDATA.NETWORK_PEER_ADDRESS: self.host,
SPANDATA.NETWORK_PEER_PORT: self.port,
}
)
rv = real_putrequest(self, method, url, *args, **kwargs)
# if `_sentrysdk_headers_to_skip` is set, inject headers in `endheaders()`
# after botocore has supplied the final headers.
if should_propagate_trace(client, real_url) and not hasattr(
self, "_sentrysdk_headers_to_skip"
):
for (
key,
value,
) in sentry_sdk.get_current_scope().iter_trace_propagation_headers(
span=span
):
logger.debug(
"[Tracing] Adding `{key}` header {value} to outgoing request to {real_url}.".format(
key=key, value=value, real_url=real_url
)
)
self.putheader(key, value)
elif should_propagate_trace(client, real_url):
self._sentrysdk_real_url = real_url # type: ignore[attr-defined]
self._sentrysdk_span = span # type: ignore[attr-defined]
self._sentrysdk_breadcrumb = breadcrumb # type: ignore[attr-defined]
return rv
def getresponse(self: "HTTPConnection", *args: "Any", **kwargs: "Any") -> "Any":
span = getattr(self, "_sentrysdk_span", None)
breadcrumb = getattr(self, "_sentrysdk_breadcrumb", None)
try:
rv = real_getresponse(self, *args, **kwargs)
except BaseException as ex:
if span:
_complete_span(span)
if (
breadcrumb
and "getresponse() got an unexpected keyword argument 'buffering'"
not in str(ex)
):
# the exception msg check is needed for Python 3.6/requests compat
add_http_breadcrumb(None, breadcrumb)
raise
status_code = int(rv.status)
if breadcrumb:
breadcrumb[SPANDATA.HTTP_STATUS_CODE] = status_code
if span is None:
if breadcrumb:
add_http_breadcrumb(status_code, breadcrumb)
return rv
if isinstance(span, StreamedSpan):
span.status = "error" if status_code >= 400 else "ok"
span.set_attribute(SPANDATA.HTTP_STATUS_CODE, status_code)
elif isinstance(span, Span):
span.set_http_status(status_code)
span.set_data("reason", rv.reason)
if breadcrumb:
breadcrumb["reason"] = rv.reason
# getresponse doesn't include actually reading the response body. This
# is done in read(). So if the metadata/headers suggest there's a body to
# read, don't finish the span just yet, but save it for ending it later.
has_body = rv.chunked or (rv.length is not None and rv.length > 0)
if has_body:
rv._sentrysdk_span = span # type: ignore[attr-defined]
else:
_complete_span(span)
if breadcrumb:
# Regardless of whether the response itself has been fully read or not,
# the breadcrumb can now be emitted since we now have the status code.
add_http_breadcrumb(status_code, breadcrumb)
return rv
def read(self: "HTTPResponse", *args: "Any", **kwargs: "Any") -> "Any":
try:
return real_read(self, *args, **kwargs)
finally:
span = getattr(self, "_sentrysdk_span", None)
# read() might be called multiple times to consume a single body,
# so we can't just end the span when read() is done. Instead,
# try to figure out whether the response body has been fully read.
if span and (self.fp is None or self.closed):
self._sentrysdk_span = None # type: ignore[attr-defined]
_complete_span(span)
def close(self: "HTTPResponse") -> None:
# We patch close() as a best effort fallback in case the span is not
# ended yet in getresponse() or read().
try:
real_close(self)
finally:
span = getattr(self, "_sentrysdk_span", None)
if span is not None:
self._sentrysdk_span = None # type: ignore[attr-defined]
_complete_span(span)
_patch_aws_connection()
HTTPConnection.putrequest = putrequest # type: ignore[method-assign]
HTTPConnection.getresponse = getresponse # type: ignore[method-assign]
HTTPResponse.read = read # type: ignore[method-assign]
HTTPResponse.close = close # type: ignore[assignment,method-assign]
def _init_argument(
args: "List[Any]",
kwargs: "Dict[Any, Any]",
name: str,
position: int,
setdefault_callback: "Optional[Callable[[Any], Any]]" = None,
) -> "Any":
"""
given (*args, **kwargs) of a function call, retrieve (and optionally set a
default for) an argument by either name or position.
This is useful for wrapping functions with complex type signatures and
extracting a few arguments without needing to redefine that function's
entire type signature.
"""
if name in kwargs:
rv = kwargs[name]
if setdefault_callback is not None:
rv = setdefault_callback(rv)
if rv is not None:
kwargs[name] = rv
elif position < len(args):
rv = args[position]
if setdefault_callback is not None:
rv = setdefault_callback(rv)
if rv is not None:
args[position] = rv
else:
rv = setdefault_callback and setdefault_callback(None)
if rv is not None:
kwargs[name] = rv
return rv
def _install_subprocess() -> None:
old_popen_init = subprocess.Popen.__init__
@ensure_integration_enabled(StdlibIntegration, old_popen_init)
def sentry_patched_popen_init(
self: "subprocess.Popen[Any]", *a: "Any", **kw: "Any"
) -> None:
# Convert from tuple to list to be able to set values.
a = list(a)
args = _init_argument(a, kw, "args", 0) or []
cwd = _init_argument(a, kw, "cwd", 9)
# if args is not a list or tuple (and e.g. some iterator instead),
# let's not use it at all. There are too many things that can go wrong
# when trying to collect an iterator into a list and setting that list
# into `a` again.
#
# Also invocations where `args` is not a sequence are not actually
# legal. They just happen to work under CPython.
description = None
if isinstance(args, (list, tuple)) and len(args) < 100:
with capture_internal_exceptions():
description = " ".join(map(str, args))
if description is None:
description = safe_repr(args)
env = None
sentry_sdk.add_breadcrumb(
type="subprocess",
category="subprocess",
message=description,
data={"subprocess.cwd": cwd} if cwd else {},
)
span_streaming = has_span_streaming_enabled(sentry_sdk.get_client().options)
span: "Union[Span, StreamedSpan]"
if span_streaming:
if sentry_sdk.traces.get_current_span() is None:
return old_popen_init(self, *a, **kw)
span = sentry_sdk.traces.start_span(
name=description,
attributes={
"sentry.op": OP.SUBPROCESS,
"sentry.origin": "auto.subprocess.stdlib.subprocess",
},
)
else:
span = sentry_sdk.start_span(
op=OP.SUBPROCESS,
name=description,
origin="auto.subprocess.stdlib.subprocess",
)
with span:
for k, v in sentry_sdk.get_current_scope().iter_trace_propagation_headers(
span=span
):
if env is None:
env = _init_argument(
a,
kw,
"env",
10,
lambda x: dict(x if x is not None else os.environ),
)
env["SUBPROCESS_" + k.upper().replace("-", "_")] = v
if cwd and isinstance(span, Span):
span.set_data("subprocess.cwd", cwd)
rv = old_popen_init(self, *a, **kw)
if isinstance(span, StreamedSpan):
span.set_attribute(SPANDATA.PROCESS_PID, self.pid)
else:
span.set_tag("subprocess.pid", self.pid)
return rv
subprocess.Popen.__init__ = sentry_patched_popen_init # type: ignore
old_popen_wait = subprocess.Popen.wait
@ensure_integration_enabled(StdlibIntegration, old_popen_wait)
def sentry_patched_popen_wait(
self: "subprocess.Popen[Any]", *a: "Any", **kw: "Any"
) -> "Any":
span_streaming = has_span_streaming_enabled(sentry_sdk.get_client().options)
if span_streaming:
if sentry_sdk.traces.get_current_span() is None:
return old_popen_wait(self, *a, **kw)
with sentry_sdk.traces.start_span(
name=OP.SUBPROCESS_WAIT,
attributes={
"sentry.op": OP.SUBPROCESS_WAIT,
"sentry.origin": "auto.subprocess.stdlib.subprocess",
},
) as span:
span.set_attribute(SPANDATA.PROCESS_PID, self.pid)
return old_popen_wait(self, *a, **kw)
else:
with sentry_sdk.start_span(
op=OP.SUBPROCESS_WAIT,
origin="auto.subprocess.stdlib.subprocess",
) as span:
span.set_tag("subprocess.pid", self.pid)
return old_popen_wait(self, *a, **kw)
subprocess.Popen.wait = sentry_patched_popen_wait # type: ignore
old_popen_communicate = subprocess.Popen.communicate
@ensure_integration_enabled(StdlibIntegration, old_popen_communicate)
def sentry_patched_popen_communicate(
self: "subprocess.Popen[Any]", *a: "Any", **kw: "Any"
) -> "Any":
span_streaming = has_span_streaming_enabled(sentry_sdk.get_client().options)
if span_streaming:
if sentry_sdk.traces.get_current_span() is None:
return old_popen_communicate(self, *a, **kw)
with sentry_sdk.traces.start_span(
name=OP.SUBPROCESS_COMMUNICATE,
attributes={
"sentry.op": OP.SUBPROCESS_COMMUNICATE,
"sentry.origin": "auto.subprocess.stdlib.subprocess",
},
) as span:
span.set_attribute(SPANDATA.PROCESS_PID, self.pid)
return old_popen_communicate(self, *a, **kw)
else:
with sentry_sdk.start_span(
op=OP.SUBPROCESS_COMMUNICATE,
origin="auto.subprocess.stdlib.subprocess",
) as span:
span.set_tag("subprocess.pid", self.pid)
return old_popen_communicate(self, *a, **kw)
subprocess.Popen.communicate = sentry_patched_popen_communicate # type: ignore
def get_subprocess_traceparent_headers() -> "EnvironHeaders":
return EnvironHeaders(os.environ, prefix="SUBPROCESS_")