apitally 0.14.1__py3-none-any.whl → 0.14.3__py3-none-any.whl

apitally/client/request_logging.py

@@ -35,6 +35,12 @@ EXCLUDE_PATH_PATTERNS = [
     r"/ready$",
     r"/live$",
 ]
+EXCLUDE_USER_AGENT_PATTERNS = [
+    r"health[_- ]?check",
+    r"microsoft-azure-application-lb",
+    r"googlehc",
+    r"kube-probe",
+]
 MASK_QUERY_PARAM_PATTERNS = [
     r"auth",
     r"api-?key",
@@ -162,7 +168,12 @@ class RequestLogger:
         if not self.enabled or self.suspend_until is not None:
             return
         parsed_url = urlparse(request["url"])
-        if self._should_exclude_path(request["path"] or parsed_url.path) or self._should_exclude(request, response):
+        user_agent = self._get_user_agent(request["headers"])
+        if (
+            self._should_exclude_path(request["path"] or parsed_url.path)
+            or self._should_exclude_user_agent(user_agent)
+            or self._should_exclude(request, response)
+        ):
             return
 
         query = self._mask_query_params(parsed_url.query) if self.config.log_query_params else ""
@@ -271,6 +282,10 @@ class RequestLogger:
         patterns = self.config.exclude_paths + EXCLUDE_PATH_PATTERNS
         return self._match_patterns(url_path, patterns)
 
+    @lru_cache(maxsize=1000)
+    def _should_exclude_user_agent(self, user_agent: Optional[str]) -> bool:
+        return self._match_patterns(user_agent, EXCLUDE_USER_AGENT_PATTERNS) if user_agent is not None else False
+
     def _mask_query_params(self, query: str) -> str:
         query_params = parse_qsl(query)
         masked_query_params = [(k, v if not self._should_mask_query_param(k) else MASKED) for k, v in query_params]
@@ -302,6 +317,10 @@ class RequestLogger:
         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)
 
+    @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 _check_writable_fs() -> bool:
     try:

apitally/starlette.py

@@ -222,12 +222,18 @@ class ApitallyMiddleware:
                 },
             )
 
-    @staticmethod
-    def get_path(request: Request) -> Optional[str]:
-        for route in request.app.routes:
-            match, _ = route.matches(request.scope)
-            if match == Match.FULL:
-                return route.path
+    def get_path(self, request: Request, routes: Optional[list[BaseRoute]] = None) -> Optional[str]:
+        if routes is None:
+            routes = request.app.routes
+        for route in routes:
+            if hasattr(route, "routes"):
+                path = self.get_path(request, routes=route.routes)
+                if path is not None:
+                    return path
+            elif hasattr(route, "path"):
+                match, _ = route.matches(request.scope)
+                if match == Match.FULL:
+                    return request.scope.get("root_path", "") + route.path
         return None
 
     def get_consumer(self, request: Request) -> Optional[ApitallyConsumer]:

{apitally-0.14.1.dist-info → apitally-0.14.3.dist-info}/METADATA

@@ -1,12 +1,13 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: apitally
-Version: 0.14.1
+Version: 0.14.3
 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
 Project-URL: Repository, https://github.com/apitally/apitally-py
 Author-email: Apitally <hello@apitally.io>
 License: MIT License
+License-File: LICENSE
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Web Environment
 Classifier: Framework :: Django
@@ -68,9 +69,9 @@ Description-Content-Type: text/markdown
   </picture>
 </p>
 
-<p align="center"><b>API monitoring made easy.</b></p>
+<p align="center"><b>Analytics, logging & monitoring for REST APIs.</b></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"><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>
 
@@ -100,7 +101,7 @@ the 📚 [documentation](https://docs.apitally.io).
 ## Key features
 
 - Middleware for different frameworks to capture metadata about API endpoints,
-  requests and responses (no sensitive data is captured)
+  requests and responses
 - Non-blocking clients that aggregate and send captured data to Apitally in
   regular intervals
 

{apitally-0.14.1.dist-info → apitally-0.14.3.dist-info}/RECORD

@@ -7,18 +7,18 @@ apitally/fastapi.py,sha256=IfKfgsmIY8_AtnuMTW2sW4qnkya61CAE2vBoIpcc9tk,169
 apitally/flask.py,sha256=Th5LsMsTKkWERPrKfSWPhzrp99tg0pDtKXgtlVLx3eo,9279
 apitally/litestar.py,sha256=hAH2-OVVXBDVY8LopfIGv30yYwi-71tSEsKd6648CYc,13098
 apitally/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-apitally/starlette.py,sha256=8WAWQPePJAYy-B5TrxawxAeUqBiSXD15Ay17i2B22jc,12500
+apitally/starlette.py,sha256=VaT4-QVSYC0YX1U5kVI-dGROEd64IbjYU5lx5N16yf8,12852
 apitally/client/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 apitally/client/client_asyncio.py,sha256=lRvVKFU6eiapJnB9WrRq6Nuadx-n8NCKwQg-da1vPSM,7064
 apitally/client/client_base.py,sha256=w5AXAbg3hw5Qds5rovCZFtePB9bHNcJsr9l7kDgbroc,3733
 apitally/client/client_threading.py,sha256=MbytG8EopF84nmr5ShAZaq-VviSXYnBfBl7cRFRe1Kg,7479
 apitally/client/consumers.py,sha256=w_AFQhVgdtJVt7pVySBvSZwQg-2JVqmD2JQtVBoMkus,2626
 apitally/client/logging.py,sha256=QMsKIIAFo92PNBUleeTgsrsQa7SEal-oJa1oOHUr1wI,507
-apitally/client/request_logging.py,sha256=4N_JdkkrNVAFhlSAie3Kio3F1ARObYvFOH6D1mFppZg,12361
+apitally/client/request_logging.py,sha256=5i7Gv4yP7iq4tBgw-ppkhlZd_OwMc719ZvWEm16TCvg,13047
 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.1.dist-info/METADATA,sha256=sWueWK0vQcT_Kss4Gf3aIjx0-WhsisA1WfSPefFivlQ,7577
-apitally-0.14.1.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-apitally-0.14.1.dist-info/licenses/LICENSE,sha256=vbLzC-4TddtXX-_AFEBKMYWRlxC_MN0g66QhPxo8PgY,1065
-apitally-0.14.1.dist-info/RECORD,,
+apitally-0.14.3.dist-info/METADATA,sha256=ASnl8PEaJIOpTrMIIzs13F9T5jrnJ0I2gHTOnXEvPiU,7570
+apitally-0.14.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+apitally-0.14.3.dist-info/licenses/LICENSE,sha256=vbLzC-4TddtXX-_AFEBKMYWRlxC_MN0g66QhPxo8PgY,1065
+apitally-0.14.3.dist-info/RECORD,,

{apitally-0.14.1.dist-info → apitally-0.14.3.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.26.3
+Generator: hatchling 1.27.0
 Root-Is-Purelib: true
 Tag: py3-none-any