feat(integration): Add Httpx Integration (#1119)

* feat(integration): Add Httpx Integration

Co-authored-by: Ahmed Etefy <[email protected]>

Author: elonzh

sentry_sdk/integrations/httpx.py

@@ -0,0 +1,83 @@
+from sentry_sdk import Hub
+from sentry_sdk.integrations import Integration, DidNotEnable
+
+from sentry_sdk._types import MYPY
+
+if MYPY:
+    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"
+
+    @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
+
+    def send(self, request, **kwargs):
+        # type: (Client, Request, **Any) -> Response
+        hub = Hub.current
+        if hub.get_integration(HttpxIntegration) is None:
+            return real_send(self, request, **kwargs)
+
+        with hub.start_span(
+            op="http", description="%s %s" % (request.method, request.url)
+        ) as span:
+            span.set_data("method", request.method)
+            span.set_data("url", str(request.url))
+            for key, value in hub.iter_trace_propagation_headers():
+                request.headers[key] = value
+            rv = real_send(self, request, **kwargs)
+
+            span.set_data("status_code", rv.status_code)
+            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
+        hub = Hub.current
+        if hub.get_integration(HttpxIntegration) is None:
+            return await real_send(self, request, **kwargs)
+
+        with hub.start_span(
+            op="http", description="%s %s" % (request.method, request.url)
+        ) as span:
+            span.set_data("method", request.method)
+            span.set_data("url", str(request.url))
+            for key, value in hub.iter_trace_propagation_headers():
+                request.headers[key] = value
+            rv = await real_send(self, request, **kwargs)
+
+            span.set_data("status_code", rv.status_code)
+            span.set_http_status(rv.status_code)
+            span.set_data("reason", rv.reason_phrase)
+            return rv
+
+    AsyncClient.send = send

setup.py

@@ -53,6 +53,7 @@ def get_file_text(file_name):
         "pyspark": ["pyspark>=2.4.4"],
         "pure_eval": ["pure_eval", "executing", "asttokens"],
         "chalice": ["chalice>=1.16.0"],
+        "httpx": ["httpx>=0.16.0"],
     },
     classifiers=[
         "Development Status :: 5 - Production/Stable",

tests/integrations/httpx/__init__.py

@@ -0,0 +1,3 @@
+import pytest
+
+pytest.importorskip("httpx")

tests/integrations/httpx/test_httpx.py

@@ -0,0 +1,66 @@
+import asyncio
+
+import httpx
+
+from sentry_sdk import capture_message, start_transaction
+from sentry_sdk.integrations.httpx import HttpxIntegration
+
+
+def test_crumb_capture_and_hint(sentry_init, capture_events):
+    def before_breadcrumb(crumb, hint):
+        crumb["data"]["extra"] = "foo"
+        return crumb
+
+    sentry_init(integrations=[HttpxIntegration()], before_breadcrumb=before_breadcrumb)
+    clients = (httpx.Client(), httpx.AsyncClient())
+    for i, c in enumerate(clients):
+        with start_transaction():
+            events = capture_events()
+
+            url = "https://httpbin.org/status/200"
+            if not asyncio.iscoroutinefunction(c.get):
+                response = c.get(url)
+            else:
+                response = asyncio.get_event_loop().run_until_complete(c.get(url))
+
+            assert response.status_code == 200
+            capture_message("Testing!")
+
+            (event,) = events
+            # send request twice so we need get breadcrumb by index
+            crumb = event["breadcrumbs"]["values"][i]
+            assert crumb["type"] == "http"
+            assert crumb["category"] == "httplib"
+            assert crumb["data"] == {
+                "url": url,
+                "method": "GET",
+                "status_code": 200,
+                "reason": "OK",
+                "extra": "foo",
+            }
+
+
+def test_outgoing_trace_headers(sentry_init):
+    sentry_init(traces_sample_rate=1.0, integrations=[HttpxIntegration()])
+    clients = (httpx.Client(), httpx.AsyncClient())
+    for i, c in enumerate(clients):
+        with start_transaction(
+            name="/interactions/other-dogs/new-dog",
+            op="greeting.sniff",
+            # make trace_id difference between transactions
+            trace_id=f"012345678901234567890123456789{i}",
+        ) as transaction:
+            url = "https://httpbin.org/status/200"
+            if not asyncio.iscoroutinefunction(c.get):
+                response = c.get(url)
+            else:
+                response = asyncio.get_event_loop().run_until_complete(c.get(url))
+
+            request_span = transaction._span_recorder.spans[-1]
+            assert response.request.headers[
+                "sentry-trace"
+            ] == "{trace_id}-{parent_span_id}-{sampled}".format(
+                trace_id=transaction.trace_id,
+                parent_span_id=request_span.span_id,
+                sampled=1,
+            )

tox.ini

@@ -83,6 +83,8 @@ envlist =
 
     {py2.7,py3.6,py3.7,py3.8}-boto3-{1.9,1.10,1.11,1.12,1.13,1.14,1.15,1.16}
 
+    {py3.6,py3.7,py3.8,py3.9}-httpx-{0.16,0.17}
+
 [testenv]
 deps =
     # if you change test-requirements.txt and your change is not being reflected
@@ -235,6 +237,9 @@ deps =
     boto3-1.15: boto3>=1.15,<1.16
     boto3-1.16: boto3>=1.16,<1.17
 
+    httpx-0.16: httpx>=0.16,<0.17
+    httpx-0.17: httpx>=0.17,<0.18
+
 setenv =
     PYTHONDONTWRITEBYTECODE=1
     TESTPATH=tests
@@ -260,6 +265,7 @@ setenv =
     pure_eval: TESTPATH=tests/integrations/pure_eval
     chalice: TESTPATH=tests/integrations/chalice
     boto3: TESTPATH=tests/integrations/boto3
+    httpx: TESTPATH=tests/integrations/httpx
 
     COVERAGE_FILE=.coverage-{envname}
 passenv =