hydra-structlog 0.1.0__tar.gz → 0.2.0__tar.gz

{hydra_structlog-0.1.0 → hydra_structlog-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hydra-structlog
-Version: 0.1.0
+Version: 0.2.0
 Summary: An opinionated hydra plugin to configure logging with structlog
 Keywords: hydra,structlog,plugin,hydra-zen
 Author: Sören Zapp
@@ -27,6 +27,11 @@ Description-Content-Type: text/markdown
 
 # Hydra-Structlog
 
+[![CI](https://github.com/szapp/hydra-structlog/actions/workflows/ci.yml/badge.svg)](https://github.com/szapp/hydra-structlog/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/hydra-structlog)](https://pypi.python.org/pypi/hydra-structlog)
+[![Python Versions](https://img.shields.io/pypi/pyversions/hydra-structlog)](https://github.com/szapp/hydra-structlog)
+[![Support on Ko-fi](https://img.shields.io/badge/ko--fi-support-ff586e?logo=kofi&logoColor=white)](https://ko-fi.com/szapp)
+
 An opinionated hydra plugin to configure logging with structlog.
 
 ## Usage

{hydra_structlog-0.1.0 → hydra_structlog-0.2.0}/README.md

@@ -1,5 +1,10 @@
 # Hydra-Structlog
 
+[![CI](https://github.com/szapp/hydra-structlog/actions/workflows/ci.yml/badge.svg)](https://github.com/szapp/hydra-structlog/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/hydra-structlog)](https://pypi.python.org/pypi/hydra-structlog)
+[![Python Versions](https://img.shields.io/pypi/pyversions/hydra-structlog)](https://github.com/szapp/hydra-structlog)
+[![Support on Ko-fi](https://img.shields.io/badge/ko--fi-support-ff586e?logo=kofi&logoColor=white)](https://ko-fi.com/szapp)
+
 An opinionated hydra plugin to configure logging with structlog.
 
 ## Usage

{hydra_structlog-0.1.0 → hydra_structlog-0.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "hydra-structlog"
-version = "0.1.0"
+version = "0.2.0"
 description = "An opinionated hydra plugin to configure logging with structlog"
 readme = "README.md"
 authors = [

hydra_structlog-0.2.0/src/hydra_structlog/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.2.0"

{hydra_structlog-0.1.0 → hydra_structlog-0.2.0}/src/hydra_structlog/conf/hydra/job_logging/structlog.yaml

@@ -40,12 +40,13 @@ formatters:
       remove_processors_meta:
         _target_: structlog.stdlib.ProcessorFormatter.remove_processors_meta
         _partial_: true
-      static_field_adder:
-        _target_: hydra_structlog.processors.StaticFieldAdder
-        service: ${oc.env:SERVICE,null}
-        version: ${oc.env:VERSION,null}
-        env: ${oc.env:ENV,dev}
+      static_key_adder:
+        _target_: hydra_structlog.processors.StaticKeyAdder
+        service: ${oc.select:hydra.job.env_set.SERVICE,${oc.env:SERVICE,null}}
+        version: ${oc.select:hydra.job.env_set.VERSION,${oc.env:VERSION,null}}
+        env: ${oc.select:hydra.job.env_set.ENV,${oc.env:ENV,dev}}
         task: ${hydra.job.name}
+        runtime_version: ${python_version:micro}
       callsite_parameter_adder:
         _target_: structlog.processors.CallsiteParameterAdder
         parameters:
@@ -61,16 +62,25 @@ formatters:
       time_stamper:
         _target_: structlog.processors.TimeStamper
         fmt: iso
-      field_renamer:
-        _target_: hydra_structlog.processors.FieldRenamer
+      key_renamer:
+        _target_: hydra_structlog.processors.KeyRenamer
         level: status
         event: message
       format_exc_info:
         _target_: structlog.processors.format_exc_info
         _partial_: true
+      key_sorter:
+        _target_: hydra_structlog.processors.KeySorter
+        key_order:
+          - timestamp
+          - status
+          - message
+          - logger
+          - func_name
+          - lineno
+        drop_missing: true
       json_renderer:
         _target_: structlog.processors.JSONRenderer
-        sort_keys: true
 handlers:
   console:
     class: hydra_structlog.handlers.TqdmStreamHandler

hydra_structlog-0.2.0/src/hydra_structlog/processors.py

@@ -0,0 +1,92 @@
+from collections.abc import Callable, MutableMapping, Sequence
+from typing import Any
+
+from structlog.typing import EventDict, WrappedLogger
+
+
+class StaticKeyAdder:
+    """Structlog processor to add static keys to all logs."""
+
+    def __init__(self, **keys: str):
+        self.keys = keys
+
+    def __call__(
+        self, logger: WrappedLogger, name: str, event_dict: EventDict
+    ) -> EventDict:
+        for key, value in self.keys.items():
+            if value is not None and value != "":
+                event_dict.setdefault(key, value)
+        return event_dict
+
+
+class KeyRenamer:
+    """Structlog processor to rename keys. Existing keys of new name are overwritten."""
+
+    def __init__(self, **mapping: str):
+        self.mapping = mapping
+
+    def __call__(
+        self, logger: WrappedLogger, name: str, event_dict: EventDict
+    ) -> EventDict:
+        for key, replace in self.mapping.items():
+            if key in event_dict:
+                event_dict[replace] = event_dict.pop(key)
+        return event_dict
+
+
+class KeySorter:
+    """Sort keys in events.
+
+    Args:
+        key_order: List of keys that should be rendered in this exact order. Missing
+            keys will be added as None.
+        drop_missing: When True, extra keys in key_order will be dropped rather than
+            added as None.
+    """
+
+    def __init__(
+        self, key_order: Sequence[str] | None = None, drop_missing: bool = False
+    ):
+        self._ordered_items = self._items_sorter(key_order, drop_missing)
+
+    @staticmethod
+    def _items_sorter(
+        key_order: Sequence[str] | None, drop_missing: bool
+    ) -> Callable[[EventDict], dict[str, object]]:
+        """Return a function to sort items from an `event_dict`.
+
+        Modified from `structlog.processors._items_sorter`.
+        """
+        # Use an optimized version for each case.
+        if key_order:
+
+            def ordered_items(event_dict: EventDict) -> dict[str, Any]:
+                items = []
+                for key in key_order:
+                    value = event_dict.pop(key, None)
+                    if value is not None or not drop_missing:
+                        items.append((key, value))
+
+                items += sorted(event_dict.items())
+
+                return dict(items)
+
+        else:
+
+            def ordered_items(event_dict: EventDict) -> dict[str, Any]:
+                return dict(sorted(event_dict.items()))
+
+        return ordered_items
+
+    def __call__(
+        self, logger: WrappedLogger, name: str, event_dict: EventDict
+    ) -> EventDict:
+        return self._ordered_items(event_dict)
+
+
+Processor = Callable[[Any, str, MutableMapping], MutableMapping]
+
+
+def named_processor_chain(**processors: Processor) -> list[Processor]:
+    """Convert a mapping of named processors into list. Skip None"""
+    return [p for p in processors.values() if p is not None]

hydra_structlog-0.1.0/src/hydra_structlog/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.1.0"

hydra_structlog-0.1.0/src/hydra_structlog/processors.py

@@ -1,43 +0,0 @@
-from collections.abc import Callable, MutableMapping
-from typing import Any
-
-from structlog.typing import EventDict, WrappedLogger
-
-
-class StaticFieldAdder:
-    """Structlog processor to add static fields to all logs."""
-
-    def __init__(self, **fields: str):
-        self.fields = fields
-
-    def __call__(
-        self, logger: WrappedLogger, name: str, event_dict: EventDict
-    ) -> EventDict:
-        for field, value in self.fields.items():
-            event_dict.setdefault(field, value)
-        return event_dict
-
-
-class FieldRenamer:
-    """Structlog processor to rename fields. Existing fields of the new name are
-    overwritten.
-    """
-
-    def __init__(self, **mapping: str):
-        self.mapping = mapping
-
-    def __call__(
-        self, logger: WrappedLogger, name: str, event_dict: EventDict
-    ) -> EventDict:
-        for field, replace in self.mapping.items():
-            if field in event_dict:
-                event_dict[replace] = event_dict.pop(field)
-        return event_dict
-
-
-Processor = Callable[[Any, str, MutableMapping], MutableMapping]
-
-
-def named_processor_chain(**processors: Processor) -> list[Processor]:
-    """Convert a mapping of named processors into list. Skip None"""
-    return [p for p in processors.values() if p is not None]