esd-services-api-client 2.6.0__py3-none-any.whl → 2.6.1__py3-none-any.whl

esd_services_api_client/__init__.py

@@ -17,4 +17,4 @@
  Root index.
 """
 
-__version__ = "2.6.0"
+__version__ = "2.6.1"

esd_services_api_client/boxer/_connector.py

@@ -20,7 +20,11 @@ import os
 from functools import reduce
 from typing import Optional, Iterator, final
 
-from adapta.security.clients import AzureClient
+try:
+    from adapta.security.clients import AzureClient
+except ImportError:
+    pass
+
 from adapta.utils import session_with_retries
 from requests import Session, Response
 

esd_services_api_client/nexus/README.md

@@ -22,7 +22,7 @@ import socketserver
 import threading
 from dataclasses import dataclass
 from http.server import ThreadingHTTPServer, BaseHTTPRequestHandler
-from typing import Dict, Optional, Any
+from typing import Optional, Any
 
 import pandas
 from adapta.metrics import MetricsProvider
@@ -30,6 +30,7 @@ from adapta.storage.query_enabled_store import QueryEnabledStore
 from dataclasses_json import DataClassJsonMixin
 from injector import inject
 
+from esd_services_api_client.crystal import CrystalEntrypointArguments
 from esd_services_api_client.nexus.abstractions.algrorithm_cache import InputCache
 from esd_services_api_client.nexus.abstractions.logger_factory import LoggerFactory
 from esd_services_api_client.nexus.abstractions.nexus_object import AlgorithmResult
@@ -292,6 +293,15 @@ async def main():
      Mock HTTP Server
     :return:
     """
+    def tags_from_payload(payload: MyAlgorithmPayload, _: CrystalEntrypointArguments) -> dict[str, str]:
+        return {
+            "test_tag": str(payload.x)
+        }
+    def enrich_from_payload(payload: MyAlgorithmPayload2, run_args: CrystalEntrypointArguments) -> dict[str, dict[str, str]]:
+        return {
+            "(value of y:{y})": {"y": payload.y},
+            "(request_id:{request_id})": {"request_id": run_args.request_id}
+        }
     with ThreadingHTTPServer(("localhost", 9876), MockRequestHandler) as server:
         server_thread = threading.Thread(target=server.serve_forever)
         server_thread.daemon = True
@@ -306,6 +316,7 @@ async def main():
             .on_complete(ObjectiveAnalytics)
             .inject_configuration(MyAlgorithmConfiguration)
             .inject_payload(MyAlgorithmPayload, MyAlgorithmPayload2)
+            .with_log_enricher(tags_from_payload, enrich_from_payload)
         )
 
         await nexus.activate()

esd_services_api_client/nexus/abstractions/logger_factory.py

@@ -19,8 +19,9 @@
 
 import json
 import os
+from abc import ABC
 from logging import StreamHandler
-from typing import final, Type, TypeVar, Optional, Dict
+from typing import final, TypeVar
 
 from adapta.logs import LoggerInterface, create_async_logger
 from adapta.logs.handlers.datadog_api_handler import DataDogApiHandler
@@ -29,13 +30,61 @@ from adapta.logs.models import LogLevel
 TLogger = TypeVar("TLogger")  # pylint: disable=C0103:
 
 
+@final
+class BootstrapLogger(LoggerInterface, ABC):
+    """
+    Dummy class to separate bootstrap logging from core app loggers
+    """
+
+
+@final
+class BootstrapLoggerFactory:
+    """
+    Bootstrap logger provisioner.
+    Bootstrap loggers do not use enriched properties since they are initialized before payload is deserialized.
+    """
+
+    def __init__(self):
+        self._log_handlers = [
+            StreamHandler(),
+        ]
+        if "NEXUS__DATADOG_LOGGER_CONFIGURATION" in os.environ:
+            self._log_handlers.append(
+                DataDogApiHandler(
+                    **json.loads(os.getenv("NEXUS__DATADOG_LOGGER_CONFIGURATION"))
+                )
+            )
+
+    def create_logger(self, request_id: str, algorithm_name: str) -> LoggerInterface:
+        """
+        Creates an async-safe logger for the provided class name.
+        """
+        return create_async_logger(
+            logger_type=BootstrapLogger.__class__,
+            log_handlers=self._log_handlers,
+            min_log_level=LogLevel(os.getenv("NEXUS__LOG_LEVEL", "INFO")),
+            global_tags={
+                "request_id": request_id,
+                "algorithm": algorithm_name,
+            },
+        )
+
+
 @final
 class LoggerFactory:
     """
     Async logger provisioner.
     """
 
-    def __init__(self):
+    def __init__(
+        self,
+        fixed_template: dict[str, dict[str, str]] | None = None,
+        fixed_template_delimiter: str = None,
+        global_tags: dict[str, str] | None = None,
+    ):
+        self._global_tags = global_tags
+        self._fixed_template = fixed_template
+        self._fixed_template_delimiter = fixed_template_delimiter or ", "
         self._log_handlers = [
             StreamHandler(),
         ]
@@ -45,12 +94,20 @@ class LoggerFactory:
                     **json.loads(os.getenv("NEXUS__DATADOG_LOGGER_CONFIGURATION"))
                 )
             )
+        if "NEXUS__LOGGER_FIXED_TEMPLATE" in os.environ:
+            self._fixed_template = self._fixed_template | json.loads(
+                os.getenv("NEXUS__LOGGER_FIXED_TEMPLATE")
+            )
+
+        if "NEXUS__LOGGER_FIXED_TEMPLATE_DELIMITER" in os.environ:
+            self._fixed_template_delimiter = (
+                self._fixed_template_delimiter
+                or os.getenv("NEXUS__LOGGER_FIXED_TEMPLATE")
+            )
 
     def create_logger(
         self,
-        logger_type: Type[TLogger],
-        fixed_template: Optional[Dict[str, Dict[str, str]]] = None,
-        fixed_template_delimiter=", ",
+        logger_type: type[TLogger],
     ) -> LoggerInterface:
         """
         Creates an async-safe logger for the provided class name.
@@ -59,6 +116,7 @@ class LoggerFactory:
             logger_type=logger_type,
             log_handlers=self._log_handlers,
             min_log_level=LogLevel(os.getenv("NEXUS__LOG_LEVEL", "INFO")),
-            fixed_template=fixed_template,
-            fixed_template_delimiter=fixed_template_delimiter,
+            fixed_template=self._fixed_template,
+            fixed_template_delimiter=self._fixed_template_delimiter,
+            global_tags=self._global_tags,
         )

esd_services_api_client/nexus/core/app_core.py

@@ -23,7 +23,7 @@ import platform
 import signal
 import sys
 import traceback
-from typing import final, Type, Optional
+from typing import final, Type, Optional, Callable
 
 import backoff
 import urllib3.exceptions
@@ -41,7 +41,10 @@ from esd_services_api_client.crystal import (
     AlgorithmRunResult,
     CrystalEntrypointArguments,
 )
-from esd_services_api_client.nexus.abstractions.logger_factory import LoggerFactory
+from esd_services_api_client.nexus.abstractions.logger_factory import (
+    LoggerFactory,
+    BootstrapLoggerFactory,
+)
 from esd_services_api_client.nexus.abstractions.nexus_object import AlgorithmResult
 from esd_services_api_client.nexus.algorithms import (
     BaselineAlgorithm,
@@ -119,6 +122,21 @@ class Nexus:
         self._algorithm_run_task: Optional[asyncio.Task] = None
         self._on_complete_tasks: list[type[UserTelemetryRecorder]] = []
         self._payload_types: list[type[AlgorithmPayload]] = []
+        self._log_enricher: Callable[
+            [
+                AlgorithmPayload,
+                CrystalEntrypointArguments,
+            ],
+            dict[str, dict[str, str]],
+        ] | None = None
+        self._log_tagger: Callable[
+            [
+                AlgorithmPayload,
+                CrystalEntrypointArguments,
+            ],
+            dict[str, str],
+        ] | None = None
+        self._log_enrichment_delimiter: str = ", "
 
         attach_signal_handlers()
 
@@ -177,6 +195,36 @@ class Nexus:
 
         return self
 
+    def with_log_enricher(
+        self,
+        tagger: Callable[
+            [
+                AlgorithmPayload,
+                CrystalEntrypointArguments,
+            ],
+            dict[str, str],
+        ]
+        | None,
+        enricher: Callable[
+            [
+                AlgorithmPayload,
+                CrystalEntrypointArguments,
+            ],
+            dict[str, dict[str, str]],
+        ]
+        | None = None,
+        delimiter: str = ", ",
+    ) -> "Nexus":
+        """
+        Adds a log `tagger` and a log `enricher` to be used with injected logger.
+        A log `tagger` will add key-value tags to each emitted log message, and those tags can be inferred from the payload and entrypoint arguments.
+        A log `enricher` will add additional static templated content to log messages, and render those templates using payload properties entrypoint argyments.
+        """
+        self._log_tagger = tagger
+        self._log_enricher = enricher
+        self._log_enrichment_delimiter = delimiter
+        return self
+
     def with_module(self, module: Type[Module]) -> "Nexus":
         """
         Adds a (custom) DI module into the DI container.
@@ -260,11 +308,14 @@ class Nexus:
 
         self._injector = Injector(self._configurator.injection_binds)
 
-        root_logger: LoggerInterface = self._injector.get(LoggerFactory).create_logger(
-            logger_type=self.__class__,
+        bootstrap_logger: LoggerInterface = self._injector.get(
+            BootstrapLoggerFactory
+        ).create_logger(
+            request_id=self._run_args.request_id,
+            algorithm_name=os.getenv("CRYSTAL__ALGORITHM_NAME"),
         )
 
-        root_logger.start()
+        bootstrap_logger.start()
 
         for payload_type in self._payload_types:
             try:
@@ -272,10 +323,31 @@ class Nexus:
                 self._injector.binder.bind(
                     payload.__class__, to=payload, scope=singleton
                 )
+                logger_factory = LoggerFactory(
+                    fixed_template=None
+                    if not self._log_enricher
+                    else self._log_enricher(payload, self._run_args),
+                    fixed_template_delimiter=self._log_enrichment_delimiter,
+                    global_tags=self._log_tagger(payload, self._run_args),
+                )
+                # bind app-level LoggerFactory now
+                self._injector.binder.bind(
+                    logger_factory.__class__,
+                    to=logger_factory,
+                    scope=singleton,
+                )
             except BaseException as ex:  # pylint: disable=broad-except
-                root_logger.error("Error reading algorithm payload", ex)
+                bootstrap_logger.error("Error reading algorithm payload", ex)
                 sys.exit(1)
 
+        bootstrap_logger.stop()
+
+        root_logger: LoggerInterface = self._injector.get(LoggerFactory).create_logger(
+            logger_type=self.__class__,
+        )
+
+        root_logger.start()
+
         algorithm: BaselineAlgorithm = self._injector.get(self._algorithm_class)
         telemetry_recorder: TelemetryRecorder = self._injector.get(TelemetryRecorder)
 
@@ -300,7 +372,7 @@ class Nexus:
                 root_logger.error(
                     "Algorithm {algorithm} run failed on Nexus version {version}",
                     ex,
-                    algorithm=self._algorithm_class,
+                    algorithm=algorithm.__class__.__name__,
                     version=__version__,
                 )
 
@@ -311,8 +383,8 @@ class Nexus:
 
             # record telemetry
             root_logger.info(
-                "Recording telemetry for the run {request_id}",
-                request_id=self._run_args.request_id,
+                "Recording telemetry for the run {run_id}",
+                run_id=self._run_args.request_id,
             )
             async with telemetry_recorder as recorder:
                 await recorder.record(

esd_services_api_client/nexus/core/app_dependencies.py

@@ -30,7 +30,9 @@ from injector import Module, singleton, provider
 
 from esd_services_api_client.crystal import CrystalConnector
 from esd_services_api_client.nexus.abstractions.algrorithm_cache import InputCache
-from esd_services_api_client.nexus.abstractions.logger_factory import LoggerFactory
+from esd_services_api_client.nexus.abstractions.logger_factory import (
+    BootstrapLoggerFactory,
+)
 from esd_services_api_client.nexus.abstractions.socket_provider import (
     ExternalSocketProvider,
 )
@@ -72,18 +74,18 @@ class MetricsModule(Module):
 
 
 @final
-class LoggerFactoryModule(Module):
+class BootstrapLoggerFactoryModule(Module):
     """
     Logger factory module.
     """
 
     @singleton
     @provider
-    def provide(self) -> LoggerFactory:
+    def provide(self) -> BootstrapLoggerFactory:
         """
         DI factory method.
         """
-        return LoggerFactory()
+        return BootstrapLoggerFactory()
 
 
 @final
@@ -234,6 +236,7 @@ class ServiceConfigurator:
 
     def __init__(self):
         self._injection_binds = [
+            BootstrapLoggerFactoryModule(),
             MetricsModule(),
             CrystalReceiverClientModule(),
             QueryEnabledStoreModule(),

{esd_services_api_client-2.6.0.dist-info → esd_services_api_client-2.6.1.dist-info}/METADATA

@@ -1,21 +1,19 @@
 Metadata-Version: 2.3
 Name: esd-services-api-client
-Version: 2.6.0
+Version: 2.6.1
 Summary: Python clients for ESD services
 License: Apache 2.0
 Author: ECCO Sneaks & Data
 Author-email: esdsupport@ecco.com
 Maintainer: GZU
 Maintainer-email: gzu@ecco.com
-Requires-Python: >=3.9,<3.12
+Requires-Python: >=3.11,<3.12
 Classifier: License :: Other/Proprietary License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Provides-Extra: azure
 Provides-Extra: nexus
-Requires-Dist: adapta[azure,datadog,storage] (>=3.2,<4.0)
+Requires-Dist: adapta[datadog,storage] (>=3.3,<4.0)
 Requires-Dist: azure-identity (>=1.7,<1.8) ; extra == "azure"
 Requires-Dist: dataclasses-json (>=0.6.0,<0.7.0)
 Requires-Dist: httpx (>=0.27.0,<0.28.0) ; extra == "nexus"

{esd_services_api_client-2.6.0.dist-info → esd_services_api_client-2.6.1.dist-info}/RECORD

@@ -1,4 +1,4 @@
-esd_services_api_client/__init__.py,sha256=BBAYNMvljwWCMfrNwUz0XsUcC8i6XtJbMZus9tS5Fls,648
+esd_services_api_client/__init__.py,sha256=FJBUxZX7h17fr_sUs01bd-fSxy6eQ6zLaqD-pb5bvRo,648
 esd_services_api_client/beast/__init__.py,sha256=zNhXcHSP5w4P9quM1XP4oXVJEccvC_VScG41TZ0GzZ8,723
 esd_services_api_client/beast/v3/__init__.py,sha256=FtumtInoDyCCRE424Llqv8QZLRuwXzj-smyfu1od1nc,754
 esd_services_api_client/beast/v3/_connector.py,sha256=VqxiCzJWKERh42aZAIphzmOEG5cdOcKM0DQzG7eQ_-8,11479
@@ -7,19 +7,19 @@ esd_services_api_client/boxer/README.md,sha256=-MAhYUPvmEMcgx_lo_2PlH_gZI1lndGv8
 esd_services_api_client/boxer/__init__.py,sha256=yDEcfL-9q0H91UWr-al-1iMJtVLv-oIXky6hUmFZs0g,785
 esd_services_api_client/boxer/_auth.py,sha256=q9vU4agH-s6HPpVTEdkXFA_RvO92hogOfjurfjHBmBg,7445
 esd_services_api_client/boxer/_base.py,sha256=LMKDArELZlWVKJH10coUFSSN8MFH6KfHCBncEDjsiIU,981
-esd_services_api_client/boxer/_connector.py,sha256=gUplRNAxcOoZfMPee0ZUJmhbzYmreys9cMeIMHmIyKM,8677
+esd_services_api_client/boxer/_connector.py,sha256=UsZnAUSXT9BeUAU8eoezEaADrqz8ab-jSp4MVa-e3eM,8716
 esd_services_api_client/boxer/_models.py,sha256=ursQIR_c9jcVfRKc0LH1OuVL2KFD6kqojyGBadRfRPI,1702
 esd_services_api_client/common/__init__.py,sha256=L-cEW1mVbnTJLCLG5V6Ucw7zBgx1zf0t1bYcQC1heyw,603
 esd_services_api_client/crystal/__init__.py,sha256=oeyJjdQ9EpTnIq6XnjPq5v0DWPdHqi4uEfRIcD1mNZA,792
 esd_services_api_client/crystal/_api_versions.py,sha256=GHbmV_5lP9fP72TZE0j_ZeQSeJjMRcRaBRxNJbz-MWQ,837
 esd_services_api_client/crystal/_connector.py,sha256=0CqBpPahozAnentM6ZZrH84s_D7SoWCShr5_cRQGMX8,13110
 esd_services_api_client/crystal/_models.py,sha256=j8SEbwp_iAKjn06i-0f8npmhQhs2YJlmQ3eHwc2TwQE,4366
-esd_services_api_client/nexus/README.md,sha256=2-o9TeOYsVlUm72LsI6HUVaVx6ndYblRVDE7ncosYNQ,10032
+esd_services_api_client/nexus/README.md,sha256=hNFV_fzAGrG6_1yXE3o_GuLTKIWEia2FfedMh-Sg0ew,10619
 esd_services_api_client/nexus/__init__.py,sha256=sOgKKq3_LZGbLmQMtMS7lDw2hv027qownTmNIRV0BB8,627
 esd_services_api_client/nexus/abstractions/__init__.py,sha256=sOgKKq3_LZGbLmQMtMS7lDw2hv027qownTmNIRV0BB8,627
 esd_services_api_client/nexus/abstractions/algrorithm_cache.py,sha256=6GevJJ7mf1c_PImhKQ_4_6n652VyHlgK_12LNidirxs,3644
 esd_services_api_client/nexus/abstractions/input_object.py,sha256=RUKnhekuZwd_RVvnLGAxHa4wYDFJf6wEwWQI9f-o0lM,1761
-esd_services_api_client/nexus/abstractions/logger_factory.py,sha256=9biONvCqNrP__yrmeRkoDL05TMA5v-LyrcKwgiKG59U,2019
+esd_services_api_client/nexus/abstractions/logger_factory.py,sha256=oJStrOPir8J18E3ALhUTCQrj3rbjo2yuYrnjpDwLQg8,3947
 esd_services_api_client/nexus/abstractions/nexus_object.py,sha256=rLE42imCVGE6Px4Yu6X6C4b69gA1grK-7Md_SuCLN2Q,3115
 esd_services_api_client/nexus/abstractions/socket_provider.py,sha256=Rwa_aPErI4Es5AdyCd3EoGze7mg2D70u8kuc2UGEBaI,1729
 esd_services_api_client/nexus/algorithms/__init__.py,sha256=v4rPDf36r6AaHi_3K8isBKYU_fG8ct3w14KpUg2XRgg,976
@@ -32,8 +32,8 @@ esd_services_api_client/nexus/algorithms/recursive.py,sha256=uaCCl4q-st_KqbcmkdO
 esd_services_api_client/nexus/configurations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 esd_services_api_client/nexus/configurations/algorithm_configuration.py,sha256=eE7diX2PATCGkmqhvFOcZwXrr6vns4fqnJGmgNvhhZM,1091
 esd_services_api_client/nexus/core/__init__.py,sha256=sOgKKq3_LZGbLmQMtMS7lDw2hv027qownTmNIRV0BB8,627
-esd_services_api_client/nexus/core/app_core.py,sha256=JlVn8kkw26blK1FtqNtwNxkjKv9XLCFYAPAHUOzW5Mc,12986
-esd_services_api_client/nexus/core/app_dependencies.py,sha256=tA18Smbiv1HjgXnpCHnigrR2mTmIeZawPKxMH0pezIU,8615
+esd_services_api_client/nexus/core/app_core.py,sha256=Lmkpq7Hy74EfMOi5vtjD82PpY7Lb84RVbXN5b82BxKs,15462
+esd_services_api_client/nexus/core/app_dependencies.py,sha256=1m7Oc9JCXyrU0qVZekYhpbXLQo20aQPQ-Bf8zEdjtqI,8704
 esd_services_api_client/nexus/core/serializers.py,sha256=Vk9FaEeDHXx3S7rPlYoWzsOcN6gzLzemsrjq6ytfaI0,2217
 esd_services_api_client/nexus/exceptions/__init__.py,sha256=feN33VdqB5-2bD9aJesJl_OlsKrNNo3hZCnQgKuaU9k,696
 esd_services_api_client/nexus/exceptions/_nexus_error.py,sha256=QvtY38mNoIA6t26dUN6UIsaPfljhtVNsbQVS7ksMb-Q,895
@@ -50,7 +50,7 @@ esd_services_api_client/nexus/modules/mlflow_module.py,sha256=d4y8XetGF37md4dEpE
 esd_services_api_client/nexus/telemetry/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 esd_services_api_client/nexus/telemetry/recorder.py,sha256=-shxk2vYDTafJ0U3CzkHxIHBQtxVJ1ZNI4ST0p1YV2g,4801
 esd_services_api_client/nexus/telemetry/user_telemetry_recorder.py,sha256=NgnjSY64nEx1kslkdomENC6vMqkEOpfXggJXwm-NyFs,5163
-esd_services_api_client-2.6.0.dist-info/LICENSE,sha256=0gS6zXsPp8qZhzi1xaGCIYPzb_0e8on7HCeFJe8fOpw,10693
-esd_services_api_client-2.6.0.dist-info/METADATA,sha256=9vAceRIDIKylVuNKpmSDzMmovD3cf6QoNoh4Z627sGw,1164
-esd_services_api_client-2.6.0.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
-esd_services_api_client-2.6.0.dist-info/RECORD,,
+esd_services_api_client-2.6.1.dist-info/LICENSE,sha256=0gS6zXsPp8qZhzi1xaGCIYPzb_0e8on7HCeFJe8fOpw,10693
+esd_services_api_client-2.6.1.dist-info/METADATA,sha256=Y893K15f-VzKzAKxxs66BGwf8sCkGvMHe0hm_T3VL6Y,1058
+esd_services_api_client-2.6.1.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
+esd_services_api_client-2.6.1.dist-info/RECORD,,