216 lines
7.7 KiB
Python
216 lines
7.7 KiB
Python
from typing import TYPE_CHECKING
|
|
|
|
import sentry_sdk
|
|
from sentry_sdk.consts import OP, SPANDATA
|
|
from sentry_sdk.integrations import DidNotEnable, Integration
|
|
from sentry_sdk.scope import should_send_default_pii
|
|
from sentry_sdk.tracing_utils import (
|
|
add_http_request_source,
|
|
has_span_streaming_enabled,
|
|
propagate_trace_headers,
|
|
)
|
|
from sentry_sdk.utils import (
|
|
SENSITIVE_DATA_SUBSTITUTE,
|
|
capture_internal_exceptions,
|
|
ensure_integration_enabled,
|
|
parse_url,
|
|
)
|
|
|
|
if TYPE_CHECKING:
|
|
from typing import Any
|
|
|
|
from sentry_sdk._types import Attributes
|
|
|
|
|
|
try:
|
|
from httpx2 import AsyncClient, Client, Request, Response
|
|
except ImportError:
|
|
raise DidNotEnable("httpx2 is not installed")
|
|
|
|
__all__ = ["Httpx2Integration"]
|
|
|
|
|
|
class Httpx2Integration(Integration):
|
|
identifier = "httpx2"
|
|
origin = f"auto.http.{identifier}"
|
|
|
|
@staticmethod
|
|
def setup_once() -> None:
|
|
"""
|
|
httpx2 has its own transport layer and can be customized when needed,
|
|
so patch Client.send and AsyncClient.send to support both synchronous and async interfaces.
|
|
"""
|
|
_install_httpx2_client()
|
|
_install_httpx2_async_client()
|
|
|
|
|
|
def _install_httpx2_client() -> None:
|
|
real_send = Client.send
|
|
|
|
@ensure_integration_enabled(Httpx2Integration, real_send)
|
|
def send(self: "Client", request: "Request", **kwargs: "Any") -> "Response":
|
|
client = sentry_sdk.get_client()
|
|
is_span_streaming_enabled = has_span_streaming_enabled(client.options)
|
|
|
|
parsed_url = None
|
|
with capture_internal_exceptions():
|
|
parsed_url = parse_url(str(request.url), sanitize=False)
|
|
|
|
if is_span_streaming_enabled:
|
|
if sentry_sdk.traces.get_current_span() is None:
|
|
propagate_trace_headers(client, request)
|
|
|
|
return real_send(self, request, **kwargs)
|
|
|
|
with sentry_sdk.traces.start_span(
|
|
name="%s %s"
|
|
% (
|
|
request.method,
|
|
parsed_url.url if parsed_url else SENSITIVE_DATA_SUBSTITUTE,
|
|
),
|
|
attributes={
|
|
"sentry.op": OP.HTTP_CLIENT,
|
|
"sentry.origin": Httpx2Integration.origin,
|
|
"http.request.method": request.method,
|
|
},
|
|
) as streamed_span:
|
|
attributes: "Attributes" = {}
|
|
|
|
if parsed_url is not None and should_send_default_pii():
|
|
attributes["url.full"] = parsed_url.url
|
|
if parsed_url.query:
|
|
attributes["url.query"] = parsed_url.query
|
|
if parsed_url.fragment:
|
|
attributes["url.fragment"] = parsed_url.fragment
|
|
|
|
propagate_trace_headers(client, request)
|
|
|
|
try:
|
|
rv = real_send(self, request, **kwargs)
|
|
|
|
streamed_span.status = "error" if rv.status_code >= 400 else "ok"
|
|
attributes["http.response.status_code"] = rv.status_code
|
|
finally:
|
|
streamed_span.set_attributes(attributes)
|
|
|
|
# Needs to happen within the context manager as we want to attach the
|
|
# final data before the span finishes and is sent for ingesting.
|
|
with capture_internal_exceptions():
|
|
add_http_request_source(streamed_span)
|
|
else:
|
|
with sentry_sdk.start_span(
|
|
op=OP.HTTP_CLIENT,
|
|
name="%s %s"
|
|
% (
|
|
request.method,
|
|
parsed_url.url if parsed_url else SENSITIVE_DATA_SUBSTITUTE,
|
|
),
|
|
origin=Httpx2Integration.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)
|
|
|
|
propagate_trace_headers(client, request)
|
|
|
|
rv = real_send(self, request, **kwargs)
|
|
|
|
span.set_http_status(rv.status_code)
|
|
span.set_data("reason", rv.reason_phrase)
|
|
|
|
with capture_internal_exceptions():
|
|
add_http_request_source(span)
|
|
|
|
return rv
|
|
|
|
Client.send = send # type: ignore
|
|
|
|
|
|
def _install_httpx2_async_client() -> None:
|
|
real_send = AsyncClient.send
|
|
|
|
async def send(
|
|
self: "AsyncClient", request: "Request", **kwargs: "Any"
|
|
) -> "Response":
|
|
client = sentry_sdk.get_client()
|
|
if client.get_integration(Httpx2Integration) is None:
|
|
return await real_send(self, request, **kwargs)
|
|
|
|
is_span_streaming_enabled = has_span_streaming_enabled(client.options)
|
|
parsed_url = None
|
|
with capture_internal_exceptions():
|
|
parsed_url = parse_url(str(request.url), sanitize=False)
|
|
|
|
if is_span_streaming_enabled:
|
|
if sentry_sdk.traces.get_current_span() is None:
|
|
propagate_trace_headers(client, request)
|
|
|
|
return await real_send(self, request, **kwargs)
|
|
|
|
with sentry_sdk.traces.start_span(
|
|
name="%s %s"
|
|
% (
|
|
request.method,
|
|
parsed_url.url if parsed_url else SENSITIVE_DATA_SUBSTITUTE,
|
|
),
|
|
attributes={
|
|
"sentry.op": OP.HTTP_CLIENT,
|
|
"sentry.origin": Httpx2Integration.origin,
|
|
"http.request.method": request.method,
|
|
},
|
|
) as streamed_span:
|
|
attributes: "Attributes" = {}
|
|
|
|
if parsed_url is not None and should_send_default_pii():
|
|
attributes["url.full"] = parsed_url.url
|
|
if parsed_url.query:
|
|
attributes["url.query"] = parsed_url.query
|
|
if parsed_url.fragment:
|
|
attributes["url.fragment"] = parsed_url.fragment
|
|
|
|
propagate_trace_headers(client, request)
|
|
|
|
try:
|
|
rv = await real_send(self, request, **kwargs)
|
|
|
|
streamed_span.status = "error" if rv.status_code >= 400 else "ok"
|
|
attributes["http.response.status_code"] = rv.status_code
|
|
finally:
|
|
streamed_span.set_attributes(attributes)
|
|
|
|
# Needs to happen within the context manager as we want to attach the
|
|
# final data before the span finishes and is sent for ingesting.
|
|
with capture_internal_exceptions():
|
|
add_http_request_source(streamed_span)
|
|
else:
|
|
with sentry_sdk.start_span(
|
|
op=OP.HTTP_CLIENT,
|
|
name="%s %s"
|
|
% (
|
|
request.method,
|
|
parsed_url.url if parsed_url else SENSITIVE_DATA_SUBSTITUTE,
|
|
),
|
|
origin=Httpx2Integration.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)
|
|
|
|
propagate_trace_headers(client, request)
|
|
|
|
rv = await real_send(self, request, **kwargs)
|
|
|
|
span.set_http_status(rv.status_code)
|
|
span.set_data("reason", rv.reason_phrase)
|
|
|
|
with capture_internal_exceptions():
|
|
add_http_request_source(span)
|
|
|
|
return rv
|
|
|
|
AsyncClient.send = send # type: ignore
|