Merge pull request #730 from danielballan/log-config

Implement `--log-config` for all server CLI commands.

Author: Kezzsim

example_log_config.yml

@@ -0,0 +1,41 @@
+version: 1
+disable_existing_loggers: false
+filters:
+  correlation_id:
+    "()": asgi_correlation_id.CorrelationIdFilter
+    uuid_length: 16
+    default_value: '-'
+formatters:
+  default:
+    "()": uvicorn.logging.DefaultFormatter
+    datefmt: "%Y-%m-%dT%H:%M:%S"
+    format:  '[%(asctime)s.%(msecs)03dZ] [%(correlation_id)s] %(levelprefix)s %(message)s'
+    use_colors: true
+  access:
+    "()": uvicorn.logging.AccessFormatter
+    datefmt: "%Y-%m-%dT%H:%M:%S"
+    format: '[%(asctime)s.%(msecs)03dZ] [%(correlation_id)s] %(levelprefix)s %(client_addr)s - "%(request_line)s" %(status_code)s'
+handlers:
+  default:
+    formatter: default
+    class: logging.StreamHandler
+    filters:
+      - correlation_id
+    stream: ext://sys.stderr
+  access:
+    formatter: access
+    class: logging.StreamHandler
+    filters:
+      - correlation_id
+    stream: ext://sys.stdout
+loggers:
+  uvicorn.error:
+    level: INFO
+    handlers:
+      - default
+    propagate: no
+  uvicorn.access:
+    level: INFO
+    handlers:
+      - access
+    propagate: no

tiled/commandline/_serve.py

@@ -199,11 +199,13 @@ def serve_directory(
 
     import anyio
     import uvicorn
+    from uvicorn.config import LOGGING_CONFIG
 
     from ..client import from_uri as client_from_uri
 
     print_admin_api_key_if_generated(web_app, host=host, port=port, force=generated)
-    config = uvicorn.Config(web_app, host=host, port=port)
+    log_config = log_config or LOGGING_CONFIG  # fall back to uvicorn default
+    config = uvicorn.Config(web_app, host=host, port=port, log_config=log_config)
     server = uvicorn.Server(config)
 
     async def run_server():
@@ -334,6 +336,9 @@ def serve_catalog(
             "This verifies that the configuration is compatible with scaled (multi-process) deployments."
         ),
     ),
+    log_config: Optional[str] = typer.Option(
+        None, help="Custom uvicorn logging configuration file"
+    ),
 ):
     "Serve a catalog."
     import urllib.parse
@@ -432,8 +437,10 @@ def serve_catalog(
     print_admin_api_key_if_generated(web_app, host=host, port=port)
 
     import uvicorn
+    from uvicorn.config import LOGGING_CONFIG
 
-    uvicorn.run(web_app, host=host, port=port)
+    log_config = log_config or LOGGING_CONFIG  # fall back to uvicorn default
+    uvicorn.run(web_app, host=host, port=port, log_config=log_config)
 
 
 serve_app.command("catalog")(serve_catalog)
@@ -477,6 +484,9 @@ def serve_pyobject(
             "This verifies that the configuration is compatible with scaled (multi-process) deployments."
         ),
     ),
+    log_config: Optional[str] = typer.Option(
+        None, help="Custom uvicorn logging configuration file"
+    ),
 ):
     "Serve a Tree instance from a Python module."
     from ..server.app import build_app, print_admin_api_key_if_generated
@@ -496,8 +506,10 @@ def serve_pyobject(
     print_admin_api_key_if_generated(web_app, host=host, port=port)
 
     import uvicorn
+    from uvicorn.config import LOGGING_CONFIG
 
-    uvicorn.run(web_app, host=host, port=port)
+    log_config = log_config or LOGGING_CONFIG  # fall back to uvicorn default
+    uvicorn.run(web_app, host=host, port=port, log_config=log_config)
 
 
 @serve_app.command("demo")
@@ -571,6 +583,9 @@ def serve_config(
             "This verifies that the configuration is compatible with scaled (multi-process) deployments."
         ),
     ),
+    log_config: Optional[str] = typer.Option(
+        None, help="Custom uvicorn logging configuration file"
+    ),
 ):
     "Serve a Tree as specified in configuration file(s)."
     import os
@@ -605,9 +620,10 @@ def serve_config(
 
     # Extract config for uvicorn.
     uvicorn_kwargs = parsed_config.pop("uvicorn", {})
-    # If --host is given, it overrides host in config. Same for --port.
+    # If --host is given, it overrides host in config. Same for --port and --log-config.
     uvicorn_kwargs["host"] = host or uvicorn_kwargs.get("host", "127.0.0.1")
     uvicorn_kwargs["port"] = port or uvicorn_kwargs.get("port", 8000)
+    uvicorn_kwargs["log_config"] = log_config or uvicorn_kwargs.get("log_config")
 
     # This config was already validated when it was parsed. Do not re-validate.
     logger.info(f"Using configuration from {Path(config_path).absolute()}")