maleo-foundation 0.0.86__py3-none-any.whl → 0.0.88__py3-none-any.whl

maleo_foundation/utils/logging.py

@@ -0,0 +1,182 @@
+import logging
+import os
+from datetime import datetime
+from google.auth import default
+from google.cloud.logging import Client
+from google.cloud.logging.handlers import CloudLoggingHandler
+from google.oauth2 import service_account
+from typing import Optional
+from maleo_foundation.enums import BaseEnums
+from maleo_foundation.types import BaseTypes
+
+class GoogleCloudLogging:
+    def __init__(self, google_credentials_path:BaseTypes.OptionalString = None) -> None:
+        google_credentials_path = google_credentials_path or os.getenv("GOOGLE_CREDENTIALS_PATH")
+        try:
+            if google_credentials_path is not None:
+                self._credentials = service_account.Credentials.from_service_account_file(filename=google_credentials_path)
+            else:
+                self._credentials, _ = default()
+        except Exception as e:
+            raise ValueError(f"Failed to initialize credentials: {str(e)}")
+        self._client = Client(credentials=self._credentials)
+        self._client.setup_logging()
+
+    @property
+    def credentials(self) -> service_account.Credentials:
+        return self._credentials
+
+    @property
+    def client(self) -> Client:
+        return self._client
+
+    def dispose(self) -> None:
+        if self._credentials is not None:
+            self._credentials = None
+        if self._client is not None:
+            self._client = None
+
+    def create_handler(self, name:str) -> CloudLoggingHandler:
+        return CloudLoggingHandler(client=self._client, name=name)
+
+class BaseLogger(logging.Logger):
+    def __init__(
+        self,
+        logs_dir:str,
+        type:BaseEnums.LoggerType,
+        service_key:BaseTypes.OptionalString = None,
+        client_key:BaseTypes.OptionalString = None,
+        level:BaseEnums.LoggerLevel = BaseEnums.LoggerLevel.INFO,
+        google_cloud_logging:Optional[GoogleCloudLogging] = None
+    ):
+        """
+        Custom extended logger with file, console, and Google Cloud Logging.
+
+        - Logs are stored in `logs_dir/logs/{type}`
+        - Uses Google Cloud Logging if configured
+
+        Args:
+            logs_dir (str): Base directory for logs (e.g., "/path/to/service")
+            type (str): Log type (e.g., "application", "middleware")
+            service_key (str): The service name (e.g., "service")
+        """
+        self._type = type #* Declare logger type
+
+        #* Ensure service_key exists
+        self._service_key = service_key or os.getenv("SERVICE_NAME")
+        if self._service_key is None:
+            raise ValueError("SERVICE_NAME environment variable must be set if 'service_key' is set to None")
+
+        self._client_key = client_key #* Declare client key
+
+        #* Ensure client_key is valid if logger type is a client
+        if self._type == BaseEnums.LoggerType.CLIENT and self._client_key is None:
+            raise ValueError("'client_key' parameter must be provided if 'logger_type' is 'client'")
+
+        #* Define logger name
+        if self._type == BaseEnums.LoggerType.CLIENT:
+            self._name = f"{self._service_key} - {self._type} - {self._client_key}"
+        else:
+            self._name = f"{self._service_key} - {self._type}"
+
+        super().__init__(self._name, level) #* Init the superclass's logger
+
+        #* Clear existing handlers to prevent duplicates
+        for handler in list(self.handlers):
+            self.removeHandler(handler)
+            handler.close()
+
+        #* Formatter for logs
+        formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
+
+        #* Console handler
+        console_handler = logging.StreamHandler()
+        console_handler.setFormatter(formatter)
+        self.addHandler(console_handler)
+
+        #* Google Cloud Logging handler (If enabled)
+        if google_cloud_logging is not None:
+            cloud_logging_handler = google_cloud_logging.create_handler(name=self._name)
+            self.addHandler(cloud_logging_handler)
+        else:
+            self.info("Cloud logging is not configured.")
+
+        #* Define log directory
+        if self._type == BaseEnums.LoggerType.CLIENT:
+            log_dir = f"logs/{self._type}/{self._client_key}"
+        else:
+            log_dir = f"logs/{self._type}"
+        self._log_dir = os.path.join(logs_dir, log_dir)
+        os.makedirs(self._log_dir, exist_ok=True)
+
+        #* Generate timestamped filename
+        timestamp = datetime.now().strftime("%Y-%m-%d_%H-%M-%S")
+        log_filename = os.path.join(self._log_dir, f"{timestamp}.log")
+
+        #* File handler
+        file_handler = logging.FileHandler(log_filename, mode="a")
+        file_handler.setFormatter(formatter)
+        self.addHandler(file_handler)
+
+    @property
+    def type(self) -> str:
+        return self._type
+
+    @property
+    def service(self) -> str:
+        return self._service_key
+
+    @property
+    def client(self) -> str:
+        raise NotImplementedError()
+
+    @property
+    def name(self) -> str:
+        return self._name
+
+    @property
+    def location(self) -> str:
+        return self._log_dir
+
+    def dispose(self):
+        """Dispose of the logger by removing all handlers."""
+        for handler in list(self.handlers):
+            self.removeHandler(handler)
+            handler.close()
+        self.handlers.clear()
+
+class ServiceLogger(BaseLogger):
+    def __init__(
+        self,
+        logs_dir:str,
+        type:BaseEnums.ServiceLoggerType,
+        service_key:BaseTypes.OptionalString = None,
+        level:BaseEnums.LoggerLevel = BaseEnums.LoggerLevel.INFO,
+        google_cloud_logging:Optional[GoogleCloudLogging] = None
+    ):
+        super().__init__(
+            logs_dir=logs_dir,
+            type=type,
+            service_key=service_key,
+            client_key=None,
+            level=level,
+            google_cloud_logging=google_cloud_logging
+        )
+
+class ClientLogger(BaseLogger):
+    def __init__(
+        self,
+        logs_dir:str,
+        client_key:str,
+        service_key:BaseTypes.OptionalString = None,
+        level:BaseEnums.LoggerLevel = BaseEnums.LoggerLevel.INFO,
+        google_cloud_logging:Optional[GoogleCloudLogging] = None
+    ):
+        super().__init__(
+            logs_dir=logs_dir,
+            type=BaseEnums.LoggerType.CLIENT,
+            service_key=service_key,
+            client_key=client_key,
+            level=level,
+            google_cloud_logging=google_cloud_logging
+        )

{maleo_foundation-0.0.86.dist-info → maleo_foundation-0.0.88.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: maleo_foundation
-Version: 0.0.86
+Version: 0.0.88
 Summary: Foundation package for Maleo
 Author-email: Agra Bima Yuda <agra@nexmedis.com>
 License: MIT

{maleo_foundation-0.0.86.dist-info → maleo_foundation-0.0.88.dist-info}/RECORD

@@ -1,22 +1,26 @@
 maleo_foundation/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 maleo_foundation/constants.py,sha256=aBmEfWlBqZxi0k-n6h2NM1YRLOjMnheEiLyQcjP-zCQ,1164
-maleo_foundation/enums.py,sha256=8R-0ysAUvC7OlsEZXqQ_sqDy8MLM85c2MmEgSx3IQbw,2523
+maleo_foundation/enums.py,sha256=mhLidFNxo89ZlmfJptB7dNqX7Q_7H9jVS8tvUyp_jQg,2748
 maleo_foundation/extended_types.py,sha256=pIKt-_9tby4rmune3fmWcCW_mohaNRh_1lywBmdc-L4,301
 maleo_foundation/types.py,sha256=aKXnIgEhYGSfFqNMGLc4qIKGkINBRpkOo9R9cb2CbwI,2414
 maleo_foundation/clients/__init__.py,sha256=W8vydJYeDEi6gdmOZSBFSSDsfZJtb8C05CHErZgsZ30,188
 maleo_foundation/clients/general/__init__.py,sha256=l9eQrBeLW4aXtGU5aK3i6fD-msVR4526W7D9V8WCXIg,91
 maleo_foundation/clients/general/http.py,sha256=pObW6EaMeLDNsRZ9QJPzfhZDzcZ33kCsb-9Yfoh2MA4,1670
 maleo_foundation/clients/google/__init__.py,sha256=1uv6nF9QbATsSAcMimQOT7Y-eBljjDunBojNX6oAtS8,90
+maleo_foundation/clients/google/base.py,sha256=tdiqNNtvy-Ev_L7R4Dg9y7V14QdlbfCOQ2Mulo238aE,1141
+maleo_foundation/clients/google/secret.py,sha256=4k3pDs4HAibeCEgv8nUBADfhk2aftG9L1sfR3UxAyfE,2516
+maleo_foundation/clients/google/storage.py,sha256=smsmrjKAyxtfdqz3EzuUVx_rQeaTaYZ5VKNWCvwQ4U8,1971
 maleo_foundation/clients/google/cloud/__init__.py,sha256=WGMPxEKKdkz3XGY5dZn9E-nYhD1kv1MgRHbmVnky4zk,245
-maleo_foundation/clients/google/cloud/logging.py,sha256=b-q6Mhlt2Vl5HBh-YXeEEfGu1TMFK_XIJa55haMvkpA,1552
-maleo_foundation/clients/google/cloud/secret.py,sha256=cFewA-EYsAaEfxc2G2XGzwHreW1FgyCK6MpwOARE24M,3452
-maleo_foundation/clients/google/cloud/storage.py,sha256=y_HAsbcGSnu5sxZPxaQWFWvOlF3vEcqkej2834OgAS0,2617
+maleo_foundation/clients/google/cloud/base.py,sha256=V_5Zdu90FQLgAfUZvlB1KojFzXNKZNIR516gjDXgaPU,1146
+maleo_foundation/clients/google/cloud/logging.py,sha256=s9T9bex0GeCPwIHrBRvilT23iyNKqJ5z50KcT76Jt5Y,2202
+maleo_foundation/clients/google/cloud/secret.py,sha256=1dua0V2FHesjltLdc1N4PF8xTXPzmcSA3sgwBzYNUtM,5853
+maleo_foundation/clients/google/cloud/storage.py,sha256=t8hAZiQj_RFhJJXE8a20WP7spNKTEFw1RK1AqurL3T8,3848
 maleo_foundation/clients/utils/__init__.py,sha256=hChEGABHH4tOFxPRcpxmlhkM9PgF18M7wXapH88hpu4,131
 maleo_foundation/clients/utils/logger.py,sha256=FMnHKV4i6xR6e8XN7kCNwTf1jhSLdJUIO7teSm5g0D4,1829
 maleo_foundation/db/__init__.py,sha256=fmvhCz4_siHfyKJujcUakKDKmuLxMhxn2w5tmfQwfcM,135
-maleo_foundation/db/engine.py,sha256=kw2SMMiWy5KARquh4TLk7v6HwlHW97lUIUvqdFbhNxk,1600
-maleo_foundation/db/manager.py,sha256=czs-6czNvKHZ7zWRX1nPpKJcdsadyX8R2DnZlA_6mlk,500
-maleo_foundation/db/session.py,sha256=tI13DJ6rLo8FOpSIFZrmD4dbuxY_c0RTjwEGb76ZOo0,2681
+maleo_foundation/db/engine.py,sha256=hhYjCt5IEb864H2RNlUVS7GfMzuThHKRV260Bgkhn_o,3003
+maleo_foundation/db/manager.py,sha256=nSstMJ9JBoEKTSLlz6MNf4Wuet8DLp2Pipfveg4kM1c,4663
+maleo_foundation/db/session.py,sha256=6flx_HVh4Fe3EohK2xDcyXmVAPOci1KFvhVK4wFcKtA,4736
 maleo_foundation/db/table.py,sha256=Dk5GXeO0gbBBPN2PJtZhlUx2x3vMbT4dxTBc3YLBbuc,1199
 maleo_foundation/expanded_types/__init__.py,sha256=lm_r7rxlLA0sgSTGQBMR9ZbZbVDpD7Te-UYb3oRVi1g,364
 maleo_foundation/expanded_types/client.py,sha256=To0kRXp3QTmuSu5rWKaCiTsMK9qkYiyYKYbHfw-y1fY,2396
@@ -24,6 +28,16 @@ maleo_foundation/expanded_types/general.py,sha256=bjIBREYTS73tvS-Key7P7db82a2HHl
 maleo_foundation/expanded_types/query.py,sha256=0yUG-JIVsanzB7KAkrRz_OsrhP6J0bRqD9Q3l3atQnk,2384
 maleo_foundation/expanded_types/service.py,sha256=q8jpKdbCbLWwH1UPQavKpVE14rC5rveduk2cFWzuhGw,2416
 maleo_foundation/expanded_types/token.py,sha256=4fRTJw6W5MYq71NksNrWNi7qYHQ4_lQwfu9WxwrMipc,355
+maleo_foundation/managers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+maleo_foundation/managers/db.py,sha256=FWfkOChi1nBqNzzHfY1yisYWrsyg4eYVZ5qDP99yLOI,4628
+maleo_foundation/managers/service.py,sha256=N0IZrHAa7aFPdrLiz3NXPLlmyCCcetjbYXS-qQe-ayw,10669
+maleo_foundation/managers/client/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+maleo_foundation/managers/client/base.py,sha256=lFn3B4SKjZfpeb9aYFY1iyut9juNM6l91yHXoqntPhM,949
+maleo_foundation/managers/client/http.py,sha256=gAPEpIyA4XzEpToxZGPj6HAuK9VwdoSG54lR8OoVK1c,1374
+maleo_foundation/managers/client/google/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+maleo_foundation/managers/client/google/base.py,sha256=1lrGoyGnYW5Xq05bVXbKqnsqqmFPnsqZCBPK5-DINDA,1037
+maleo_foundation/managers/client/google/secret.py,sha256=T3EOSgolTaGXeLI-uYRoOWM-JU3zUhAPk8k4NZE4AmQ,2877
+maleo_foundation/managers/client/google/storage.py,sha256=NunBBAVNg2DaPzDhlVC6a3PLa2jYdNvZEr8FNeriJOo,2155
 maleo_foundation/middlewares/__init__.py,sha256=bqE2EIFC3rWcR2AwFPR0fk2kSFfeTRzgA24GbnuT5RA,3697
 maleo_foundation/middlewares/base.py,sha256=KcpODNs0DQXX8Cwc6T9dC6aiZIqxTLtuJjVAGWXPSKk,11633
 maleo_foundation/middlewares/cors.py,sha256=9uvBvY2N6Vxa9RP_YtESxcWo6Doi6uS0lzAG9iLY7Uc,2288
@@ -36,7 +50,7 @@ maleo_foundation/models/schemas/result.py,sha256=V3dljS2AdtWW4Pf8YsnQuiCylN1bZtE
 maleo_foundation/models/schemas/token.py,sha256=u71kPXJyCxqn_INK05MSNFhQr9MaLfQM-icYc536xik,551
 maleo_foundation/models/transfers/__init__.py,sha256=oJLJ3Geeme6vBw7R2Dhvdvg4ziVvzEYAGJaP-tm_90w,299
 maleo_foundation/models/transfers/general/__init__.py,sha256=0yW67vJvKgJmZ9htteOVatG7mb-YEpHF62dpwH2g_Bk,146
-maleo_foundation/models/transfers/general/token.py,sha256=FrXIVgVBwOPTsri271WAkq54Sqa8WSzY75BzsNq2P6k,2411
+maleo_foundation/models/transfers/general/token.py,sha256=ZbWIPU0WUFr9ReHOqjRuD1CFie2v206tJNFRcDGQvU4,2411
 maleo_foundation/models/transfers/parameters/__init__.py,sha256=oKW4RPIEISISRjsJzD8lsCGY1HhZRTzshPpWHcJu86k,353
 maleo_foundation/models/transfers/parameters/client.py,sha256=tn_Hwa-k-Utp5rODe7GylqZB8djIKKupgkUFscYCyLc,4059
 maleo_foundation/models/transfers/parameters/general.py,sha256=WoekZJCIoAllhXdRIJkNRdNq0QEIn0bteiHJLtzkCxU,579
@@ -54,16 +68,17 @@ maleo_foundation/models/transfers/results/service/query.py,sha256=G5A4FRkHyRRlpu
 maleo_foundation/models/transfers/results/service/controllers/__init__.py,sha256=HZJWMy2dskzOCzLmp_UaL9rjbQ-sDMI7sd2bXb-4QOU,175
 maleo_foundation/models/transfers/results/service/controllers/rest.py,sha256=wCuFyOTQkuBs2cqjPsWnPy0XIsCfMqGByhrSy57qp7Y,1107
 maleo_foundation/services/__init__.py,sha256=Ho5zJSA89xdGFKIwOdzjmd8sm23cIuwrqYAxCEBBTIU,120
-maleo_foundation/services/token.py,sha256=mULGv3wEeeFdNtk0k5pY3g7htFQM9EZBI1QIJdjfLy8,2348
+maleo_foundation/services/token.py,sha256=sDwgiE_v-s6lQHQv9xtB0zMOGcCKMvdk_Gcm22LV97o,2376
 maleo_foundation/utils/__init__.py,sha256=FavmL5XYGCm955EAKiWWcXYeU15p5rSzfcglpV2yI6c,387
 maleo_foundation/utils/controller.py,sha256=ECzPzpw36zBAjKcWcDbUAhIJGbc6UpeypdUUX6ipXBg,6396
 maleo_foundation/utils/exceptions.py,sha256=nk3rD57fDR-D7BQkU1JEKV-Mu7FGMpLSEsqxdDZdKjU,4532
 maleo_foundation/utils/keyloader.py,sha256=g7LYypj7UolmSgHRGXMFgVaWr55UayMdtKXR5NmB7VM,2341
-maleo_foundation/utils/logger.py,sha256=978P57JOhGR-WIu7xdPXBIwd3JrfLLA8WerVzxhE_Fs,3408
+maleo_foundation/utils/logger.py,sha256=uTvzzKnGjbxRVLHbiMDw2zKKWNaCwV35sxgjDStEwNQ,3569
+maleo_foundation/utils/logging.py,sha256=7TIxwaKBQbY6YcjXZIBKs0qySbTRSK7VxWgjMvNkVEQ,6410
 maleo_foundation/utils/query.py,sha256=ODQ3adOYQNj5E2cRW9ytbjBz56nEDcnfq8mQ6YZbCCM,4375
 maleo_foundation/utils/formatter/__init__.py,sha256=iKf5YCbEdg1qKnFHyKqqcQbqAqEeRUf8mhI3v3dQoj8,78
 maleo_foundation/utils/formatter/case.py,sha256=TmvvlfzGdC_omMTB5vAa40TZBxQ3hnr-SYeo0M52Rlg,1352
-maleo_foundation-0.0.86.dist-info/METADATA,sha256=_f6U5Q82bD9p78MtcCdXQ-NjdGo8uVL6czk_ZQM0688,3190
-maleo_foundation-0.0.86.dist-info/WHEEL,sha256=ck4Vq1_RXyvS4Jt6SI0Vz6fyVs4GWg7AINwpsaGEgPE,91
-maleo_foundation-0.0.86.dist-info/top_level.txt,sha256=_iBos3F_bhEOdjOnzeiEYSrCucasc810xXtLBXI8cQc,17
-maleo_foundation-0.0.86.dist-info/RECORD,,
+maleo_foundation-0.0.88.dist-info/METADATA,sha256=x08I-4MffCYEkKnW5SU9nRlVPyyu6_APsfQgZzljxVo,3190
+maleo_foundation-0.0.88.dist-info/WHEEL,sha256=wXxTzcEDnjrTwFYjLPcsW_7_XihufBwmpiBeiXNBGEA,91
+maleo_foundation-0.0.88.dist-info/top_level.txt,sha256=_iBos3F_bhEOdjOnzeiEYSrCucasc810xXtLBXI8cQc,17
+maleo_foundation-0.0.88.dist-info/RECORD,,

{maleo_foundation-0.0.86.dist-info → maleo_foundation-0.0.88.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.0.0)
+Generator: setuptools (80.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any