mh_structlog 0.0.44__tar.gz → 0.0.46__tar.gz

{mh_structlog-0.0.44 → mh_structlog-0.0.46}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: mh_structlog
-Version: 0.0.44
+Version: 0.0.46
 Summary: Some Structlog configuration and wrappers to easily use structlog.
 Author: Mathieu Hinderyckx
 Author-email: Mathieu Hinderyckx <mathieu.hinderyckx@gmail.com>

{mh_structlog-0.0.44 → mh_structlog-0.0.46}/pyproject.toml

@@ -8,7 +8,7 @@ authors = [
     { name = "Mathieu Hinderyckx", email = "mathieu.hinderyckx@gmail.com" },
 ]
 description = "Some Structlog configuration and wrappers to easily use structlog."
-version = "0.0.44"
+version = "0.0.46"
 readme = "README.md"
 requires-python = ">=3.10"
 classifiers = [

{mh_structlog-0.0.44 → mh_structlog-0.0.46}/src/mh_structlog/aws.py

@@ -1,18 +1,39 @@
+import os
+
 import structlog
 from aws_lambda_powertools.utilities.typing import LambdaContext
 
 
+is_cold_start = True
+
+
+def _reset_cold_start_flag() -> None:
+    """Reset the cold start flag to True. This is primarily intended for testing purposes."""
+    global is_cold_start  # noqa: PLW0603
+    is_cold_start = True
+
+
 def bind_lambda_context(lambda_context: LambdaContext) -> None:
     """Bind AWS Lambda context information to the structlog context variables, so log entries contain Lambda function metadata.
 
     Args:
         lambda_context (LambdaContext): The AWS Lambda context object.
     """
+    global is_cold_start  # noqa: PLW0603
+
     if lambda_context:
         structlog.contextvars.clear_contextvars()
+
+        if os.getenv('AWS_LAMBDA_INITIALIZATION_TYPE', '') == "provisioned-concurrency":
+            is_cold_start = False
+
         structlog.contextvars.bind_contextvars(
             function_name=lambda_context.function_name,
             function_memory_size=lambda_context.memory_limit_in_mb,
             function_arn=lambda_context.invoked_function_arn,
             function_request_id=lambda_context.aws_request_id,
+            cold_start=is_cold_start,
         )
+
+        # After the first invocation of an environment, set cold_start to False for further invocations
+        is_cold_start = False

{mh_structlog-0.0.44 → mh_structlog-0.0.46}/src/mh_structlog/config.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import logging  # noqa: I001
 import logging.config
+import os
 import sys
 from pathlib import Path
 from typing import Literal
@@ -21,7 +22,7 @@ class StructlogLoggingConfigExceptionError(Exception):
 
 
 def setup(  # noqa: PLR0912, PLR0915, C901
-    log_format: Literal["console", "json", "gcp_json"] | None = None,
+    log_format: Literal["console", "json", "gcp_json", "aws_json"] | None = None,
     logging_configs: list[dict] | None = None,
     include_source_location: bool = False,  # noqa: FBT001, FBT002
     global_filter_level: int | None = None,
@@ -31,6 +32,7 @@ def setup(  # noqa: PLR0912, PLR0915, C901
     max_frames: int = 100,
     sentry_config: dict | None = None,
     additional_processors: list | None = None,  # noqa: FBT001, FBT002
+    timestamp_ms_precision: bool | None = True,
 ) -> None:
     """This method configures structlog and the standard library logging module."""
     global SELECTED_LOG_FORMAT  # noqa: PLW0603
@@ -50,6 +52,9 @@ def setup(  # noqa: PLR0912, PLR0915, C901
         structlog.contextvars.merge_contextvars,  # add variables and bound data from global context
     ]
 
+    if timestamp_ms_precision:
+        shared_processors.append(processors.cap_timestamp_to_ms_precision)
+
     if additional_processors:
         shared_processors.extend(additional_processors)
 
@@ -59,7 +64,14 @@ def setup(  # noqa: PLR0912, PLR0915, C901
     # Configure stdout formatter
     if log_format is None:
         log_format = "console" if sys.stdout.isatty() else "json"
-    if log_format not in {"console", "json", "gcp_json"}:
+
+        # Determine a more specific log format based on environment if possible.
+        if log_format == "json":
+            if os.environ.get("GCP_PROJECT"):
+                log_format = "gcp_json"
+            elif os.environ.get("AWS_REGION"):
+                log_format = "aws_json"
+    if log_format not in {"console", "json", "gcp_json", "aws_json"}:
         raise StructlogLoggingConfigExceptionError("Unknown logging format requested.")
 
     SELECTED_LOG_FORMAT = log_format
@@ -85,7 +97,7 @@ def setup(  # noqa: PLR0912, PLR0915, C901
 
     if log_format == "console":
         selected_formatter = "mh_structlog_colored"
-    elif log_format in {"json", "gcp_json"}:
+    elif log_format in {"json", "gcp_json", "aws_json"}:
         shared_processors.extend(
             [structlog.processors.dict_tracebacks, processors.CapExceptionFrames(max_frames=2 * max_frames)]
         )
@@ -99,8 +111,33 @@ def setup(  # noqa: PLR0912, PLR0915, C901
         )
 
     wrapper_class = structlog.stdlib.BoundLogger
+
+    env_log_level_str = os.environ.get('LOG_LEVEL', '').upper()
+    env_log_level_constant = logging._nameToLevel.get(env_log_level_str)  # noqa: SLF001
+
+    if env_log_level_str and not env_log_level_constant:
+        raise StructlogLoggingConfigExceptionError(
+            f"LOG_LEVEL environment variable has unrecognized value: {env_log_level_str}"
+        )
+
     if global_filter_level is not None:
+        if global_filter_level not in logging._nameToLevel.values():  # noqa: SLF001
+            raise StructlogLoggingConfigExceptionError(
+                f"global_filter_level has unrecognized value: {global_filter_level}"
+            )
+        if env_log_level_constant and env_log_level_constant != global_filter_level:
+            from logging import getLogger  # noqa: PLC0415
+
+            getLogger('mh_structlog').warning(
+                'Both global_filter_level (%s, %s) and LOG_LEVEL environment variable (%s, %s) are set, but they differ. global_filter_level takes precedence.',
+                global_filter_level,
+                logging.getLevelName(global_filter_level),
+                env_log_level_constant,
+                logging.getLevelName(env_log_level_constant),
+            )
         wrapper_class = structlog.make_filtering_bound_logger(global_filter_level)
+    elif env_log_level_constant:
+        wrapper_class = structlog.make_filtering_bound_logger(env_log_level_constant)  # noqa: SLF001
 
     # Structlog configuration
     structlog.configure(
@@ -169,6 +206,7 @@ def setup(  # noqa: PLR0912, PLR0915, C901
                     processors.FieldRenamer(
                         log_format == 'gcp_json', 'level', 'severity'
                     ),  # rename the level field for GCP
+                    processors.FieldTransformer(log_format == 'aws_json', 'level', lambda v: v.upper()),
                     processors.render_orjson,
                 ],
                 "foreign_pre_chain": shared_processors,

{mh_structlog-0.0.44 → mh_structlog-0.0.46}/src/mh_structlog/processors.py

@@ -1,4 +1,5 @@
 import logging
+from collections.abc import Callable
 
 import orjson
 import structlog
@@ -81,6 +82,20 @@ class FieldRenamer:
         return event_dict
 
 
+class FieldTransformer:
+    """Transform a field in the event dict using a provided function."""
+
+    def __init__(self, enable: bool, field_name: str, transform_function: Callable):  # noqa: D107
+        self.enable = enable
+        self.field_name = field_name
+        self.transform_function = transform_function
+
+    def __call__(self, logger: logging.Logger, name: str, event_dict: EventDict) -> EventDict:  # noqa: D102,ARG001,ARG002
+        if self.enable and self.field_name in event_dict:
+            event_dict[self.field_name] = self.transform_function(event_dict[self.field_name])
+        return event_dict
+
+
 class CapExceptionFrames:
     """Limit the number of frames in the exception traceback.
 
@@ -95,3 +110,10 @@ class CapExceptionFrames:
         if self.max_frames is not None and 'exception' in event_dict and 'frames' in event_dict["exception"]:
             event_dict['exception']['frames'] = event_dict['exception']['frames'][-self.max_frames :]
         return event_dict
+
+
+def cap_timestamp_to_ms_precision(_, __, event_dict: dict) -> dict:  # noqa: ANN001
+    """Cap the timestamp to millisecond precision, dropping the microseconds part."""
+    if ts := event_dict.get("timestamp"):
+        event_dict['timestamp'] = ts[:-4] + 'Z'
+    return event_dict