apitally 0.18.0__py3-none-any.whl → 0.18.2__py3-none-any.whl

apitally/client/request_logging.py

@@ -97,8 +97,8 @@ class RequestLoggingConfig:
         log_exception: Whether to log unhandled exceptions in case of server errors
         mask_query_params: Query parameter names to mask in logs. Expects regular expressions.
         mask_headers: Header names to mask in logs. Expects regular expressions.
-        mask_request_body_callback: Callback to mask the request body. Expects (method, path, body) and returns the masked body as bytes or None.
-        mask_response_body_callback: Callback to mask the response body. Expects (method, path, body) and returns the masked body as bytes or None.
+        mask_request_body_callback: Callback to mask the request body. Expects `request: RequestDict` as argument and returns the masked body as bytes or None.
+        mask_response_body_callback: Callback to mask the response body. Expects `request: RequestDict` and `response: ResponseDict` as arguments and returns the masked body as bytes or None.
         exclude_paths: Paths to exclude from logging. Expects regular expressions.
         exclude_callback: Callback to exclude requests from logging. Should expect two arguments, `request: RequestDict` and `response: ResponseDict`, and return True to exclude the request.
     """

apitally/django.py

@@ -123,115 +123,114 @@ class ApitallyMiddleware:
         )
 
     def __call__(self, request: HttpRequest) -> HttpResponse:
-        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""
-            if self.capture_request_body:
-                request_body = (
-                    request.body
-                    if request_size is not None and request_size <= MAX_BODY_SIZE and len(request.body) <= MAX_BODY_SIZE
-                    else BODY_TOO_LARGE
-                )
+        if not self.client.enabled or request.method is None or request.method == "OPTIONS":
+            return self.get_response(request)
+
+        timestamp = time.time()
+        request_size = parse_int(request.headers.get("Content-Length"))
+        request_body = b""
+        if self.capture_request_body:
+            request_body = (
+                request.body
+                if request_size is not None and request_size <= MAX_BODY_SIZE and len(request.body) <= MAX_BODY_SIZE
+                else BODY_TOO_LARGE
+            )
 
-            start_time = time.perf_counter()
-            response = self.get_response(request)
-            response_time = time.perf_counter() - start_time
-            path = self.get_path(request)
-
-            if path is not None:
-                try:
-                    consumer = self.get_consumer(request)
-                    consumer_identifier = consumer.identifier if consumer else None
-                    self.client.consumer_registry.add_or_update_consumer(consumer)
-                except Exception:  # pragma: no cover
-                    logger.exception("Failed to get consumer for request")
-                    consumer_identifier = None
-
-                response_size = (
-                    parse_int(response["Content-Length"])
-                    if response.has_header("Content-Length")
-                    else (len(response.content) if not response.streaming else None)
-                )
-                response_body = b""
-                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
-                    )
+        start_time = time.perf_counter()
+        response = self.get_response(request)
+        response_time = time.perf_counter() - start_time
+        path = self.get_path(request)
+
+        if path is None:
+            return response
+
+        try:
+            consumer = self.get_consumer(request)
+            consumer_identifier = consumer.identifier if consumer else None
+            self.client.consumer_registry.add_or_update_consumer(consumer)
+        except Exception:  # pragma: no cover
+            logger.exception("Failed to get consumer for request")
+            consumer_identifier = None
+
+        response_size = (
+            parse_int(response["Content-Length"])
+            if response.has_header("Content-Length")
+            else (len(response.content) if not response.streaming else None)
+        )
+        response_body = b""
+        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
+            )
 
-                try:
-                    self.client.request_counter.add_request(
+        try:
+            self.client.request_counter.add_request(
+                consumer=consumer_identifier,
+                method=request.method,
+                path=path,
+                status_code=response.status_code,
+                response_time=response_time,
+                request_size=request_size,
+                response_size=response_size,
+            )
+        except Exception:  # pragma: no cover
+            logger.exception("Failed to log request metadata")
+
+        if (
+            response.status_code == 422
+            and (content_type := response.get("Content-Type")) is not None
+            and content_type.startswith("application/json")
+        ):
+            try:
+                body = try_json_loads(response.content, encoding=response.get("Content-Encoding"))
+                if isinstance(body, dict) and "detail" in body and isinstance(body["detail"], list):
+                    # Log Django Ninja / Pydantic validation errors
+                    self.client.validation_error_counter.add_validation_errors(
                         consumer=consumer_identifier,
                         method=request.method,
                         path=path,
-                        status_code=response.status_code,
-                        response_time=response_time,
-                        request_size=request_size,
-                        response_size=response_size,
+                        detail=body["detail"],
                     )
-                except Exception:  # pragma: no cover
-                    logger.exception("Failed to log request metadata")
-
-                if (
-                    response.status_code == 422
-                    and (content_type := response.get("Content-Type")) is not None
-                    and content_type.startswith("application/json")
-                ):
-                    try:
-                        body = try_json_loads(response.content, encoding=response.get("Content-Encoding"))
-                        if isinstance(body, dict) and "detail" in body and isinstance(body["detail"], list):
-                            # Log Django Ninja / Pydantic validation errors
-                            self.client.validation_error_counter.add_validation_errors(
-                                consumer=consumer_identifier,
-                                method=request.method,
-                                path=path,
-                                detail=body["detail"],
-                            )
-                    except Exception:  # pragma: no cover
-                        logger.exception("Failed to log validation errors")
-
-                if response.status_code == 500 and hasattr(request, "unhandled_exception"):
-                    try:
-                        self.client.server_error_counter.add_server_error(
-                            consumer=consumer_identifier,
-                            method=request.method,
-                            path=path,
-                            exception=getattr(request, "unhandled_exception"),
-                        )
-                    except Exception:  # pragma: no cover
-                        logger.exception("Failed to log server error")
-
-                if self.client.request_logger.enabled:
-                    self.client.request_logger.log_request(
-                        request={
-                            "timestamp": timestamp,
-                            "method": request.method,
-                            "path": path,
-                            "url": request.build_absolute_uri(),
-                            "headers": list(request.headers.items()),
-                            "size": request_size,
-                            "consumer": consumer_identifier,
-                            "body": request_body,
-                        },
-                        response={
-                            "status_code": response.status_code,
-                            "response_time": response_time,
-                            "headers": list(response.items()),
-                            "size": response_size,
-                            "body": response_body,
-                        },
-                        exception=getattr(request, "unhandled_exception", None),
-                    )
-        else:
-            response = self.get_response(request)
+            except Exception:  # pragma: no cover
+                logger.exception("Failed to log validation errors")
+
+        if response.status_code == 500 and hasattr(request, "unhandled_exception"):
+            try:
+                self.client.server_error_counter.add_server_error(
+                    consumer=consumer_identifier,
+                    method=request.method,
+                    path=path,
+                    exception=getattr(request, "unhandled_exception"),
+                )
+            except Exception:  # pragma: no cover
+                logger.exception("Failed to log server error")
+
+        if self.client.request_logger.enabled:
+            self.client.request_logger.log_request(
+                request={
+                    "timestamp": timestamp,
+                    "method": request.method,
+                    "path": path,
+                    "url": request.build_absolute_uri(),
+                    "headers": list(request.headers.items()),
+                    "size": request_size,
+                    "consumer": consumer_identifier,
+                    "body": request_body,
+                },
+                response={
+                    "status_code": response.status_code,
+                    "response_time": response_time,
+                    "headers": list(response.items()),
+                    "size": response_size,
+                    "body": response_body,
+                },
+                exception=getattr(request, "unhandled_exception", None),
+            )
 
         return response
 

apitally/starlette.py

@@ -91,6 +91,7 @@ class ApitallyMiddleware:
 
             async def receive_wrapper() -> Message:
                 nonlocal request_body, request_body_too_large
+
                 message = await receive()
                 if message["type"] == "http.request" and self.capture_request_body and not request_body_too_large:
                     request_body += message.get("body", b"")
@@ -109,6 +110,7 @@ class ApitallyMiddleware:
                     response_chunked, \
                     response_content_type, \
                     response_size
+
                 if message["type"] == "http.response.start":
                     response_time = time.perf_counter() - start_time
                     response_status = message["status"]
@@ -120,9 +122,11 @@ class ApitallyMiddleware:
                     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 RequestLogger.is_supported_content_type(response_content_type)
@@ -132,6 +136,11 @@ class ApitallyMiddleware:
                         if len(response_body) > MAX_BODY_SIZE:
                             response_body_too_large = True
                             response_body = b""
+
+                if self.capture_client_disconnects and await request.is_disconnected():
+                    # Client closed connection (report NGINX specific status code)
+                    response_status = 499
+
                 await send(message)
 
             try:
@@ -142,9 +151,6 @@ class ApitallyMiddleware:
             finally:
                 if response_time is None:
                     response_time = time.perf_counter() - start_time
-                if self.capture_client_disconnects and await request.is_disconnected():
-                    # Client closed connection (report NGINX specific status code)
-                    response_status = 499
                 self.add_request(
                     timestamp=timestamp,
                     request=request,

{apitally-0.18.0.dist-info → apitally-0.18.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: apitally
-Version: 0.18.0
+Version: 0.18.2
 Summary: Simple API monitoring & analytics for REST APIs built with FastAPI, Flask, Django, Starlette, Litestar and BlackSheep.
 Project-URL: Homepage, https://apitally.io
 Project-URL: Documentation, https://docs.apitally.io
@@ -67,21 +67,17 @@ Description-Content-Type: text/markdown
 <p align="center">
   <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">
+      <source media="(prefers-color-scheme: dark)" srcset="https://assets.apitally.io/logos/logo-horizontal-new-dark.png">
+      <source media="(prefers-color-scheme: light)" srcset="https://assets.apitally.io/logos/logo-horizontal-new-light.png">
+      <img alt="Apitally logo" src="https://assets.apitally.io/logos/logo-horizontal-new-light.png" width="220">
     </picture>
   </a>
 </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>Just add two lines of code to your project to get started.</i></p>
+<p align="center" style="color: #ccc;">Apitally gives you the visibility you need to build better APIs – with just a few lines of code.</p>
+<br>
+<img alt="Apitally screenshots" src="https://assets.apitally.io/screenshots/overview.png">
 <br>
-
-![Apitally screenshots](https://assets.apitally.io/screenshots/overview.png)
-
----
 
 # Apitally SDK for Python
 
@@ -138,7 +134,7 @@ pip install apitally[fastapi]
 ```
 
 The available extras are: `fastapi`, `flask`, `django_rest_framework`,
-`django_ninja`, `starlette` and `litestar`.
+`django_ninja`, `starlette`, `litestar` and `blacksheep`.
 
 ## Usage
 

{apitally-0.18.0.dist-info → apitally-0.18.2.dist-info}/RECORD

@@ -1,26 +1,26 @@
 apitally/__init__.py,sha256=ShXQBVjyiSOHxoQJS2BvNG395W4KZfqMxZWBAR0MZrE,22
 apitally/blacksheep.py,sha256=KvcPFeiwQgWZmRglbm8SLaN6_WRs5kZ3SymB1IuLR-A,9616
 apitally/common.py,sha256=azDxepViH0QW0MuufTHxeSQyLGzCkocAX_KPziWTx8A,1605
-apitally/django.py,sha256=MnyL6ntMYj1WndjLqpDZ-8BrbDWCeVV2dpZbe8Fnm-Y,19254
+apitally/django.py,sha256=7eSh1tzuu0wRl9PxJgXMBSz9DfyohCDIqd4ecQTOJ1M,18499
 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=OoCEnjtnD51GUGq-adK80ebuiLj-5HXubxffCv5XTCM,9622
 apitally/litestar.py,sha256=mHoMqBO_gyoopeHljY8e8GTcV29UDf3uhQMxY3GeNpA,13451
 apitally/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-apitally/starlette.py,sha256=IJymf3Gvhnls5B8LEGAcVyDS7x_hba93PfxSCuSKhFI,13872
+apitally/starlette.py,sha256=Ep7n_yAqoleFpuLk43kMONiFJVRsFsu-G2_TIjfiCHQ,13878
 apitally/client/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 apitally/client/client_asyncio.py,sha256=rTsH5wlLHK3RmyIuEiT6vzjquU-l2OPC34JnC2U6uYw,6658
 apitally/client/client_base.py,sha256=DvivGeHd3dyOASRvkIo44Zh8RzdBMfH8_rROa2lFbgw,3799
 apitally/client/client_threading.py,sha256=sxMRcxRgk1SxJjSq-qpIcDVmD3Q7Kv4CVT5zEUVt0KM,7257
 apitally/client/consumers.py,sha256=w_AFQhVgdtJVt7pVySBvSZwQg-2JVqmD2JQtVBoMkus,2626
 apitally/client/logging.py,sha256=QMsKIIAFo92PNBUleeTgsrsQa7SEal-oJa1oOHUr1wI,507
-apitally/client/request_logging.py,sha256=SMvQd3WDolnb8u9rHVh2_OgXwFjL2jLZt-GpZNQ1XGk,14115
+apitally/client/request_logging.py,sha256=FIJfbc4fYZnBIKebpJtrk19DcAxJylltghY7RFitWsE,14173
 apitally/client/requests.py,sha256=SDptGOg9XvaEKFj2o3oxJz-JAuZzUrqpHnbOQixf99o,3794
 apitally/client/sentry.py,sha256=qMjHdI0V7c50ruo1WjmjWc8g6oGDv724vSCvcuZ8G9k,1188
 apitally/client/server_errors.py,sha256=4B2BKDFoIpoWc55UVH6AIdYSgzj6zxCdMNUW77JjhZw,3423
 apitally/client/validation_errors.py,sha256=6G8WYWFgJs9VH9swvkPXJGuOJgymj5ooWA9OwjUTbuM,1964
-apitally-0.18.0.dist-info/METADATA,sha256=P_79lUjux4JjQZXrAU4LMPsZq00_KyLTc8sZEoONXqg,9271
-apitally-0.18.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-apitally-0.18.0.dist-info/licenses/LICENSE,sha256=vbLzC-4TddtXX-_AFEBKMYWRlxC_MN0g66QhPxo8PgY,1065
-apitally-0.18.0.dist-info/RECORD,,
+apitally-0.18.2.dist-info/METADATA,sha256=J2Mr1Y-82i7_Batr5bwlTCEhMzcnirozN83VNZgIJ4U,9269
+apitally-0.18.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+apitally-0.18.2.dist-info/licenses/LICENSE,sha256=vbLzC-4TddtXX-_AFEBKMYWRlxC_MN0g66QhPxo8PgY,1065
+apitally-0.18.2.dist-info/RECORD,,