apitally 0.14.4__py3-none-any.whl → 0.14.6__py3-none-any.whl

apitally/client/client_asyncio.py

@@ -81,6 +81,7 @@ class ApitallyClient(ApitallyClientBase):
         self._stop_sync_loop = True
 
     async def handle_shutdown(self) -> None:
+        self.enabled = False
         if self._sync_loop_task is not None:
             self._sync_loop_task.cancel()
         # Send any remaining data before exiting
@@ -164,6 +165,7 @@ class ApitallyClient(ApitallyClientBase):
 
     def _handle_hub_response(self, response: httpx.Response) -> None:
         if response.status_code == 404:
+            self.enabled = False
             self.stop_sync_loop()
             logger.error("Invalid Apitally client ID: %s", self.client_id)
         elif response.status_code == 422:

apitally/client/client_base.py

@@ -52,6 +52,7 @@ class ApitallyClientBase(ABC):
 
         self.client_id = client_id
         self.env = env
+        self.enabled = True
         self.instance_uuid = str(uuid4())
         self.request_counter = RequestCounter()
         self.validation_error_counter = ValidationErrorCounter()

apitally/client/client_threading.py

@@ -190,6 +190,7 @@ class ApitallyClient(ApitallyClientBase):
 
     def _handle_hub_response(self, response: requests.Response) -> None:
         if response.status_code == 404:
+            self.enabled = False
             self.stop_sync_loop()
             logger.error("Invalid Apitally client ID: %s", self.client_id)
         elif response.status_code == 422:

apitally/client/request_logging.py

@@ -5,7 +5,6 @@ import tempfile
 import threading
 import time
 from collections import deque
-from contextlib import suppress
 from dataclasses import dataclass, field
 from functools import lru_cache
 from io import BufferedReader
@@ -29,14 +28,14 @@ MASKED = "******"
 ALLOWED_CONTENT_TYPES = ["application/json", "text/plain"]
 EXCLUDE_PATH_PATTERNS = [
     r"/_?healthz?$",
-    r"/_?health[_-]?checks?$",
-    r"/_?heart[_-]?beats?$",
+    r"/_?health[\-_]?checks?$",
+    r"/_?heart[\-_]?beats?$",
     r"/ping$",
     r"/ready$",
     r"/live$",
 ]
 EXCLUDE_USER_AGENT_PATTERNS = [
-    r"health[_- ]?check",
+    r"health[\-_ ]?check",
     r"microsoft-azure-application-lb",
     r"googlehc",
     r"kube-probe",
@@ -178,8 +177,6 @@ class RequestLogger:
 
         query = self._mask_query_params(parsed_url.query) if self.config.log_query_params else ""
         request["url"] = urlunparse(parsed_url._replace(query=query))
-        request["headers"] = self._mask_headers(request["headers"]) if self.config.log_request_headers else []
-        response["headers"] = self._mask_headers(response["headers"]) if self.config.log_response_headers else []
 
         if not self.config.log_request_body or not self._has_supported_content_type(request["headers"]):
             request["body"] = None
@@ -215,6 +212,9 @@ class RequestLogger:
         if response["body"] is not None and len(response["body"]) > MAX_BODY_SIZE:
             response["body"] = BODY_TOO_LARGE
 
+        request["headers"] = self._mask_headers(request["headers"]) if self.config.log_request_headers else []
+        response["headers"] = self._mask_headers(response["headers"]) if self.config.log_response_headers else []
+
         item = {
             "uuid": str(uuid4()),
             "request": _skip_empty_values(request),
@@ -307,19 +307,22 @@ class RequestLogger:
     @staticmethod
     def _match_patterns(value: str, patterns: List[str]) -> bool:
         for pattern in patterns:
-            with suppress(re.error):
-                if re.search(pattern, value, re.I) is not None:
-                    return True
+            if re.search(pattern, value, re.I) is not None:
+                return True
         return False
 
+    @staticmethod
+    def _get_user_agent(headers: List[Tuple[str, str]]) -> Optional[str]:
+        return next((v for k, v in headers if k.lower() == "user-agent"), None)
+
     @staticmethod
     def _has_supported_content_type(headers: List[Tuple[str, str]]) -> bool:
         content_type = next((v for k, v in headers if k.lower() == "content-type"), None)
-        return content_type is not None and any(content_type.startswith(t) for t in ALLOWED_CONTENT_TYPES)
+        return RequestLogger.is_supported_content_type(content_type)
 
     @staticmethod
-    def _get_user_agent(headers: List[Tuple[str, str]]) -> Optional[str]:
-        return next((v for k, v in headers if k.lower() == "user-agent"), None)
+    def is_supported_content_type(content_type: Optional[str]) -> bool:
+        return content_type is not None and any(content_type.startswith(t) for t in ALLOWED_CONTENT_TYPES)
 
 
 def _check_writable_fs() -> bool:

apitally/django.py

@@ -19,6 +19,7 @@ from apitally.client.logging import get_logger
 from apitally.client.request_logging import (
     BODY_TOO_LARGE,
     MAX_BODY_SIZE,
+    RequestLogger,
     RequestLoggingConfig,
 )
 from apitally.common import get_versions, parse_int
@@ -113,7 +114,7 @@ class ApitallyMiddleware:
         )
 
     def __call__(self, request: HttpRequest) -> HttpResponse:
-        if request.method is not None and request.method != "OPTIONS":
+        if self.client.enabled and request.method is not None and request.method != "OPTIONS":
             timestamp = time.time()
             request_size = parse_int(request.headers.get("Content-Length"))
             request_body = b""
@@ -133,7 +134,12 @@ class ApitallyMiddleware:
                 else (len(response.content) if not response.streaming else None)
             )
             response_body = b""
-            if self.capture_response_body and not response.streaming:
+            response_content_type = response.get("Content-Type")
+            if (
+                self.capture_response_body
+                and not response.streaming
+                and RequestLogger.is_supported_content_type(response_content_type)
+            ):
                 response_body = (
                     response.content if response_size is not None and response_size <= MAX_BODY_SIZE else BODY_TOO_LARGE
                 )

apitally/flask.py

@@ -17,6 +17,7 @@ from apitally.client.consumers import Consumer as ApitallyConsumer
 from apitally.client.request_logging import (
     BODY_TOO_LARGE,
     MAX_BODY_SIZE,
+    RequestLogger,
     RequestLoggingConfig,
 )
 from apitally.common import get_versions
@@ -74,6 +75,9 @@ class ApitallyMiddleware:
         self.client.set_startup_data(data)
 
     def __call__(self, environ: WSGIEnvironment, start_response: StartResponse) -> Iterable[bytes]:
+        if not self.client.enabled:
+            return self.wsgi_app(environ, start_response)
+
         timestamp = time.time()
         response_headers = Headers([])
         status_code = 0
@@ -100,7 +104,8 @@ class ApitallyMiddleware:
             response_time = time.perf_counter() - start_time
 
             response_body = b""
-            if self.capture_response_body:
+            response_content_type = response_headers.get("Content-Type")
+            if self.capture_response_body and RequestLogger.is_supported_content_type(response_content_type):
                 response_size = response_headers.get("Content-Length", type=int)
                 if response_size is not None and response_size > MAX_BODY_SIZE:
                     response_body = BODY_TOO_LARGE

apitally/litestar.py

@@ -19,6 +19,7 @@ from apitally.client.consumers import Consumer as ApitallyConsumer
 from apitally.client.request_logging import (
     BODY_TOO_LARGE,
     MAX_BODY_SIZE,
+    RequestLogger,
     RequestLoggingConfig,
 )
 from apitally.common import get_versions, parse_int
@@ -86,7 +87,7 @@ class ApitallyPlugin(InitPluginProtocol):
 
     def middleware_factory(self, app: ASGIApp) -> ASGIApp:
         async def middleware(scope: Scope, receive: Receive, send: Send) -> None:
-            if scope["type"] == "http" and scope["method"] != "OPTIONS":
+            if self.client.enabled and scope["type"] == "http" and scope["method"] != "OPTIONS":
                 timestamp = time.time()
                 request = Request(scope)
                 request_size = parse_int(request.headers.get("Content-Length"))
@@ -99,6 +100,7 @@ class ApitallyPlugin(InitPluginProtocol):
                 response_body_too_large = False
                 response_size: Optional[int] = None
                 response_chunked = False
+                response_content_type: Optional[str] = None
                 start_time = time.perf_counter()
 
                 async def receive_wrapper() -> Message:
@@ -119,6 +121,7 @@ class ApitallyPlugin(InitPluginProtocol):
                         response_body, \
                         response_body_too_large, \
                         response_chunked, \
+                        response_content_type, \
                         response_size
                     if message["type"] == "http.response.start":
                         response_time = time.perf_counter() - start_time
@@ -128,12 +131,17 @@ class ApitallyPlugin(InitPluginProtocol):
                             response_headers.get("Transfer-Encoding") == "chunked"
                             or "Content-Length" not in response_headers
                         )
+                        response_content_type = response_headers.get("Content-Type")
                         response_size = parse_int(response_headers.get("Content-Length")) if not response_chunked else 0
                         response_body_too_large = response_size is not None and response_size > MAX_BODY_SIZE
                     elif message["type"] == "http.response.body":
                         if response_chunked and response_size is not None:
                             response_size += len(message.get("body", b""))
-                        if (self.capture_response_body or response_status == 400) and not response_body_too_large:
+                        if (
+                            (self.capture_response_body or response_status == 400)
+                            and RequestLogger.is_supported_content_type(response_content_type)
+                            and not response_body_too_large
+                        ):
                             response_body += message.get("body", b"")
                             if len(response_body) > MAX_BODY_SIZE:
                                 response_body_too_large = True

apitally/starlette.py

@@ -20,6 +20,7 @@ from apitally.client.consumers import Consumer as ApitallyConsumer
 from apitally.client.request_logging import (
     BODY_TOO_LARGE,
     MAX_BODY_SIZE,
+    RequestLogger,
     RequestLoggingConfig,
 )
 from apitally.common import get_versions, parse_int
@@ -73,7 +74,7 @@ class ApitallyMiddleware:
         self.client.set_startup_data(data)
 
     async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None:
-        if scope["type"] == "http" and scope["method"] != "OPTIONS":
+        if self.client.enabled and scope["type"] == "http" and scope["method"] != "OPTIONS":
             timestamp = time.time()
             request = Request(scope)
             request_size = parse_int(request.headers.get("Content-Length"))
@@ -86,6 +87,7 @@ class ApitallyMiddleware:
             response_body_too_large = False
             response_size: Optional[int] = None
             response_chunked = False
+            response_content_type: Optional[str] = None
             exception: Optional[BaseException] = None
             start_time = time.perf_counter()
 
@@ -107,6 +109,7 @@ class ApitallyMiddleware:
                     response_body, \
                     response_body_too_large, \
                     response_chunked, \
+                    response_content_type, \
                     response_size
                 if message["type"] == "http.response.start":
                     response_time = time.perf_counter() - start_time
@@ -116,12 +119,17 @@ class ApitallyMiddleware:
                         response_headers.get("Transfer-Encoding") == "chunked"
                         or "Content-Length" not in response_headers
                     )
+                    response_content_type = response_headers.get("Content-Type")
                     response_size = parse_int(response_headers.get("Content-Length")) if not response_chunked else 0
                     response_body_too_large = response_size is not None and response_size > MAX_BODY_SIZE
                 elif message["type"] == "http.response.body":
                     if response_chunked and response_size is not None:
                         response_size += len(message.get("body", b""))
-                    if (self.capture_response_body or response_status == 422) and not response_body_too_large:
+                    if (
+                        (self.capture_response_body or response_status == 422)
+                        and RequestLogger.is_supported_content_type(response_content_type)
+                        and not response_body_too_large
+                    ):
                         response_body += message.get("body", b"")
                         if len(response_body) > MAX_BODY_SIZE:
                             response_body_too_large = True

{apitally-0.14.4.dist-info → apitally-0.14.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: apitally
-Version: 0.14.4
+Version: 0.14.6
 Summary: Simple API monitoring & analytics for REST APIs built with FastAPI, Flask, Django, Starlette and Litestar.
 Project-URL: Homepage, https://apitally.io
 Project-URL: Documentation, https://docs.apitally.io
@@ -62,18 +62,19 @@ Requires-Dist: starlette<1.0.0,>=0.21.0; extra == 'starlette'
 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" width="150">
-  </picture>
+  <a href="https://apitally.io" target="_blank">
+    <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" width="150">
+    </picture>
+  </a>
 </p>
 
-<p align="center"><b>Analytics, logging & monitoring for REST APIs.</b></p>
+<p align="center"><b>Simple, privacy-focused API monitoring & analytics</b></p>
 
-<p align="center"><i>Apitally helps you understand how your APIs are being used and alerts you when things go wrong.<br>It's super easy to use and designed to protect your data privacy.</i></p>
-
-<p align="center">🔗 <b><a href="https://apitally.io" target="_blank">apitally.io</a></b></p>
+<p align="center"><i>Apitally helps you understand how your APIs are being used and alerts you when things go wrong.<br>Just add two lines of code to your project to get started.</i></p>
+<br>
 
 ![Apitally screenshots](https://assets.apitally.io/screenshots/overview.png)
 
@@ -89,10 +90,10 @@ This client library for Apitally currently supports the following Python web
 frameworks:
 
 - [FastAPI](https://docs.apitally.io/frameworks/fastapi)
-- [Starlette](https://docs.apitally.io/frameworks/starlette)
-- [Flask](https://docs.apitally.io/frameworks/flask)
-- [Django Ninja](https://docs.apitally.io/frameworks/django-ninja)
 - [Django REST Framework](https://docs.apitally.io/frameworks/django-rest-framework)
+- [Django Ninja](https://docs.apitally.io/frameworks/django-ninja)
+- [Flask](https://docs.apitally.io/frameworks/flask)
+- [Starlette](https://docs.apitally.io/frameworks/starlette)
 - [Litestar](https://docs.apitally.io/frameworks/litestar)
 
 Learn more about Apitally on our 🌎 [website](https://apitally.io) or check out
@@ -100,10 +101,21 @@ the 📚 [documentation](https://docs.apitally.io).
 
 ## Key features
 
-- Middleware for different frameworks to capture metadata about API endpoints,
-  requests and responses
-- Non-blocking clients that aggregate and send captured data to Apitally in
-  regular intervals
+### API analytics
+
+Track traffic, error and performance metrics for your API, each endpoint and individual API consumers, allowing you to make informed, data-driven engineering and product decisions.
+
+### Error tracking
+
+Understand which validation rules in your endpoints cause client errors. Capture error details and stack traces for 500 error responses, and have them linked to Sentry issues automatically.
+
+### Request logging
+
+Drill down from insights to individual requests or use powerful filtering to understand how consumers have interacted with your API. Configure exactly what is included in the logs to meet your requirements.
+
+### API monitoring & alerting
+
+Get notified immediately if something isn't right using custom alerts, synthetic uptime checks and heartbeat monitoring. Notifications can be delivered via email, Slack or Microsoft Teams.
 
 ## Install
 
@@ -140,6 +152,25 @@ app.add_middleware(
 )
 ```
 
+### Django
+
+This is an example of how to add the Apitally middleware to a Django Ninja or
+Django REST Framework application. For further instructions, see our
+[setup guide for Django](https://docs.apitally.io/frameworks/django).
+
+In your Django `settings.py` file:
+
+```python
+MIDDLEWARE = [
+    "apitally.django.ApitallyMiddleware",
+    # Other middleware ...
+]
+APITALLY_MIDDLEWARE = {
+    "client_id": "your-client-id",
+    "env": "dev",  # or "prod" etc.
+}
+```
+
 ### Flask
 
 This is an example of how to add the Apitally middleware to a Flask application.
@@ -158,23 +189,22 @@ app.wsgi_app = ApitallyMiddleware(
 )
 ```
 
-### Django
-
-This is an example of how to add the Apitally middleware to a Django Ninja or
-Django REST Framework application. For further instructions, see our
-[setup guide for Django](https://docs.apitally.io/frameworks/django).
+### Starlette
 
-In your Django `settings.py` file:
+This is an example of how to add the Apitally middleware to a Starlette application.
+For further instructions, see our
+[setup guide for Starlette](https://docs.apitally.io/frameworks/starlette).
 
 ```python
-MIDDLEWARE = [
-    "apitally.django.ApitallyMiddleware",
-    # Other middleware ...
-]
-APITALLY_MIDDLEWARE = {
-    "client_id": "your-client-id",
-    "env": "dev",  # or "prod" etc.
-}
+from starlette.applications import Starlette
+from apitally.starlette import ApitallyMiddleware
+
+app = Starlette(routes=[...])
+app.add_middleware(
+    ApitallyMiddleware,
+    client_id="your-client-id",
+    env="dev",  # or "prod" etc.
+)
 ```
 
 ### Litestar

{apitally-0.14.4.dist-info → apitally-0.14.6.dist-info}/RECORD

@@ -1,24 +1,24 @@
 apitally/__init__.py,sha256=ShXQBVjyiSOHxoQJS2BvNG395W4KZfqMxZWBAR0MZrE,22
 apitally/common.py,sha256=Y8MRuTUHFUeQkcDrCLUxnqIPRpYIiW8S43T0QUab-_A,1267
-apitally/django.py,sha256=xM8zyH8LYr4BxAlhvfpUyau4OF5i_TMcISs3eJ7xvpY,16621
+apitally/django.py,sha256=Tsw3uSM6EcfoCKpJuqliMFbc6eX0sVzJR9UyZck613M,16860
 apitally/django_ninja.py,sha256=-CmrwFFRv7thFOUK_OrOSouhHL9bm5sIBNIQlpyE_2c,166
 apitally/django_rest_framework.py,sha256=-CmrwFFRv7thFOUK_OrOSouhHL9bm5sIBNIQlpyE_2c,166
 apitally/fastapi.py,sha256=IfKfgsmIY8_AtnuMTW2sW4qnkya61CAE2vBoIpcc9tk,169
-apitally/flask.py,sha256=Th5LsMsTKkWERPrKfSWPhzrp99tg0pDtKXgtlVLx3eo,9279
-apitally/litestar.py,sha256=hAH2-OVVXBDVY8LopfIGv30yYwi-71tSEsKd6648CYc,13098
+apitally/flask.py,sha256=kOFkAZj62Zr-l5eJWRr8lmsMHfFW_kfi1kflH6mZseQ,9533
+apitally/litestar.py,sha256=qV89DXFlG619-20294OLg52vGv4C4GxIm9IPoyY21L4,13514
 apitally/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-apitally/starlette.py,sha256=VaT4-QVSYC0YX1U5kVI-dGROEd64IbjYU5lx5N16yf8,12852
+apitally/starlette.py,sha256=cMUUcQSqZ_meoxjyi8doZGarwP8RwNjFaFDmjoWvVK4,13240
 apitally/client/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-apitally/client/client_asyncio.py,sha256=2RibaadLAEdl2i0yAb4dSEDq_r46w6HPFpZVzvt59aQ,6941
-apitally/client/client_base.py,sha256=dXsaB7scd0wCd_DcdiUvNlDLZ2pWbWsGDnJ4fLYvJGg,3771
-apitally/client/client_threading.py,sha256=Y8LlA_8LFHAuXym-T4bY_XFqXxiIDw9qFqO6K3FbZy0,7356
+apitally/client/client_asyncio.py,sha256=9mdi9Hmb6-xn7dNdwP84e4PNAHGg2bYdMEgIfPUAtcQ,7003
+apitally/client/client_base.py,sha256=DvivGeHd3dyOASRvkIo44Zh8RzdBMfH8_rROa2lFbgw,3799
+apitally/client/client_threading.py,sha256=7JPu2Uulev7X2RiSLx4HJYfvAP6Z5zB_yuSevMfQC7I,7389
 apitally/client/consumers.py,sha256=w_AFQhVgdtJVt7pVySBvSZwQg-2JVqmD2JQtVBoMkus,2626
 apitally/client/logging.py,sha256=QMsKIIAFo92PNBUleeTgsrsQa7SEal-oJa1oOHUr1wI,507
-apitally/client/request_logging.py,sha256=5i7Gv4yP7iq4tBgw-ppkhlZd_OwMc719ZvWEm16TCvg,13047
+apitally/client/request_logging.py,sha256=tVTMbTGtdf8OVULrnRPKNZxLuYqiMvO1NviRIfSNKnw,13134
 apitally/client/requests.py,sha256=RdJyvIqQGVHvS-wjpAPUwcO7byOJ6jO8dYqNTU2Furg,3685
 apitally/client/server_errors.py,sha256=axEhOxqV5SWjk0QCZTLVv2UMIaTfqPc81Typ4DXt66A,4646
 apitally/client/validation_errors.py,sha256=6G8WYWFgJs9VH9swvkPXJGuOJgymj5ooWA9OwjUTbuM,1964
-apitally-0.14.4.dist-info/METADATA,sha256=bE7HFJBsn6IamIlJvehQhTd46k3Lx67imr2Yi7eM_PA,7570
-apitally-0.14.4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-apitally-0.14.4.dist-info/licenses/LICENSE,sha256=vbLzC-4TddtXX-_AFEBKMYWRlxC_MN0g66QhPxo8PgY,1065
-apitally-0.14.4.dist-info/RECORD,,
+apitally-0.14.6.dist-info/METADATA,sha256=veFQGVno3OtfK3J6RLBTyfLxqUzNXR0YtJVpcBhWz4I,8665
+apitally-0.14.6.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+apitally-0.14.6.dist-info/licenses/LICENSE,sha256=vbLzC-4TddtXX-_AFEBKMYWRlxC_MN0g66QhPxo8PgY,1065
+apitally-0.14.6.dist-info/RECORD,,