forked from getsentry/sentry-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathpyreqwest.py
More file actions
196 lines (162 loc) · 6.82 KB
/
Copy pathpyreqwest.py
File metadata and controls
196 lines (162 loc) · 6.82 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
from contextlib import contextmanager
from typing import Any, Generator
import sentry_sdk
from sentry_sdk import start_span
from sentry_sdk.consts import OP, SPANDATA
from sentry_sdk.integrations import DidNotEnable, Integration
from sentry_sdk.traces import StreamedSpan
from sentry_sdk.tracing import BAGGAGE_HEADER_NAME
from sentry_sdk.tracing_utils import (
add_http_request_source,
add_sentry_baggage_to_headers,
has_span_streaming_enabled,
should_propagate_trace,
)
from sentry_sdk.utils import (
SENSITIVE_DATA_SUBSTITUTE,
capture_internal_exceptions,
logger,
parse_url,
)
try:
from pyreqwest.client import ( # type: ignore[import-not-found]
ClientBuilder,
SyncClientBuilder,
)
from pyreqwest.middleware import Next, SyncNext # type: ignore[import-not-found]
from pyreqwest.request import ( # type: ignore[import-not-found]
OneOffRequestBuilder,
Request,
SyncOneOffRequestBuilder,
)
from pyreqwest.response import ( # type: ignore[import-not-found]
Response,
SyncResponse,
)
except ImportError:
raise DidNotEnable("pyreqwest not installed or incompatible version installed")
class PyreqwestIntegration(Integration):
identifier = "pyreqwest"
origin = f"auto.http.{identifier}"
@staticmethod
def setup_once() -> None:
_patch_pyreqwest()
def _patch_pyreqwest() -> None:
# Patch Client Builders
_patch_builder_method(ClientBuilder, "build", sentry_async_middleware)
_patch_builder_method(SyncClientBuilder, "build", sentry_sync_middleware)
# Patch Request Builders
_patch_builder_method(OneOffRequestBuilder, "send", sentry_async_middleware)
_patch_builder_method(SyncOneOffRequestBuilder, "send", sentry_sync_middleware)
def _patch_builder_method(cls: type, method_name: str, middleware: "Any") -> None:
if not hasattr(cls, method_name):
return
original_method = getattr(cls, method_name)
def sentry_patched_method(self: "Any", *args: "Any", **kwargs: "Any") -> "Any":
if not getattr(self, "_sentry_instrumented", False):
integration = sentry_sdk.get_client().get_integration(PyreqwestIntegration)
if integration is not None:
self.with_middleware(middleware)
try:
self._sentry_instrumented = True
except (TypeError, AttributeError):
# In case the instance itself is immutable or doesn't allow extra attributes
pass
return original_method(self, *args, **kwargs)
setattr(cls, method_name, sentry_patched_method)
@contextmanager
def _sentry_pyreqwest_span(request: "Request") -> "Generator[Any, None, None]":
parsed_url = None
with capture_internal_exceptions():
parsed_url = parse_url(str(request.url), sanitize=False)
span_streaming = has_span_streaming_enabled(sentry_sdk.get_client().options)
if span_streaming:
with sentry_sdk.traces.start_span(
name=f"{request.method} {parsed_url.url if parsed_url else SENSITIVE_DATA_SUBSTITUTE}",
attributes={
"sentry.op": OP.HTTP_CLIENT,
"sentry.origin": PyreqwestIntegration.origin,
SPANDATA.HTTP_REQUEST_METHOD: request.method,
},
) as span:
if parsed_url is not None:
span.set_attribute(SPANDATA.URL_FULL, parsed_url.url)
span.set_attribute(SPANDATA.URL_QUERY, parsed_url.query)
span.set_attribute(SPANDATA.URL_FRAGMENT, parsed_url.fragment)
if should_propagate_trace(sentry_sdk.get_client(), str(request.url)):
for (
key,
value,
) in sentry_sdk.get_current_scope().iter_trace_propagation_headers():
logger.debug(
"[Tracing] Adding `{key}` header {value} to outgoing request to {url}.".format(
key=key, value=value, url=request.url
)
)
if key == BAGGAGE_HEADER_NAME:
add_sentry_baggage_to_headers(request.headers, value)
else:
request.headers[key] = value
yield span
with capture_internal_exceptions():
add_http_request_source(span)
return
with start_span(
op=OP.HTTP_CLIENT,
name=f"{request.method} {parsed_url.url if parsed_url else SENSITIVE_DATA_SUBSTITUTE}",
origin=PyreqwestIntegration.origin,
) as span:
span.set_data(SPANDATA.HTTP_METHOD, request.method)
if parsed_url is not None:
span.set_data("url", parsed_url.url)
span.set_data(SPANDATA.HTTP_QUERY, parsed_url.query)
span.set_data(SPANDATA.HTTP_FRAGMENT, parsed_url.fragment)
if should_propagate_trace(sentry_sdk.get_client(), str(request.url)):
for (
key,
value,
) in sentry_sdk.get_current_scope().iter_trace_propagation_headers():
logger.debug(
"[Tracing] Adding `{key}` header {value} to outgoing request to {url}.".format(
key=key, value=value, url=request.url
)
)
if key == BAGGAGE_HEADER_NAME:
add_sentry_baggage_to_headers(request.headers, value)
else:
request.headers[key] = value
yield span
with capture_internal_exceptions():
add_http_request_source(span)
async def sentry_async_middleware(
request: "Request", next_handler: "Next"
) -> "Response":
if sentry_sdk.get_client().get_integration(PyreqwestIntegration) is None:
return await next_handler.run(request)
with _sentry_pyreqwest_span(request) as span:
response = await next_handler.run(request)
if isinstance(span, StreamedSpan):
span.status = "error" if response.status >= 400 else "ok"
span.set_attribute(
SPANDATA.HTTP_STATUS_CODE,
response.status,
)
else:
span.set_http_status(response.status)
return response
def sentry_sync_middleware(
request: "Request", next_handler: "SyncNext"
) -> "SyncResponse":
if sentry_sdk.get_client().get_integration(PyreqwestIntegration) is None:
return next_handler.run(request)
with _sentry_pyreqwest_span(request) as span:
response = next_handler.run(request)
if isinstance(span, StreamedSpan):
span.status = "error" if response.status >= 400 else "ok"
span.set_attribute(
SPANDATA.HTTP_STATUS_CODE,
response.status,
)
else:
span.set_http_status(response.status)
return response