apitally 0.3.4__py3-none-any.whl → 0.4.1__py3-none-any.whl

apitally/__init__.py

@@ -1 +1 @@
-__version__ = "0.3.4"
+__version__ = "0.4.1"

apitally/client/asyncio.py

@@ -36,14 +36,12 @@ class ApitallyClient(ApitallyClientBase):
         client_id: str,
         env: str,
         sync_api_keys: bool = False,
-        sync_interval: float = 60,
         key_cache_class: Optional[Type[ApitallyKeyCacheBase]] = None,
     ) -> None:
         super().__init__(
             client_id=client_id,
             env=env,
             sync_api_keys=sync_api_keys,
-            sync_interval=sync_interval,
             key_cache_class=key_cache_class,
         )
         self._stop_sync_loop = False

apitally/client/base.py

@@ -23,6 +23,9 @@ HUB_BASE_URL = os.getenv("APITALLY_HUB_BASE_URL") or "https://hub.apitally.io"
 HUB_VERSION = "v1"
 REQUEST_TIMEOUT = 10
 MAX_QUEUE_TIME = 3600
+SYNC_INTERVAL = 60
+INITIAL_SYNC_INTERVAL = 10
+INITIAL_SYNC_INTERVAL_DURATION = 3600
 
 TApitallyClient = TypeVar("TApitallyClient", bound="ApitallyClientBase")
 
@@ -43,7 +46,6 @@ class ApitallyClientBase:
         client_id: str,
         env: str,
         sync_api_keys: bool = False,
-        sync_interval: float = 60,
         key_cache_class: Optional[Type[ApitallyKeyCacheBase]] = None,
     ) -> None:
         if hasattr(self, "client_id"):
@@ -58,10 +60,9 @@ class ApitallyClientBase:
         self.client_id = client_id
         self.env = env
         self.sync_api_keys = sync_api_keys
-        self.sync_interval = sync_interval
         self.instance_uuid = str(uuid4())
-        self.request_logger = RequestLogger()
-        self.validation_error_logger = ValidationErrorLogger()
+        self.request_counter = RequestCounter()
+        self.validation_error_counter = ValidationErrorCounter()
         self.key_registry = KeyRegistry()
         self.key_cache = key_cache_class(client_id=client_id, env=env) if key_cache_class is not None else None
 
@@ -82,6 +83,12 @@ class ApitallyClientBase:
             raise RuntimeError("Apitally client not initialized")  # pragma: no cover
         return cast(TApitallyClient, cls._instance)
 
+    @property
+    def sync_interval(self) -> float:
+        return (
+            SYNC_INTERVAL if time.time() - self._started_at > INITIAL_SYNC_INTERVAL_DURATION else INITIAL_SYNC_INTERVAL
+        )
+
     @property
     def hub_url(self) -> str:
         return f"{HUB_BASE_URL}/{HUB_VERSION}/{self.client_id}/{self.env}"
@@ -95,8 +102,8 @@ class ApitallyClientBase:
         return payload
 
     def get_requests_payload(self) -> Dict[str, Any]:
-        requests = self.request_logger.get_and_reset_requests()
-        validation_errors = self.validation_error_logger.get_and_reset_validation_errors()
+        requests = self.request_counter.get_and_reset_requests()
+        validation_errors = self.validation_error_counter.get_and_reset_validation_errors()
         api_key_usage = self.key_registry.get_and_reset_usage_counts() if self.sync_api_keys else {}
         return {
             "instance_uuid": self.instance_uuid,
@@ -142,14 +149,25 @@ class RequestInfo:
     status_code: int
 
 
-class RequestLogger:
+class RequestCounter:
     def __init__(self) -> None:
         self.request_counts: Counter[RequestInfo] = Counter()
+        self.request_size_sums: Counter[RequestInfo] = Counter()
+        self.response_size_sums: Counter[RequestInfo] = Counter()
         self.response_times: Dict[RequestInfo, Counter[int]] = {}
+        self.request_sizes: Dict[RequestInfo, Counter[int]] = {}
+        self.response_sizes: Dict[RequestInfo, Counter[int]] = {}
         self._lock = threading.Lock()
 
-    def log_request(
-        self, consumer: Optional[str], method: str, path: str, status_code: int, response_time: float
+    def add_request(
+        self,
+        consumer: Optional[str],
+        method: str,
+        path: str,
+        status_code: int,
+        response_time: float,
+        request_size: str | int | None = None,
+        response_size: str | int | None = None,
     ) -> None:
         request_info = RequestInfo(
             consumer=consumer,
@@ -161,6 +179,16 @@ class RequestLogger:
         with self._lock:
             self.request_counts[request_info] += 1
             self.response_times.setdefault(request_info, Counter())[response_time_ms_bin] += 1
+            if request_size is not None:
+                request_size = int(request_size)
+                request_size_kb_bin = request_size // 1000  # In KB, rounded down to nearest 1KB
+                self.request_size_sums[request_info] += request_size
+                self.request_sizes.setdefault(request_info, Counter())[request_size_kb_bin] += 1
+            if response_size is not None:
+                response_size = int(response_size)
+                response_size_kb_bin = response_size // 1000  # In KB, rounded down to nearest 1KB
+                self.response_size_sums[request_info] += response_size
+                self.response_sizes.setdefault(request_info, Counter())[response_size_kb_bin] += 1
 
     def get_and_reset_requests(self) -> List[Dict[str, Any]]:
         data: List[Dict[str, Any]] = []
@@ -173,11 +201,19 @@ class RequestLogger:
                         "path": request_info.path,
                         "status_code": request_info.status_code,
                         "request_count": count,
+                        "request_size_sum": self.request_size_sums.get(request_info, 0),
+                        "response_size_sum": self.response_size_sums.get(request_info, 0),
                         "response_times": self.response_times.get(request_info) or Counter(),
+                        "request_sizes": self.request_sizes.get(request_info) or Counter(),
+                        "response_sizes": self.response_sizes.get(request_info) or Counter(),
                     }
                 )
             self.request_counts.clear()
+            self.request_size_sums.clear()
+            self.response_size_sums.clear()
             self.response_times.clear()
+            self.request_sizes.clear()
+            self.response_sizes.clear()
         return data
 
 
@@ -191,12 +227,12 @@ class ValidationError:
     type: str
 
 
-class ValidationErrorLogger:
+class ValidationErrorCounter:
     def __init__(self) -> None:
         self.error_counts: Counter[ValidationError] = Counter()
         self._lock = threading.Lock()
 
-    def log_validation_errors(
+    def add_validation_errors(
         self, consumer: Optional[str], method: str, path: str, detail: List[Dict[str, Any]]
     ) -> None:
         with self._lock:

apitally/client/threading.py

@@ -53,14 +53,12 @@ class ApitallyClient(ApitallyClientBase):
         client_id: str,
         env: str,
         sync_api_keys: bool = False,
-        sync_interval: float = 60,
         key_cache_class: Optional[Type[ApitallyKeyCacheBase]] = None,
     ) -> None:
         super().__init__(
             client_id=client_id,
             env=env,
             sync_api_keys=sync_api_keys,
-            sync_interval=sync_interval,
             key_cache_class=key_cache_class,
         )
         self._thread: Optional[Thread] = None

apitally/django.py

@@ -89,12 +89,16 @@ class ApitallyMiddleware:
         response = self.get_response(request)
         if request.method is not None and view is not None and view.is_api_view:
             consumer = self.get_consumer(request)
-            self.client.request_logger.log_request(
+            self.client.request_counter.add_request(
                 consumer=consumer,
                 method=request.method,
                 path=view.pattern,
                 status_code=response.status_code,
                 response_time=time.perf_counter() - start_time,
+                request_size=request.headers.get("Content-Length"),
+                response_size=response.headers.get("Content-Length")  # type: ignore[attr-defined]
+                if response.has_header("Content-Length")
+                else (len(response.content) if not response.streaming else None),
             )
             if (
                 response.status_code == 422
@@ -105,7 +109,7 @@ class ApitallyMiddleware:
                     body = json.loads(response.content)
                     if isinstance(body, dict) and "detail" in body and isinstance(body["detail"], list):
                         # Log Django Ninja / Pydantic validation errors
-                        self.client.validation_error_logger.log_validation_errors(
+                        self.client.validation_error_counter.add_validation_errors(
                             consumer=consumer,
                             method=request.method,
                             path=view.pattern,

apitally/flask.py

@@ -8,6 +8,7 @@ from threading import Timer
 from typing import TYPE_CHECKING, Any, Dict, Iterable, List, Optional, Tuple, Type
 
 from flask import Flask, g, make_response, request
+from werkzeug.datastructures import Headers
 from werkzeug.exceptions import NotFound
 from werkzeug.test import Client
 
@@ -58,31 +59,38 @@ class ApitallyMiddleware:
 
     def __call__(self, environ: WSGIEnvironment, start_response: StartResponse) -> Iterable[bytes]:
         status_code = 200
+        response_headers = Headers([])
 
-        def catching_start_response(status: str, headers, exc_info=None):
-            nonlocal status_code
+        def catching_start_response(status: str, headers: List[Tuple[str, str]], exc_info=None):
+            nonlocal status_code, response_headers
             status_code = int(status.split(" ")[0])
+            response_headers = Headers(headers)
             return start_response(status, headers, exc_info)
 
         start_time = time.perf_counter()
         with self.app.app_context():
             response = self.wsgi_app(environ, catching_start_response)
-            self.log_request(
+            self.add_request(
                 environ=environ,
                 status_code=status_code,
                 response_time=time.perf_counter() - start_time,
+                response_headers=response_headers,
             )
         return response
 
-    def log_request(self, environ: WSGIEnvironment, status_code: int, response_time: float) -> None:
+    def add_request(
+        self, environ: WSGIEnvironment, status_code: int, response_time: float, response_headers: Headers
+    ) -> None:
         rule, is_handled_path = self.get_rule(environ)
         if is_handled_path or not self.filter_unhandled_paths:
-            self.client.request_logger.log_request(
+            self.client.request_counter.add_request(
                 consumer=self.get_consumer(),
                 method=environ["REQUEST_METHOD"],
                 path=rule,
                 status_code=status_code,
                 response_time=response_time,
+                request_size=environ.get("CONTENT_LENGTH"),
+                response_size=response_headers.get("Content-Length", type=int),
             )
 
     def get_rule(self, environ: WSGIEnvironment) -> Tuple[str, bool]:

apitally/starlette.py

@@ -85,7 +85,7 @@ class ApitallyMiddleware(BaseHTTPMiddleware):
             start_time = time.perf_counter()
             response = await call_next(request)
         except BaseException as e:
-            await self.log_request(
+            await self.add_request(
                 request=request,
                 response=None,
                 status_code=HTTP_500_INTERNAL_SERVER_ERROR,
@@ -93,7 +93,7 @@ class ApitallyMiddleware(BaseHTTPMiddleware):
             )
             raise e from None
         else:
-            await self.log_request(
+            await self.add_request(
                 request=request,
                 response=response,
                 status_code=response.status_code,
@@ -101,18 +101,20 @@ class ApitallyMiddleware(BaseHTTPMiddleware):
             )
         return response
 
-    async def log_request(
+    async def add_request(
         self, request: Request, response: Optional[Response], status_code: int, response_time: float
     ) -> None:
         path_template, is_handled_path = self.get_path_template(request)
         if is_handled_path or not self.filter_unhandled_paths:
             consumer = self.get_consumer(request)
-            self.client.request_logger.log_request(
+            self.client.request_counter.add_request(
                 consumer=consumer,
                 method=request.method,
                 path=path_template,
                 status_code=status_code,
                 response_time=response_time,
+                request_size=request.headers.get("Content-Length"),
+                response_size=response.headers.get("Content-Length") if response is not None else None,
             )
             if (
                 status_code == 422
@@ -122,7 +124,7 @@ class ApitallyMiddleware(BaseHTTPMiddleware):
                 body = await self.get_response_json(response)
                 if isinstance(body, dict) and "detail" in body and isinstance(body["detail"], list):
                     # Log FastAPI / Pydantic validation errors
-                    self.client.validation_error_logger.log_validation_errors(
+                    self.client.validation_error_counter.add_validation_errors(
                         consumer=consumer,
                         method=request.method,
                         path=path_template,

{apitally-0.3.4.dist-info → apitally-0.4.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: apitally
-Version: 0.3.4
+Version: 0.4.1
 Summary: Simple API monitoring and API key management for REST APIs built with FastAPI, Flask, Django, and Starlette.
 Home-page: https://docs.apitally.io
 License: MIT

apitally-0.4.1.dist-info/RECORD

@@ -0,0 +1,17 @@
+apitally/__init__.py,sha256=pMtTmSUht-XtbR_7Doz6bsQqopJJd8rZ8I8zy2HwwoA,22
+apitally/client/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+apitally/client/asyncio.py,sha256=A7FEk-VD7YY2UPVBNaI8Roh3e0YLAVpD5iU6wS5067I,5977
+apitally/client/base.py,sha256=iEBFWId-M6_V1roAE4z270iwdZQJ48NZ7trAOSEAUBk,12489
+apitally/client/logging.py,sha256=QMsKIIAFo92PNBUleeTgsrsQa7SEal-oJa1oOHUr1wI,507
+apitally/client/threading.py,sha256=CALCE4AGMMedhR5GpwiPqY4BZIiIu3TrIa-H2dzpxvg,6396
+apitally/django.py,sha256=i2mb7sHes6Q4JE1kdo1BvDBBcGZzuv946e4MDlAE62c,10555
+apitally/django_ninja.py,sha256=TFltgr03FzTnl83sUAXJj7R32u_g9DTZ9p-HuVKs4ZE,2785
+apitally/django_rest_framework.py,sha256=UmJvxxiKGRdaILSbg6jJY_cvAl-mpuPY1pM0FoQ4bg0,1587
+apitally/fastapi.py,sha256=YjnrRis8UG2M6Q3lkwizbtDXU7nPfCA4mebxG8XwveY,3334
+apitally/flask.py,sha256=C3_Uk0XiVyayXURnzKvoG7EAFthA6PeV7mLys22BiO4,6960
+apitally/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+apitally/starlette.py,sha256=8PQdvw0h0_rBVziPciMGtHf0vxJ_mlrKOSyFAB7Mr14,9941
+apitally-0.4.1.dist-info/LICENSE,sha256=vbLzC-4TddtXX-_AFEBKMYWRlxC_MN0g66QhPxo8PgY,1065
+apitally-0.4.1.dist-info/METADATA,sha256=J-oAJmEw8L92xjTx3rCZhz7xvZWn4QW5PG9GL9eHhpY,6983
+apitally-0.4.1.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
+apitally-0.4.1.dist-info/RECORD,,

apitally-0.3.4.dist-info/RECORD

@@ -1,17 +0,0 @@
-apitally/__init__.py,sha256=oYLGMpySamd16KLiaBTfRyrAS7_oyp-TOEHmzmeumwg,22
-apitally/client/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-apitally/client/asyncio.py,sha256=ntn9TVhMKPtwrw1C1Qv96Enr_nSsaJHYmyCrbXw-sBc,6053
-apitally/client/base.py,sha256=ndllCC9rQsAwGYlzYn7kSCarBX0rEKWp44BMUop1t7w,10630
-apitally/client/logging.py,sha256=QMsKIIAFo92PNBUleeTgsrsQa7SEal-oJa1oOHUr1wI,507
-apitally/client/threading.py,sha256=9xYW095OXWrX4kciAbbrztc2DeNwRPvMf7zvcbes5Ec,6472
-apitally/django.py,sha256=Y1VLlLLla89z3sjs7zCHwnCGCZ1VScw7AkcjqtrnNNY,10247
-apitally/django_ninja.py,sha256=TFltgr03FzTnl83sUAXJj7R32u_g9DTZ9p-HuVKs4ZE,2785
-apitally/django_rest_framework.py,sha256=UmJvxxiKGRdaILSbg6jJY_cvAl-mpuPY1pM0FoQ4bg0,1587
-apitally/fastapi.py,sha256=YjnrRis8UG2M6Q3lkwizbtDXU7nPfCA4mebxG8XwveY,3334
-apitally/flask.py,sha256=SB0GM9KQbqLh1mEwUkI7jZ8BJS79l3cYjxXjYr7lw0c,6555
-apitally/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-apitally/starlette.py,sha256=T1aHf5L-sqVlYjPRPO8HbrvYrn98eeIrzBGAOEKJSEU,9767
-apitally-0.3.4.dist-info/LICENSE,sha256=vbLzC-4TddtXX-_AFEBKMYWRlxC_MN0g66QhPxo8PgY,1065
-apitally-0.3.4.dist-info/METADATA,sha256=N_AO1I5JF6v80cN1uKLu_Ef__kEAmVI3X01LXYVb15Q,6983
-apitally-0.3.4.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
-apitally-0.3.4.dist-info/RECORD,,