Merge pull request #13 from tolstoy92/feat/failed-status-codes-in-sentry-init

feat(sentry): failed_request_status_codes

Author: redb0

README.md

@@ -240,7 +240,9 @@ in the `app_slug@version` format.
 Another Sentry configuration option is to use
 `fastapi_structlog.sentry.setup_sentry`. However, in this case,
 you must explicitly pass an instance of the settings
-`fastapi_structlog.sentry.SentrySettings` and the `release` parameter.
+`fastapi_structlog.sentry.SentrySettings` and the `release` parameter. In addition,
+you can pass the `failed_request_status_codes` (status codes should be reported to Sentry)
+and `service_integration` (additional Sentry integrations) parameters.
 
 The Sentry configuration parameters are as follows:
 

docs_src/example_3.py

@@ -51,7 +51,11 @@ def error() -> str:
 
 def main() -> None:
     setup_logger(settings.log)
-    setup_sentry(settings.sentry, release='example_api@1.0')
+    setup_sentry(
+        settings.sentry,
+        release='example_api@1.0',
+        failed_request_status_codes=[range(400, 405), 422, range(500, 599)],
+    )
 
     uvicorn.run(
         app,

fastapi_structlog/sentry/initialization.py

@@ -1,6 +1,6 @@
 """Sentry configuration module."""
 import logging
-from typing import Optional
+from typing import Optional, Union
 
 import sentry_sdk
 from sentry_sdk.integrations import Integration
@@ -19,6 +19,7 @@ def setup_sentry(
     app_slug: Optional[str] = None,
     version: Optional[str] = None,
     service_integration: Optional[Integration] = None,
+    failed_request_status_codes: Optional[list[Union[int, range]]] = None,
 ) -> None:
     """Configuration of Sentry settings.
 
@@ -29,6 +30,10 @@ def setup_sentry(
         version (Optional[str]): Version. Defaults to None.
         service_integration (Optional[Integration]): Integration for inter-service
             interaction. Defaults to None.
+        failed_request_status_codes (Optional[list[Union[int, range]]]): A list of integers or
+            containers (objects that allow membership checks via in) of integers that will determine
+            which status codes should be reported to Sentry.
+            See https://docs.sentry.io/platforms/python/integrations/starlette/
     """
     release = release or f'{app_slug}@{version}'
 
@@ -39,9 +44,16 @@ def setup_sentry(
         )
         return
 
+    failed_request_status_codes = failed_request_status_codes or [range(500, 599)]
     integrations: list[Integration] = [
-        StarletteIntegration(transaction_style='url'),
-        FastApiIntegration(transaction_style='url'),
+        StarletteIntegration(
+            transaction_style='url',
+            failed_request_status_codes=failed_request_status_codes,
+        ),
+        FastApiIntegration(
+            transaction_style='url',
+            failed_request_status_codes=failed_request_status_codes,
+        ),
     ]
     if settings_.log_integration:
         integrations.append(LoggingIntegration(