structlog-config 0.4.0__py3-none-any.whl → 0.4.2__py3-none-any.whl

structlog_config/fastapi_access_logger.py

@@ -1,3 +1,7 @@
+"""
+Requires fastapi and is not loaded by default since fastapi is not a default dependency.
+"""
+
 from time import perf_counter
 from urllib.parse import quote
 
@@ -11,7 +15,8 @@ from starlette.routing import Match, Mount
 from starlette.types import Scope
 from starlette.websockets import WebSocket
 
-log = structlog.get_logger("access_log")
+# should name this access "access_log" or something
+log = structlog.get_logger()
 ipw = IpWare()
 
 
@@ -50,22 +55,6 @@ def get_path_with_query_string(scope: Scope) -> str:
     return path_with_query_string
 
 
-def get_client_addr(scope: Scope) -> str:
-    """Get the client's address.
-
-    Args:
-        scope (Scope): Current context.
-
-    Returns:
-        str: Client's address in the IP:PORT format.
-    """
-    client = scope.get("client")
-    if not client:
-        return ""
-    ip, port = client
-    return f"{ip}:{port}"
-
-
 def client_ip_from_request(request: Request | WebSocket) -> str | None:
     """
     Get the client IP address from the request.
@@ -125,6 +114,8 @@ def is_static_assets_request(scope: Scope) -> bool:
     )
 
 
+# TODO issue with this approach is if there is an error we don't get a path logged :/
+#      maybe we should log a ERROR with the path information and wrap it with a try?
 def add_middleware(
     app: FastAPI,
 ) -> None:

{structlog_config-0.4.0.dist-info → structlog_config-0.4.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: structlog-config
-Version: 0.4.0
+Version: 0.4.2
 Summary: A comprehensive structlog configuration with sensible defaults for development and production environments, featuring context management, exception formatting, and path prettification.
 Keywords: logging,structlog,json-logging,structured-logging
 Author: Michael Bianco
@@ -39,6 +39,27 @@ log = configure_logger()
 log.info("the log", key="value")
 ```
 
+## JSON Logging for Production
+
+JSON logging is automatically enabled in production and staging environments (`PYTHON_ENV=production` or `PYTHON_ENV=staging`):
+
+```python
+from structlog_config import configure_logger
+
+# Automatic JSON logging in production
+log = configure_logger()
+log.info("User login", user_id="123", action="login")
+# Output: {"action":"login","event":"User login","level":"info","timestamp":"2025-09-24T18:03:00Z","user_id":"123"}
+
+# Force JSON logging regardless of environment
+log = configure_logger(json_logger=True)
+
+# Force console logging regardless of environment
+log = configure_logger(json_logger=False)
+```
+
+JSON logs use [orjson](https://github.com/ijl/orjson) for performance, include sorted keys and ISO timestamps, and serialize exceptions cleanly. Note that `PYTHON_LOG_PATH` is ignored with JSON logging (stdout only).
+
 ## TRACE Logging Level
 
 This package adds support for a custom `TRACE` logging level (level 5) that's even more verbose than `DEBUG`. This is useful for extremely detailed debugging scenarios.

{structlog_config-0.4.0.dist-info → structlog_config-0.4.2.dist-info}/RECORD

@@ -2,13 +2,13 @@ structlog_config/__init__.py,sha256=DyY4x3_dY_hPNbS1aM7JRCGadTa1dYDIPzgrHu3AP68,
 structlog_config/constants.py,sha256=O1nPnB29yZdqqaI7aeTUrimA3LOtA5WpP6BGPLWJvj8,510
 structlog_config/env_config.py,sha256=_EJO0rgAKndRPSh4wuBaH3bui9F3nIpn8FaEkjAjZso,1737
 structlog_config/environments.py,sha256=JpZYVVDGxEf1EaKdPdn6Jo-4wJK6SqF0ueFl7e2TBvI,612
-structlog_config/fastapi_access_logger.py,sha256=REwchxGb5WHbiQi2zYtBPfkGHk-NvCKM2pVwJlwG5H8,5464
+structlog_config/fastapi_access_logger.py,sha256=QuvteKBZGsEiVaPEpdpsK1jjCYEPKnhmsQDC89M2JKc,5452
 structlog_config/formatters.py,sha256=ll0Y0QeRs1DMmD-ft1n1zA4Vn2STRSK-mOrczYB2OjE,5898
 structlog_config/levels.py,sha256=z1fTpvCCbAwcFK2k7rHWh_p-FqfFh4yIWCTZ1MNf_4U,993
 structlog_config/packages.py,sha256=asxrzLR-iRYAbkoSYutyTdIRcruTjHgkzfe2pjm2VFM,519
 structlog_config/stdlib_logging.py,sha256=Wnn59oRBIqn708CpR-akqVcG9ccSfCMLh56_7wxZRH0,7350
 structlog_config/trace.py,sha256=dBaSynxmw4Wg79wSHqYEMoByvv--v_oQw61dRdg4xUI,2016
 structlog_config/warnings.py,sha256=gKEcuHWqH0BaKitJtQkv-uJ0Z3uCH5nn6k8qpqjR-RM,998
-structlog_config-0.4.0.dist-info/WHEEL,sha256=4n27za1eEkOnA7dNjN6C5-O2rUiw6iapszm14Uj-Qmk,79
-structlog_config-0.4.0.dist-info/METADATA,sha256=R2XtpZuBtPdum5qHcmmCoXbSFoQPm0iv4VQcAX0I7zI,5472
-structlog_config-0.4.0.dist-info/RECORD,,
+structlog_config-0.4.2.dist-info/WHEEL,sha256=4n27za1eEkOnA7dNjN6C5-O2rUiw6iapszm14Uj-Qmk,79
+structlog_config-0.4.2.dist-info/METADATA,sha256=wDb3zt_g4fwx5MtN2SvuXqi6O4FzDA-WH7TnYZNoUcg,6329
+structlog_config-0.4.2.dist-info/RECORD,,