structlog-config 0.4.0__tar.gz → 0.4.1__tar.gz

{structlog_config-0.4.0 → structlog_config-0.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: structlog-config
-Version: 0.4.0
+Version: 0.4.1
 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 → structlog_config-0.4.1}/README.md

@@ -24,6 +24,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 → structlog_config-0.4.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "structlog-config"
-version = "0.4.0"
+version = "0.4.1"
 description = "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"]
 readme = "README.md"

{structlog_config-0.4.0 → structlog_config-0.4.1}/structlog_config/__init__.py

@@ -9,6 +9,9 @@ from structlog.processors import ExceptionRenderer
 from structlog.tracebacks import ExceptionDictTransformer
 from structlog.typing import FilteringBoundLogger
 
+from structlog_config.fastapi_access_logger import (
+    client_ip_from_request,
+)
 from structlog_config.formatters import (
     PathPrettifier,
     add_fastapi_context,

{structlog_config-0.4.0 → structlog_config-0.4.1}/structlog_config/fastapi_access_logger.py

@@ -50,22 +50,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.