apitally 0.8.0__py3-none-any.whl → 0.10.0__py3-none-any.whl

apitally/__init__.py

@@ -1 +1 @@
-__version__ = "0.8.0"
+__version__ = "0.10.0"

apitally/client/base.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import asyncio
 import contextlib
 import os
 import re
@@ -243,6 +244,7 @@ class ServerError:
 class ServerErrorCounter:
     def __init__(self) -> None:
         self.error_counts: Counter[ServerError] = Counter()
+        self.sentry_event_ids: Dict[ServerError, str] = {}
         self._lock = threading.Lock()
 
     def add_server_error(self, consumer: Optional[str], method: str, path: str, exception: BaseException) -> None:
@@ -259,6 +261,36 @@ class ServerErrorCounter:
                 traceback=self._get_truncated_exception_traceback(exception),
             )
             self.error_counts[server_error] += 1
+            self.capture_sentry_event_id(server_error)
+
+    def capture_sentry_event_id(self, server_error: ServerError) -> None:
+        try:
+            from sentry_sdk.hub import Hub
+            from sentry_sdk.scope import Scope
+        except ImportError:
+            return  # pragma: no cover
+        if not hasattr(Scope, "get_isolation_scope") or not hasattr(Scope, "last_event_id"):
+            # sentry-sdk < 2.2.0 is not supported
+            return  # pragma: no cover
+        if Hub.current.client is None:
+            return  # sentry-sdk not initialized
+
+        scope = Scope.get_isolation_scope()
+        if event_id := scope.last_event_id():
+            self.sentry_event_ids[server_error] = event_id
+            return
+
+        async def _wait_for_sentry_event_id(scope: Scope) -> None:
+            i = 0
+            while not (event_id := scope.last_event_id()) and i < 100:
+                i += 1
+                await asyncio.sleep(0.001)
+            if event_id:
+                self.sentry_event_ids[server_error] = event_id
+
+        with contextlib.suppress(RuntimeError):  # ignore no running loop
+            loop = asyncio.get_running_loop()
+            loop.create_task(_wait_for_sentry_event_id(scope))
 
     def get_and_reset_server_errors(self) -> List[Dict[str, Any]]:
         data: List[Dict[str, Any]] = []
@@ -272,10 +304,12 @@ class ServerErrorCounter:
                         "type": server_error.type,
                         "msg": server_error.msg,
                         "traceback": server_error.traceback,
+                        "sentry_event_id": self.sentry_event_ids.get(server_error),
                         "error_count": count,
                     }
                 )
             self.error_counts.clear()
+            self.sentry_event_ids.clear()
         return data
 
     @staticmethod

apitally/django.py

@@ -164,12 +164,14 @@ class ApitallyMiddleware:
 
     def get_consumer(self, request: HttpRequest) -> Optional[str]:
         try:
-            if hasattr(request, "consumer_identifier"):
+            if hasattr(request, "apitally_consumer"):
+                return str(request.apitally_consumer)
+            if hasattr(request, "consumer_identifier"):  # Keeping this for legacy support
                 return str(request.consumer_identifier)
             if self.config is not None and self.config.identify_consumer_callback is not None:
-                consumer_identifier = self.config.identify_consumer_callback(request)
-                if consumer_identifier is not None:
-                    return str(consumer_identifier)
+                consumer = self.config.identify_consumer_callback(request)
+                if consumer is not None:
+                    return str(consumer)
         except Exception:  # pragma: no cover
             logger.exception("Failed to get consumer identifier for request")
         return None

apitally/flask.py

@@ -115,7 +115,11 @@ class ApitallyMiddleware:
             return environ["PATH_INFO"], False
 
     def get_consumer(self) -> Optional[str]:
-        return str(g.consumer_identifier) if "consumer_identifier" in g else None
+        if "apitally_consumer" in g:
+            return str(g.apitally_consumer)
+        if "consumer_identifier" in g:  # Keeping this for legacy support
+            return str(g.consumer_identifier)
+        return None
 
 
 def _get_app_info(app: Flask, app_version: Optional[str] = None, openapi_url: Optional[str] = None) -> Dict[str, Any]:

apitally/litestar.py

@@ -168,12 +168,14 @@ class ApitallyPlugin(InitPluginProtocol):
         return False  # pragma: no cover
 
     def get_consumer(self, request: Request) -> Optional[str]:
-        if hasattr(request.state, "consumer_identifier"):
+        if hasattr(request.state, "apitally_consumer"):
+            return str(request.state.apitally_consumer)
+        if hasattr(request.state, "consumer_identifier"):  # Keeping this for legacy support
             return str(request.state.consumer_identifier)
         if self.identify_consumer_callback is not None:
-            consumer_identifier = self.identify_consumer_callback(request)
-            if consumer_identifier is not None:
-                return str(consumer_identifier)
+            consumer = self.identify_consumer_callback(request)
+            if consumer is not None:
+                return str(consumer)
         return None
 
 

apitally/starlette.py

@@ -142,12 +142,14 @@ class ApitallyMiddleware(BaseHTTPMiddleware):
         return request.url.path, False
 
     def get_consumer(self, request: Request) -> Optional[str]:
-        if hasattr(request.state, "consumer_identifier"):
+        if hasattr(request.state, "apitally_consumer"):
+            return str(request.state.apitally_consumer)
+        if hasattr(request.state, "consumer_identifier"):  # Keeping this for legacy support
             return str(request.state.consumer_identifier)
         if self.identify_consumer_callback is not None:
-            consumer_identifier = self.identify_consumer_callback(request)
-            if consumer_identifier is not None:
-                return str(consumer_identifier)
+            consumer = self.identify_consumer_callback(request)
+            if consumer is not None:
+                return str(consumer)
         return None
 
 

{apitally-0.8.0.dist-info → apitally-0.10.0.dist-info}/METADATA

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: apitally
-Version: 0.8.0
-Summary: API monitoring for REST APIs built with FastAPI, Flask, Django, Starlette and Litestar.
+Version: 0.10.0
+Summary: Simple API monitoring & analytics for REST APIs built with FastAPI, Flask, Django, Starlette and Litestar.
 Home-page: https://apitally.io
 License: MIT
 Author: Apitally
@@ -26,6 +26,7 @@ Provides-Extra: django-rest-framework
 Provides-Extra: fastapi
 Provides-Extra: flask
 Provides-Extra: litestar
+Provides-Extra: sentry
 Provides-Extra: starlette
 Requires-Dist: backoff (>=2.0.0)
 Requires-Dist: django (>=2.2) ; extra == "django-ninja" or extra == "django-rest-framework"
@@ -37,23 +38,24 @@ Requires-Dist: httpx (>=0.22.0) ; extra == "fastapi" or extra == "litestar" or e
 Requires-Dist: inflection (>=0.5.1) ; extra == "django-rest-framework"
 Requires-Dist: litestar (>=2.0.0) ; extra == "litestar"
 Requires-Dist: requests (>=2.26.0) ; extra == "django-ninja" or extra == "django-rest-framework" or extra == "flask"
+Requires-Dist: sentry-sdk (>=2.2.0) ; extra == "sentry"
 Requires-Dist: starlette (>=0.21.0,<1.0.0) ; extra == "fastapi" or extra == "starlette"
 Requires-Dist: uritemplate (>=3.0.0) ; extra == "django-rest-framework"
 Project-URL: Documentation, https://docs.apitally.io
-Project-URL: Repository, https://github.com/apitally/python-client
+Project-URL: Repository, https://github.com/apitally/apitally-py
 Description-Content-Type: text/markdown
 
 <p align="center">
   <picture>
     <source media="(prefers-color-scheme: dark)" srcset="https://assets.apitally.io/logos/logo-vertical-dark.png">
     <source media="(prefers-color-scheme: light)" srcset="https://assets.apitally.io/logos/logo-vertical-light.png">
-    <img alt="Apitally logo" src="https://assets.apitally.io/logos/logo-vertical-light.png">
+    <img alt="Apitally logo" src="https://assets.apitally.io/logos/logo-vertical-light.png" width="150">
   </picture>
 </p>
 
 <p align="center"><b>API monitoring made easy.</b></p>
 
-<p align="center"><i>Apitally is a simple and affordable API monitoring tool with a focus on data privacy.<br>It is super easy to use for API projects in Python or Node.js and never collects sensitive data.</i></p>
+<p align="center"><i>Apitally is a simple API monitoring & analytics tool with a focus on data privacy.<br>It is super easy to use for API projects in Python or Node.js and never collects sensitive data.</i></p>
 
 <p align="center">🔗 <b><a href="https://apitally.io" target="_blank">apitally.io</a></b></p>
 
@@ -63,8 +65,8 @@ Description-Content-Type: text/markdown
 
 # Apitally client library for Python
 
-[![Tests](https://github.com/apitally/python-client/actions/workflows/tests.yaml/badge.svg?event=push)](https://github.com/apitally/python-client/actions)
-[![Codecov](https://codecov.io/gh/apitally/python-client/graph/badge.svg?token=UNLYBY4Y3V)](https://codecov.io/gh/apitally/python-client)
+[![Tests](https://github.com/apitally/apitally-py/actions/workflows/tests.yaml/badge.svg?event=push)](https://github.com/apitally/apitally-py/actions)
+[![Codecov](https://codecov.io/gh/apitally/apitally-py/graph/badge.svg?token=UNLYBY4Y3V)](https://codecov.io/gh/apitally/apitally-py)
 [![PyPI](https://img.shields.io/pypi/v/apitally?logo=pypi&logoColor=white&color=%23006dad)](https://pypi.org/project/apitally/)
 
 This client library for Apitally currently supports the following Python web

apitally-0.10.0.dist-info/RECORD

@@ -0,0 +1,19 @@
+apitally/__init__.py,sha256=v4zmKjsKOPZbp6BrWoz7iK4ST0sdZdUh9bQSJmluZ5o,23
+apitally/client/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+apitally/client/asyncio.py,sha256=uR5JlH37G6gZvAJ7A1gYOGkjn3zjC-4I6avA1fncXHs,4433
+apitally/client/base.py,sha256=VWtHTkA6UT5aV37i_CXUvcfmYrabjHGBhzbDU6EeH1A,12785
+apitally/client/logging.py,sha256=QMsKIIAFo92PNBUleeTgsrsQa7SEal-oJa1oOHUr1wI,507
+apitally/client/threading.py,sha256=ihQzUStrSQFynpqXgFpseAXrHuc5Et1QvG-YHlzqDr8,4831
+apitally/common.py,sha256=GbVmnXxhRvV30d7CfCQ9r0AeXj14Mv9Jm_Yd1bRWP28,1088
+apitally/django.py,sha256=ZsCKTUq4V3nCwIcrO8_3mPQFuPRiriqRSxQ8IPMRoOQ,12922
+apitally/django_ninja.py,sha256=iMvZd7j04nbOLpJgYxs7tpbsyXlZuhmHjcswXMvyUlU,82
+apitally/django_rest_framework.py,sha256=iMvZd7j04nbOLpJgYxs7tpbsyXlZuhmHjcswXMvyUlU,82
+apitally/fastapi.py,sha256=Q3n2bVREKQ_V_2yCQ48ngPtr-NJxDskpT_l20xhSbpM,85
+apitally/flask.py,sha256=iD2mbFqrWoEFFmDNXUtR32OYwlHob4I3tJT90-kwcnw,5691
+apitally/litestar.py,sha256=fgpdIlOpXS7TYFM02GUXk78H8WuJgDWMePPsQf-Pw1I,8092
+apitally/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+apitally/starlette.py,sha256=e0PoLTrihHioLGDF1TThjlsiyYtusa6Or6GKCX7Y9NQ,7881
+apitally-0.10.0.dist-info/LICENSE,sha256=vbLzC-4TddtXX-_AFEBKMYWRlxC_MN0g66QhPxo8PgY,1065
+apitally-0.10.0.dist-info/METADATA,sha256=qS7p_ikNFk2H474nD7yI6KdZ5jPM3IuC7EQ5F9Nrbas,6834
+apitally-0.10.0.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
+apitally-0.10.0.dist-info/RECORD,,

apitally-0.8.0.dist-info/RECORD

@@ -1,19 +0,0 @@
-apitally/__init__.py,sha256=iPlYCcIzuzW7T2HKDkmYlMkRI51dBLfNRxPPiWrfw9U,22
-apitally/client/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-apitally/client/asyncio.py,sha256=uR5JlH37G6gZvAJ7A1gYOGkjn3zjC-4I6avA1fncXHs,4433
-apitally/client/base.py,sha256=-2Bw_zFq6de-mSQSYsTa0NSRoMcHwiZqpSCQnjjIZ2M,11351
-apitally/client/logging.py,sha256=QMsKIIAFo92PNBUleeTgsrsQa7SEal-oJa1oOHUr1wI,507
-apitally/client/threading.py,sha256=ihQzUStrSQFynpqXgFpseAXrHuc5Et1QvG-YHlzqDr8,4831
-apitally/common.py,sha256=GbVmnXxhRvV30d7CfCQ9r0AeXj14Mv9Jm_Yd1bRWP28,1088
-apitally/django.py,sha256=Ym590Tiz1Qnk-IgFcna8r-XkSgcln2riziSPZCwD9nw,12812
-apitally/django_ninja.py,sha256=iMvZd7j04nbOLpJgYxs7tpbsyXlZuhmHjcswXMvyUlU,82
-apitally/django_rest_framework.py,sha256=iMvZd7j04nbOLpJgYxs7tpbsyXlZuhmHjcswXMvyUlU,82
-apitally/fastapi.py,sha256=Q3n2bVREKQ_V_2yCQ48ngPtr-NJxDskpT_l20xhSbpM,85
-apitally/flask.py,sha256=Utn92aXXl_1f4bKvuf4iZDB4v1vVLpeW5p1tF57Kf-8,5552
-apitally/litestar.py,sha256=1-skfFDKjYa7y6mOdNvjR4YGtsQbNA0iGQP1jyre41Q,7978
-apitally/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-apitally/starlette.py,sha256=kyXgzw0L90GUOZCgjuwM3q0uOpPX-hD0TQb2Wgqbqb8,7767
-apitally-0.8.0.dist-info/LICENSE,sha256=vbLzC-4TddtXX-_AFEBKMYWRlxC_MN0g66QhPxo8PgY,1065
-apitally-0.8.0.dist-info/METADATA,sha256=jl6_hdLWMu-CStH70iJ-4-Lt94328tX_X33avx-PIqI,6736
-apitally-0.8.0.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
-apitally-0.8.0.dist-info/RECORD,,