| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167 |
- import sentry_sdk
- from sentry_sdk.consts import OP, SPANDATA
- from sentry_sdk.integrations import Integration, DidNotEnable
- from sentry_sdk.tracing import BAGGAGE_HEADER_NAME
- from sentry_sdk.tracing_utils import Baggage, should_propagate_trace
- from sentry_sdk.utils import (
- SENSITIVE_DATA_SUBSTITUTE,
- capture_internal_exceptions,
- ensure_integration_enabled,
- logger,
- parse_url,
- )
- from typing import TYPE_CHECKING
- if TYPE_CHECKING:
- from collections.abc import MutableMapping
- from typing import Any
- try:
- from httpx import AsyncClient, Client, Request, Response # type: ignore
- except ImportError:
- raise DidNotEnable("httpx is not installed")
- __all__ = ["HttpxIntegration"]
- class HttpxIntegration(Integration):
- identifier = "httpx"
- origin = f"auto.http.{identifier}"
- @staticmethod
- def setup_once():
- # type: () -> None
- """
- httpx 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_httpx_client()
- _install_httpx_async_client()
- def _install_httpx_client():
- # type: () -> None
- real_send = Client.send
- @ensure_integration_enabled(HttpxIntegration, real_send)
- def send(self, request, **kwargs):
- # type: (Client, Request, **Any) -> Response
- parsed_url = None
- with capture_internal_exceptions():
- parsed_url = parse_url(str(request.url), sanitize=False)
- 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=HttpxIntegration.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
- rv = real_send(self, request, **kwargs)
- span.set_http_status(rv.status_code)
- span.set_data("reason", rv.reason_phrase)
- return rv
- Client.send = send
- def _install_httpx_async_client():
- # type: () -> None
- real_send = AsyncClient.send
- async def send(self, request, **kwargs):
- # type: (AsyncClient, Request, **Any) -> Response
- if sentry_sdk.get_client().get_integration(HttpxIntegration) is None:
- return await real_send(self, request, **kwargs)
- parsed_url = None
- with capture_internal_exceptions():
- parsed_url = parse_url(str(request.url), sanitize=False)
- 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=HttpxIntegration.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 and request.headers.get(
- BAGGAGE_HEADER_NAME
- ):
- # do not overwrite any existing baggage, just append to it
- request.headers[key] += "," + value
- else:
- request.headers[key] = value
- rv = await real_send(self, request, **kwargs)
- span.set_http_status(rv.status_code)
- span.set_data("reason", rv.reason_phrase)
- return rv
- AsyncClient.send = send
- def _add_sentry_baggage_to_headers(headers, sentry_baggage):
- # type: (MutableMapping[str, str], str) -> None
- """Add the Sentry baggage to the headers.
- This function directly mutates the provided headers. The provided sentry_baggage
- is appended to the existing baggage. If the baggage already contains Sentry items,
- they are stripped out first.
- """
- existing_baggage = headers.get(BAGGAGE_HEADER_NAME, "")
- stripped_existing_baggage = Baggage.strip_sentry_baggage(existing_baggage)
- separator = "," if len(stripped_existing_baggage) > 0 else ""
- headers[BAGGAGE_HEADER_NAME] = (
- stripped_existing_baggage + separator + sentry_baggage
- )
|