Merge pull request #14 from vikinganalytics/disable_logging_flag

Added flag for ignoring logs for entrypoint

Author: Fredrik Mile

daeploy/_service/service.py

@@ -77,6 +77,7 @@ def entrypoint(
         func: Callable = None,
         method: str = "POST",
         monitor: bool = False,
+        disable_http_logs: bool = False,
         **fastapi_kwargs,
     ) -> Callable:
         """Registers a function as an entrypoint, which will make it reachable
@@ -96,6 +97,11 @@ def my_function(arg1:type1) -> type2:
             method (str): HTTP method for entrypoint. Defauts to "POST"
             monitor (bool): Set if the input and output to this entrypoint should
                 be saved to the service's monitoring database. Defaults to False.
+            disable_http_logs (bool): Set if the http entry logs should be disabled for
+                this entrypoint.
+                These logs are genereated from uvicorn. Defaults to False.
+                Example of http entry log:
+                    "POST /services/service_1.0.0/entrypoint_name HTTP/1.1" 200 OK
             **fastapi_kwargs: Keyword arguments for the resulting API endpoint.
                 See FastAPI for keyword arguments of the ``FastAPI.api_route()``
                 function.
@@ -167,6 +173,14 @@ async def wrapper(_request: Request, *args, **kwargs):
                 wrapper
             )
 
+            if disable_http_logs:
+                logging.getLogger("uvicorn.access").addFilter(
+                    # Add a space to the path to make sure that we
+                    # only filter out this entrypoints HTTP logs.
+                    lambda record: f"{path} "
+                    not in record.getMessage()
+                )
+
             # Wrap the original func in a pydantic validation wrapper and return that
             return validate_arguments(deco_func)
 

daeploy/utilities.py

@@ -71,7 +71,7 @@ def get_service_root_path() -> str:
     if name == UNKNOWN_NAME and version == UNKNOWN_VERSION:
         return ""
 
-    return f"/services/{name}_{version}/"
+    return f"/services/{name}_{version}"
 
 
 def get_headers() -> dict:

tests/e2e_test/downstream/downstream.py

@@ -73,5 +73,15 @@ def store_variable_vz_10_times():
         service.store(vz=i)
 
 
+@service.entrypoint(disable_http_logs=True)
+def http_logs():
+    logger.info("This is a correct log!")
+
+
+@service.entrypoint(disable_http_logs=False)
+def http_logs_2():
+    pass
+
+
 if __name__ == "__main__":
     service.run()

tests/e2e_test/e2e_test.py

@@ -250,6 +250,23 @@ def test_reaching_daeploy_entrypoint_with_basemodel_args(
     }
 
 
+def test_disable_http_logs_in_entrypoint(
+    dummy_manager, cli_auth_login, services, logs, headers
+):
+    http_logs_url = "http://localhost/services/downstream/http_logs"
+    http_no_logs_url = "http://localhost/services/downstream/http_logs_2"
+
+    # Call the entrypoint that allows http logs.
+    requests.request("POST", url=http_logs_url, headers=headers)
+    # Call the entrypoint that does not allow http logs.
+    requests.request("POST", url=http_no_logs_url, headers=headers)
+    logs = logs("downstream")
+    # Check that the logs from inside the entrypoint are logged.
+    assert "This is a correct log!" in logs
+    assert '"POST /services/downstream_0.1.0/http_logs_2 HTTP/1.1" 200 OK' in logs
+    assert '"POST /services/downstream_0.1.0/http_logs HTTP/1.1" 200 OK' not in logs
+
+
 def test_call_service_multiple_cases(
     dummy_manager, cli_auth_login, services, logs, headers
 ):

tests/sdk_test/daeploy_test.py

@@ -10,6 +10,7 @@
 import pandas as pd
 import pydantic
 import pytest
+import logging
 from fastapi.exceptions import FastAPIError
 from fastapi.testclient import TestClient
 from daeploy._service import db