Add breadcrumb

Author: codetheweb

seamapi/seam.py

@@ -103,6 +103,20 @@ def make_request(self, method: str, path: str, **kwargs):
         }
         response = requests.request(method, url, headers=headers, **kwargs)
 
+        if self.should_report_exceptions and response.status_code:
+            # Add breadcrumb
+            sentry_sdk.add_breadcrumb(
+                category="http",
+                level="info",
+                data={
+                    "method": method,
+                    "url": url,
+                    "status_code": response.status_code,
+                    "request_id": response.headers.get("seam-request-id", "unknown"),
+                },
+            )
+
+
         parsed_response = response.json()
 
         if response.status_code != 200:

tests/test_sentry_errors.py

@@ -8,7 +8,8 @@ def test_sends_error_to_sentry(seam: Seam, monkeypatch):
       method="GET",
       url=seam.api_url + "/devices/list",
       # Missing top-level `devices` key
-      json={"foo": []}
+      json={"foo": []},
+      headers={"seam-request-id": "1234"},
     )
     responses.add(rsp)
 
@@ -29,6 +30,8 @@ def test_sends_error_to_sentry(seam: Seam, monkeypatch):
     sentry_capture_exception_calls = []
     monkeypatch.setattr("sentry_sdk.capture_exception", lambda *a, **kw: sentry_capture_exception_calls.append((a, kw)))
 
+    sentry_add_breadcrumb_calls = []
+    monkeypatch.setattr("sentry_sdk.add_breadcrumb", lambda *a, **kw: sentry_add_breadcrumb_calls.append((a, kw)))
     try:
       client_with_sentry.devices.list()
       assert False
@@ -40,6 +43,10 @@ def test_sends_error_to_sentry(seam: Seam, monkeypatch):
     assert len(sentry_capture_exception_calls) == 1
     assert type(sentry_capture_exception_calls[0][0][0]) is KeyError
 
+    assert len(sentry_add_breadcrumb_calls) == 1
+    assert sentry_add_breadcrumb_calls[0][1]['category'] == "http"
+    assert sentry_add_breadcrumb_calls[0][1]["data"]["request_id"] == "1234"
+
 @responses.activate
 def test_skips_sentry_reporting(seam: Seam, monkeypatch):
     rsp = responses.Response(