beans-logging-fastapi 7.0.0__tar.gz → 8.0.0__tar.gz

{beans_logging_fastapi-7.0.0/src/beans_logging_fastapi.egg-info → beans_logging_fastapi-8.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: beans_logging_fastapi
-Version: 7.0.0
+Version: 8.0.0
 Summary: This is a HTTP access log module for FastAPI based on 'beans-logging' package.
 Author-email: Batkhuu Byambajav <batkhuu10@gmail.com>
 Project-URL: Homepage, https://github.com/bybatkhuu/module-fastapi-logging
@@ -170,15 +170,7 @@ logger:
   app_name: "fastapi-app"
   level:
     base: TRACE
-  default_format: "[{time:YYYY-MM-DD HH:mm:ss.SSS Z} | {extra[level_short]:<5} | {name}:{line} | {extra[request_id]}]: {message}"
   http:
-    std:
-      msg_format_str: '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}" {status_code} {content_length}B {response_time}ms'
-      err_msg_format_str: '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}" <n>{status_code}</n>'
-      debug_msg_format_str: '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}"'
-    file:
-      format_str: '{client_host} {request_id} {user_id} [{datetime}] "{method} {url_path} HTTP/{http_version}" {status_code} {content_length} "{h_referer}" "{h_user_agent}" {response_time}'
-      tz: "localtime"
     has_proxy_headers: false
     has_cf_headers: false
   intercept:
@@ -186,10 +178,8 @@ logger:
   handlers:
     std_handler:
       enabled: true
-      format: "[<c>{time:YYYY-MM-DD HH:mm:ss.SSS Z}</c> | <level>{extra[level_short]:<5}</level> | <w>{extra[request_id]}</w> | <w>{name}:{line}</w>]: <level>{message}</level>"
     http_access_std_handler:
       enabled: true
-      format: "[<c>{time:YYYY-MM-DD HH:mm:ss.SSS Z}</c> | <level>{extra[level_short]:<5}</level> | <w>{extra[request_id]}</w>]: <level>{message}</level>"
     http_access_file_handler:
       enabled: true
       sink: "http/{app_name}.http-access.log"
@@ -202,6 +192,7 @@ logger:
     http_err_json_handler:
       enabled: true
       sink: "http.json/{app_name}.http-err.json.log"
+
 ```
 
 [**`.env`**](./examples/.env):
@@ -255,14 +246,17 @@ __all__ = [
 
 ```python
 from pydantic import validate_call
-from fastapi import FastAPI, APIRouter, HTTPException
+from fastapi import FastAPI, APIRouter, HTTPException, Request
 from fastapi.responses import RedirectResponse
 
 router = APIRouter()
 
 
 @router.get("/")
-def root():
+def root(request: Request):
+    _logger = request.state.logger
+    _logger.info("Root endpoint accessed.")
+
     return {"Hello": "World"}
 
 
@@ -452,7 +446,7 @@ logger:
   level:
     base: INFO
     err: WARNING
-  format_str: "[{time:YYYY-MM-DD HH:mm:ss.SSS Z} | {extra[level_short]:<5} | {name}:{line} | {extra[request_id]}]: {message}"
+  default_format: "[{time:YYYY-MM-DD HH:mm:ss.SSS Z} | {extra[level_short]:<5} | {name}:{line} {extra[request_id]}]: {message}"
   file:
     logs_dir: "./logs"
     rotate_size: 10000000
@@ -462,11 +456,11 @@ logger:
   custom_serialize: false
   http:
     std:
-      msg_format_str: '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}" {status_code} {content_length}B {response_time}ms'
-      err_msg_format_str: '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}" <n>{status_code}</n>'
-      debug_msg_format_str: '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}"'
+      sub_format: '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}" {status_code} {content_length}B {response_time}ms'
+      err_sub_format: '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}" <n>{status_code}</n>'
+      debug_sub_format: '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}"'
     file:
-      format_str: '{client_host} {request_id} {user_id} [{datetime}] "{method} {url_path} HTTP/{http_version}" {status_code} {content_length} "{h_referer}" "{h_user_agent}" {response_time}'
+      format_: '{client_host} {request_id} {user_id} [{datetime}] "{method} {url_path} HTTP/{http_version}" {status_code} {content_length} "{h_referer}" "{h_user_agent}" {response_time}'
       tz: localtime
     has_proxy_headers: true
     has_cf_headers: true
@@ -477,14 +471,14 @@ logger:
     include_modules: []
     mute_modules: [uvicorn.access]
   global_extra:
-    trace_id: "-"
-    request_id: "-"
-    user_id: "-"
+    trace_id: ""
+    request_id: ""
+    user_id: ""
   handlers:
     std_handler:
       enabled: true
       type_: STD
-      format: "[<c>{time:YYYY-MM-DD HH:mm:ss.SSS Z}</c> | <level>{extra[level_short]:<5}</level> | <w>{extra[request_id]}</w> | <w>{name}:{line}</w>]: <level>{message}</level>"
+      format: "[<c>{time:YYYY-MM-DD HH:mm:ss.SSS Z}</c> | <level>{extra[level_short]:<5}</level> | <w>{name}:{line}</w> <d><w>{extra[request_id]}</w></d>]: <level>{message}</level>"
       colorize: true
     file_handler:
       enabled: true
@@ -509,7 +503,7 @@ logger:
     http_access_std_handler:
       enabled: true
       type_: STD
-      format: "[<c>{time:YYYY-MM-DD HH:mm:ss.SSS Z}</c> | <level>{extra[level_short]:<5}</level> | <w>{extra[request_id]}</w>]: <level>{message}</level>"
+      format: "[<c>{time:YYYY-MM-DD HH:mm:ss.SSS Z}</c> | <level>{extra[level_short]:<5}</level> | <d><w>{extra[request_id]}</w></d>]: <level>{message}</level>"
       colorize: true
     http_access_file_handler:
       enabled: true

{beans_logging_fastapi-7.0.0 → beans_logging_fastapi-8.0.0}/README.md

@@ -108,15 +108,7 @@ logger:
   app_name: "fastapi-app"
   level:
     base: TRACE
-  default_format: "[{time:YYYY-MM-DD HH:mm:ss.SSS Z} | {extra[level_short]:<5} | {name}:{line} | {extra[request_id]}]: {message}"
   http:
-    std:
-      msg_format_str: '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}" {status_code} {content_length}B {response_time}ms'
-      err_msg_format_str: '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}" <n>{status_code}</n>'
-      debug_msg_format_str: '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}"'
-    file:
-      format_str: '{client_host} {request_id} {user_id} [{datetime}] "{method} {url_path} HTTP/{http_version}" {status_code} {content_length} "{h_referer}" "{h_user_agent}" {response_time}'
-      tz: "localtime"
     has_proxy_headers: false
     has_cf_headers: false
   intercept:
@@ -124,10 +116,8 @@ logger:
   handlers:
     std_handler:
       enabled: true
-      format: "[<c>{time:YYYY-MM-DD HH:mm:ss.SSS Z}</c> | <level>{extra[level_short]:<5}</level> | <w>{extra[request_id]}</w> | <w>{name}:{line}</w>]: <level>{message}</level>"
     http_access_std_handler:
       enabled: true
-      format: "[<c>{time:YYYY-MM-DD HH:mm:ss.SSS Z}</c> | <level>{extra[level_short]:<5}</level> | <w>{extra[request_id]}</w>]: <level>{message}</level>"
     http_access_file_handler:
       enabled: true
       sink: "http/{app_name}.http-access.log"
@@ -140,6 +130,7 @@ logger:
     http_err_json_handler:
       enabled: true
       sink: "http.json/{app_name}.http-err.json.log"
+
 ```
 
 [**`.env`**](./examples/.env):
@@ -193,14 +184,17 @@ __all__ = [
 
 ```python
 from pydantic import validate_call
-from fastapi import FastAPI, APIRouter, HTTPException
+from fastapi import FastAPI, APIRouter, HTTPException, Request
 from fastapi.responses import RedirectResponse
 
 router = APIRouter()
 
 
 @router.get("/")
-def root():
+def root(request: Request):
+    _logger = request.state.logger
+    _logger.info("Root endpoint accessed.")
+
     return {"Hello": "World"}
 
 
@@ -390,7 +384,7 @@ logger:
   level:
     base: INFO
     err: WARNING
-  format_str: "[{time:YYYY-MM-DD HH:mm:ss.SSS Z} | {extra[level_short]:<5} | {name}:{line} | {extra[request_id]}]: {message}"
+  default_format: "[{time:YYYY-MM-DD HH:mm:ss.SSS Z} | {extra[level_short]:<5} | {name}:{line} {extra[request_id]}]: {message}"
   file:
     logs_dir: "./logs"
     rotate_size: 10000000
@@ -400,11 +394,11 @@ logger:
   custom_serialize: false
   http:
     std:
-      msg_format_str: '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}" {status_code} {content_length}B {response_time}ms'
-      err_msg_format_str: '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}" <n>{status_code}</n>'
-      debug_msg_format_str: '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}"'
+      sub_format: '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}" {status_code} {content_length}B {response_time}ms'
+      err_sub_format: '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}" <n>{status_code}</n>'
+      debug_sub_format: '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}"'
     file:
-      format_str: '{client_host} {request_id} {user_id} [{datetime}] "{method} {url_path} HTTP/{http_version}" {status_code} {content_length} "{h_referer}" "{h_user_agent}" {response_time}'
+      format_: '{client_host} {request_id} {user_id} [{datetime}] "{method} {url_path} HTTP/{http_version}" {status_code} {content_length} "{h_referer}" "{h_user_agent}" {response_time}'
       tz: localtime
     has_proxy_headers: true
     has_cf_headers: true
@@ -415,14 +409,14 @@ logger:
     include_modules: []
     mute_modules: [uvicorn.access]
   global_extra:
-    trace_id: "-"
-    request_id: "-"
-    user_id: "-"
+    trace_id: ""
+    request_id: ""
+    user_id: ""
   handlers:
     std_handler:
       enabled: true
       type_: STD
-      format: "[<c>{time:YYYY-MM-DD HH:mm:ss.SSS Z}</c> | <level>{extra[level_short]:<5}</level> | <w>{extra[request_id]}</w> | <w>{name}:{line}</w>]: <level>{message}</level>"
+      format: "[<c>{time:YYYY-MM-DD HH:mm:ss.SSS Z}</c> | <level>{extra[level_short]:<5}</level> | <w>{name}:{line}</w> <d><w>{extra[request_id]}</w></d>]: <level>{message}</level>"
       colorize: true
     file_handler:
       enabled: true
@@ -447,7 +441,7 @@ logger:
     http_access_std_handler:
       enabled: true
       type_: STD
-      format: "[<c>{time:YYYY-MM-DD HH:mm:ss.SSS Z}</c> | <level>{extra[level_short]:<5}</level> | <w>{extra[request_id]}</w>]: <level>{message}</level>"
+      format: "[<c>{time:YYYY-MM-DD HH:mm:ss.SSS Z}</c> | <level>{extra[level_short]:<5}</level> | <d><w>{extra[request_id]}</w></d>]: <level>{message}</level>"
       colorize: true
     http_access_file_handler:
       enabled: true

{beans_logging_fastapi-7.0.0 → beans_logging_fastapi-8.0.0}/src/beans_logging_fastapi/__init__.py

@@ -1,4 +1,4 @@
-from beans_logging import logger, LogLevelEnum, log_at
+from beans_logging import Logger, logger, LogLevelEnum, log_at
 
 from .__version__ import __version__
 from .config import LoggerConfigPM
@@ -8,6 +8,7 @@ from .mode import async_log_at
 
 __all__ = [
     "__version__",
+    "Logger",
     "logger",
     "LogLevelEnum",
     "add_logger",

beans_logging_fastapi-8.0.0/src/beans_logging_fastapi/__version__.py

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

{beans_logging_fastapi-7.0.0 → beans_logging_fastapi-8.0.0}/src/beans_logging_fastapi/_core.py

@@ -57,8 +57,8 @@ def add_logger(
     app.add_middleware(ResponseHTTPInfoMiddleware)
     app.add_middleware(
         HttpAccessLogMiddleware,
-        debug_msg_format_str=config.http.std.debug_msg_format_str,
-        msg_format_str=config.http.std.msg_format_str,
+        debug_sub_format=config.http.std.debug_sub_format,
+        sub_format=config.http.std.sub_format,
     )
     app.add_middleware(
         RequestHTTPInfoMiddleware,
@@ -75,7 +75,7 @@ def add_logger(
             _handler.filter_ = http_all_file_filter
             _handler.format_ = lambda record: http_file_format(
                 record=record,
-                format_str=config.http.file.format_str,
+                format_=config.http.file.format_,
                 tz=config.http.file.tz,
             )
         elif (_name == HTTP_ACCESS_JSON_HANDLER_NAME) or (

{beans_logging_fastapi-7.0.0 → beans_logging_fastapi-8.0.0}/src/beans_logging_fastapi/config.py

@@ -8,7 +8,7 @@ from beans_logging.constants import (
     DEFAULT_HANDLER_NAMES,
     DEFAULT_STD_HANDLER_NAME,
 )
-from beans_logging.schemas import LogHandlerPM
+from beans_logging.schemas import LogHandlerPM, FormatType
 from beans_logging.config import (
     get_default_handlers as get_base_handlers,
     ExtraBaseModel,
@@ -23,6 +23,7 @@ from .constants import (
     HTTP_ACCESS_JSON_HANDLER_NAME,
     HTTP_ERR_JSON_HANDLER_NAME,
 )
+from .formats import id_std_format, id_file_format
 
 
 def get_default_handlers() -> dict[str, LogHandlerPM]:
@@ -38,17 +39,18 @@ def get_default_handlers() -> dict[str, LogHandlerPM]:
             _handler.enabled = True
 
         if _name == DEFAULT_STD_HANDLER_NAME:
-            _handler.format_ = (
-                "[<c>{time:YYYY-MM-DD HH:mm:ss.SSS Z}</c> | <level>{extra[level_short]:<5}</level> | "
-                "<w>{extra[request_id]}</w> | <w>{name}:{line}</w>]: <level>{message}</level>"
-            )
+            _handler.format_ = id_std_format
+            # _handler.format_ = (
+            #     "[<c>{time:YYYY-MM-DD HH:mm:ss.SSS Z}</c> | <level>{extra[level_short]:<5}</level> | "
+            #     "<w>{name}:{line}</w> <d><w>{extra[request_id]}</w></d>]: <level>{message}</level>"
+            # )
 
     _http_handlers: dict[str, LogHandlerPM] = {
         HTTP_ACCESS_STD_HANDLER_NAME: LogHandlerPM(
             type_=LogHandlerTypeEnum.STD,
             format_=(
                 "[<c>{time:YYYY-MM-DD HH:mm:ss.SSS Z}</c> | <level>{extra[level_short]:<5}</level> | "
-                "<w>{extra[request_id]}</w>]: <level>{message}</level>"
+                "<d><w>{extra[request_id]}</w></d>]: <level>{message}</level>"
             ),
             colorize=True,
         ),
@@ -81,57 +83,54 @@ def get_default_intercept() -> InterceptConfigPM:
     return _default_intercept
 
 
-class StdConfigPM(ExtraBaseModel):
-    msg_format_str: str = Field(
+class HttpStdConfigPM(ExtraBaseModel):
+    sub_format: str = Field(
         default=(
-            '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}"'
-            " {status_code} {content_length}B {response_time}ms"
+            '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}" '
+            "{status_code} {content_length}B {response_time}ms"
         ),
         min_length=8,
         max_length=512,
     )
-    err_msg_format_str: str = Field(
+    err_sub_format: str = Field(
         default=(
-            '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}"'
-            " <n>{status_code}</n>"
+            '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}" '
+            "<n>{status_code}</n>"
         ),
         min_length=8,
         max_length=512,
     )
-    debug_msg_format_str: str = Field(
+    debug_sub_format: str = Field(
         default='{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}"',
         min_length=8,
         max_length=512,
     )
 
 
-class FileConfigPM(ExtraBaseModel):
-    format_str: str = Field(
+class HttpFileConfigPM(ExtraBaseModel):
+    format_: str = Field(
         default=(
-            '{client_host} {request_id} {user_id} [{datetime}] "{method} {url_path} HTTP/{http_version}"'
-            ' {status_code} {content_length} "{h_referer}" "{h_user_agent}" {response_time}'
-        ),
-        min_length=8,
-        max_length=512,
+            '{client_host} {request_id} {user_id} [{datetime}] "{method} {url_path} HTTP/{http_version}" '
+            '{status_code} {content_length} "{h_referer}" "{h_user_agent}" {response_time}'
+        )
     )
     tz: str = Field(default="localtime", min_length=2, max_length=64)
 
 
 class HttpConfigPM(ExtraBaseModel):
-    std: StdConfigPM = Field(default_factory=StdConfigPM)
-    file: FileConfigPM = Field(default_factory=FileConfigPM)
+    std: HttpStdConfigPM = Field(default_factory=HttpStdConfigPM)
+    file: HttpFileConfigPM = Field(default_factory=HttpFileConfigPM)
     has_proxy_headers: bool = Field(default=True)
     has_cf_headers: bool = Field(default=True)
 
 
 class LoggerConfigPM(BaseLoggerConfigPM):
-    default_format: str = Field(
-        default=(
-            "[{time:YYYY-MM-DD HH:mm:ss.SSS Z} | {extra[level_short]:<5} | {name}:{line} | {extra[request_id]}]: "
-            "{message}"
-        ),
-        min_length=8,
-        max_length=512,
+    default_format: FormatType = Field(
+        default=id_file_format,
+        # default=(
+        #     "[{time:YYYY-MM-DD HH:mm:ss.SSS Z} | {extra[level_short]:<5} | {name}:{line} {extra[request_id]}]: "
+        #     "{message}"
+        # ),
     )
     http: HttpConfigPM = Field(default_factory=HttpConfigPM)
     intercept: InterceptConfigPM = Field(default_factory=get_default_intercept)
@@ -183,9 +182,8 @@ class LoggerConfigPM(BaseLoggerConfigPM):
 __all__ = [
     "LoggerConfigPM",
     "HttpConfigPM",
-    "StdConfigPM",
-    "FileConfigPM",
-    # "HeadersConfigPM",
+    "HttpStdConfigPM",
+    "HttpFileConfigPM",
     "get_default_intercept",
     "get_default_handlers",
 ]

{beans_logging_fastapi-7.0.0 → beans_logging_fastapi-8.0.0}/src/beans_logging_fastapi/formats.py

@@ -9,18 +9,18 @@ if TYPE_CHECKING:
 
 def http_file_format(
     record: "Record",
-    format_str: str = (
-        '{client_host} {request_id} {user_id} [{datetime}] "{method} {url_path} HTTP/{http_version}"'
-        ' {status_code} {content_length} "{h_referer}" "{h_user_agent}" {response_time}'
+    format_: str = (
+        '{client_host} {request_id} {user_id} [{datetime}] "{method} {url_path} HTTP/{http_version}" '
+        '{status_code} {content_length} "{h_referer}" "{h_user_agent}" {response_time}'
     ),
     tz: str = "localtime",
 ) -> str:
     """Http access log file format.
 
     Args:
-        record     (Record, required): Log record as dictionary.
-        format_str (str   , optional): Log message format.
-        tz         (str   , optional): Timezone for datetime field. Defaults to 'localtime'.
+        record  (Record, required): Log record as dictionary.
+        format_ (str   , optional): Log message format.
+        tz      (str   , optional): Timezone for datetime field. Defaults to 'localtime'.
 
     Returns:
         str: Format for http access log record.
@@ -56,7 +56,7 @@ def http_file_format(
         _http_info["response_time"] = 0
 
     record["extra"]["http_info"] = _http_info
-    _msg = format_str.format(**_http_info)
+    _msg = format_.format(**_http_info)
 
     record["extra"]["http_message"] = _msg
     return "{extra[http_message]}\n"
@@ -89,7 +89,59 @@ def http_json_format(record: "Record") -> str:
     return "{extra[http_serialized]}\n"
 
 
+def id_std_format(record: "Record") -> str:
+    """Std output log format with user_id, trace_id, and request_id.
+
+    Args:
+        record (Record): Log record as dictionary.
+
+    Returns:
+        str: Format for std output log with user_id, trace_id, and request_id.
+    """
+
+    _user_id = record["extra"].get("user_id")
+    _trace_id = record["extra"].get("trace_id")
+    _request_id = record["extra"].get("request_id")
+    _request_id_part = f" | <d><w>{_request_id}</w></d>" if _request_id else ""
+    _trace_id_part = f" | <lc>{_trace_id}</lc>" if _trace_id else ""
+    _user_id_part = f" | <m>{_user_id}</m>" if _user_id else ""
+
+    _format = (
+        "[<c>{time:YYYY-MM-DD HH:mm:ss.SSS Z}</c> | <level>{extra[level_short]:<5}</level> | <w>{name}:{line}</w>"
+        f"{_request_id_part}{_trace_id_part}{_user_id_part}"
+        "]: <level>{message}</level>\n"
+    )
+    return _format
+
+
+def id_file_format(record: "Record") -> str:
+    """File log format with user_id, trace_id, and request_id.
+
+    Args:
+        record (Record): Log record as dictionary.
+
+    Returns:
+        str: Format for file log with user_id, trace_id, and request_id.
+    """
+
+    _user_id = record["extra"].get("user_id")
+    _trace_id = record["extra"].get("trace_id")
+    _request_id = record["extra"].get("request_id")
+    _request_id_part = f" | {_request_id}" if _request_id else ""
+    _trace_id_part = f" | {_trace_id}" if _trace_id else ""
+    _user_id_part = f" | {_user_id}" if _user_id else ""
+
+    _format = (
+        "[{time:YYYY-MM-DD HH:mm:ss.SSS Z} | {extra[level_short]:<5} | {name}:{line}"
+        f"{_request_id_part}{_trace_id_part}{_user_id_part}"
+        "]: {message}\n"
+    )
+    return _format
+
+
 __all__ = [
     "http_file_format",
     "http_json_format",
+    "id_std_format",
+    "id_file_format",
 ]

{beans_logging_fastapi-7.0.0 → beans_logging_fastapi-8.0.0}/src/beans_logging_fastapi/http_error.py

@@ -11,19 +11,17 @@ from beans_logging import logger, Logger
 async def async_log_http_error(
     request: Request,
     status_code: int,
-    msg_format_str: str = (
-        '<n><w>[{request_id}]</w></n> {client_host} {user_id} "<u>{method} {url_path}</u>'
-        ' HTTP/{http_version}" <n>{status_code}</n>'
+    sub_format: str = (
+        '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}" <n>{status_code}</n>'
     ),
 ) -> None:
     """Async Log HTTP error for unhandled Exception.
 
     Args:
-        request        (Request, required): Request instance.
-        status_code    (int    , required): HTTP status code.
-        msg_format_str (str    , optional): Message format. Defaults to
-            '<n><w>[{request_id}]</w></n> {client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}"
-                <n>{status_code}</n>'.
+        request     (Request, required): Request instance.
+        status_code (int    , required): HTTP status code.
+        sub_format  (str    , optional): Message format. Defaults to
+            '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}" <n>{status_code}</n>'.
     """
 
     _http_info: dict[str, Any] = {"request_id": request.state.request_id}
@@ -33,9 +31,11 @@ async def async_log_http_error(
         _http_info: dict[str, Any] = request.state.http_info
     _http_info["status_code"] = status_code
 
-    _msg = msg_format_str.format(**_http_info)
+    _msg = sub_format.format(**_http_info)
     _logger: Logger = logger.opt(colors=True, record=True).bind(
-        http_info=_http_info, disable_std_handler=True
+        http_info=_http_info,
+        request_id=_http_info.get("request_id", ""),
+        disable_std_handler=True,
     )
     await run_in_threadpool(_logger.error, _msg)
     return
@@ -45,19 +45,17 @@ async def async_log_http_error(
 def log_http_error(
     request: Request,
     status_code: int,
-    msg_format_str: str = (
-        '<n><w>[{request_id}]</w></n> {client_host} {user_id} "<u>{method} {url_path}</u>'
-        ' HTTP/{http_version}" <n>{status_code}</n>'
+    sub_format: str = (
+        '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}" <n>{status_code}</n>'
     ),
 ) -> None:
     """Log HTTP error for unhandled Exception.
 
     Args:
-        request        (Request, required): Request instance.
-        status_code    (int    , required): HTTP status code.
-        msg_format_str (str    , optional): Message format. Defaults to
-            '<n><w>[{request_id}]</w></n> {client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}"
-                <n>{status_code}</n>'.
+        request     (Request, required): Request instance.
+        status_code (int    , required): HTTP status code.
+        sub_format  (str    , optional): Message format. Defaults to
+            '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}" <n>{status_code}</n>'.
     """
 
     _http_info: dict[str, Any] = {"request_id": request.state.request_id}
@@ -67,9 +65,11 @@ def log_http_error(
         _http_info: dict[str, Any] = request.state.http_info
     _http_info["status_code"] = status_code
 
-    _msg = msg_format_str.format(**_http_info)
+    _msg = sub_format.format(**_http_info)
     _logger: Logger = logger.opt(colors=True, record=True, depth=3).bind(
-        http_info=_http_info, disable_std_handler=True
+        http_info=_http_info,
+        request_id=_http_info.get("request_id", ""),
+        disable_std_handler=True,
     )
     _logger.error(_msg)
     return

{beans_logging_fastapi-7.0.0 → beans_logging_fastapi-8.0.0}/src/beans_logging_fastapi/middlewares.py

@@ -239,37 +239,37 @@ class HttpAccessLogMiddleware(BaseHTTPMiddleware):
         BaseHTTPMiddleware: Base HTTP middleware class from starlette.
 
     Attributes:
-        _DEBUG_MSG_FORMAT_STR (str ): Default http access log debug message format. Defaults to
-            '<n>[{request_id}]</n> {client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}"'.
-        _MSG_FORMAT_STR       (str ): Default http access log message format. Defaults to
-            '<n><w>[{request_id}]</w></n> {client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}"
+        _DEBUG_SUB_FORMAT (str ): Default http access log debug message format. Defaults to
+            '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}"'.
+        _SUB_FORMAT       (str ): Default http access log message format. Defaults to
+            '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}"
                 {status_code} {content_length}B {response_time}ms'.
 
-        debug_msg_format_str  (str ): Http access log debug message format.
-                                        Defaults to `HttpAccessLogMiddleware._DEBUG_MSG_FORMAT_STR`.
-        msg_format_str        (str ): Http access log message format.
-                                        Defaults to `HttpAccessLogMiddleware._MSG_FORMAT_STR`.
-        use_debug_log         (bool): If True, use debug log to log http access log. Defaults to True.
+        debug_sub_format  (str ): Http access log debug message format.
+                                        Defaults to `HttpAccessLogMiddleware._DEBUG_SUB_FORMAT`.
+        sub_format        (str ): Http access log message format.
+                                        Defaults to `HttpAccessLogMiddleware._SUB_FORMAT`.
+        use_debug_log     (bool): If True, use debug log to log http access log. Defaults to True.
     """
 
-    _DEBUG_MSG_FORMAT_STR = (
+    _DEBUG_SUB_FORMAT = (
         '{client_host} {user_id} "<u>{method} {url_path}</u>' ' HTTP/{http_version}"'
     )
-    _MSG_FORMAT_STR = (
-        '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}"'
-        " {status_code} {content_length}B {response_time}ms"
+    _SUB_FORMAT = (
+        '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}" '
+        "{status_code} {content_length}B {response_time}ms"
     )
 
     def __init__(
         self,
         app,
-        debug_msg_format_str: str = _DEBUG_MSG_FORMAT_STR,
-        msg_format_str: str = _MSG_FORMAT_STR,
+        debug_sub_format: str = _DEBUG_SUB_FORMAT,
+        sub_format: str = _SUB_FORMAT,
         use_debug_log: bool = True,
     ):
         super().__init__(app)
-        self.debug_msg_format_str = debug_msg_format_str
-        self.msg_format_str = msg_format_str
+        self.debug_sub_format = debug_sub_format
+        self.sub_format = sub_format
         self.use_debug_log = use_debug_log
 
     async def dispatch(self, request: Request, call_next) -> Response:
@@ -283,16 +283,18 @@ class HttpAccessLogMiddleware(BaseHTTPMiddleware):
 
         # Debug log:
         if self.use_debug_log:
-            _debug_msg = self.debug_msg_format_str.format(**_http_info)
+            _debug_msg = self.debug_sub_format.format(**_http_info)
 
             _logger.bind(
                 http_info=_http_info,
-                request_id=_http_info.get("request_id", "-"),
+                request_id=_http_info.get("request_id", ""),
                 disable_http_all_file_handlers=True,
             ).debug(_debug_msg)
             # await run_in_threadpool(
             #     _logger.bind(
-            #         http_info=_http_info, disable_http_all_file_handlers=True
+            #         http_info=_http_info,
+            #         request_id=_http_info.get("request_id", ""),
+            #         disable_http_all_file_handlers=True,
             #     ).debug,
             #     _debug_msg,
             # )
@@ -309,32 +311,36 @@ class HttpAccessLogMiddleware(BaseHTTPMiddleware):
 
         # Http access log:
         _LEVEL = "INFO"
-        _msg_format_str = self.msg_format_str
+        _sub_format = self.sub_format
         if _http_info["status_code"] < 200:
             _LEVEL = "DEBUG"
-            _msg_format_str = f'<d>{_msg_format_str.replace("{status_code}", "<n><b><k>{status_code}</k></b></n>")}</d>'
+            _sub_format = f'<d>{_sub_format.replace("{status_code}", "<n><b><k>{status_code}</k></b></n>")}</d>'
         elif (200 <= _http_info["status_code"]) and (_http_info["status_code"] < 300):
             _LEVEL = "SUCCESS"
-            _msg_format_str = f'<w>{_msg_format_str.replace("{status_code}", "<lvl>{status_code}</lvl>")}</w>'
+            _sub_format = f'<w>{_sub_format.replace("{status_code}", "<lvl>{status_code}</lvl>")}</w>'
         elif (300 <= _http_info["status_code"]) and (_http_info["status_code"] < 400):
             _LEVEL = "INFO"
-            _msg_format_str = f'<d>{_msg_format_str.replace("{status_code}", "<n><b><c>{status_code}</c></b></n>")}</d>'
+            _sub_format = f'<d>{_sub_format.replace("{status_code}", "<n><b><c>{status_code}</c></b></n>")}</d>'
         elif (400 <= _http_info["status_code"]) and (_http_info["status_code"] < 500):
             _LEVEL = "WARNING"
-            _msg_format_str = _msg_format_str.replace(
-                "{status_code}", "<r>{status_code}</r>"
-            )
+            _sub_format = _sub_format.replace("{status_code}", "<r>{status_code}</r>")
         elif 500 <= _http_info["status_code"]:
             _LEVEL = "ERROR"
-            _msg_format_str = (
-                f'{_msg_format_str.replace("{status_code}", "<n>{status_code}</n>")}'
+            _sub_format = (
+                f'{_sub_format.replace("{status_code}", "<n>{status_code}</n>")}'
             )
 
-        _msg = _msg_format_str.format(**_http_info)
+        _msg = _sub_format.format(**_http_info)
         _logger.bind(
-            http_info=_http_info, request_id=_http_info.get("request_id", "-")
+            http_info=_http_info, request_id=_http_info.get("request_id", "")
         ).log(_LEVEL, _msg)
-        # await run_in_threadpool(_logger.bind(http_info=_http_info).log, _LEVEL, _msg)
+        # await run_in_threadpool(
+        #     _logger.bind(
+        #         http_info=_http_info, request_id=_http_info.get("request_id", "")
+        #     ).log,
+        #     _LEVEL,
+        #     _msg,
+        # )
         # Http access log.
 
         return response

{beans_logging_fastapi-7.0.0 → beans_logging_fastapi-8.0.0}/src/beans_logging_fastapi/mode.py

@@ -1,16 +1,24 @@
+from typing import TYPE_CHECKING
+
 from pydantic import validate_call
 from fastapi.concurrency import run_in_threadpool
 
+if TYPE_CHECKING:
+    from loguru import Logger
+else:
+    from loguru._logger import Logger
+
 from potato_util.constants import WarnEnum
 from beans_logging.constants import LogLevelEnum
 from beans_logging import logger
 
 
-@validate_call
+@validate_call(config={"arbitrary_types_allowed": True})
 async def async_log_at(
     message: str,
     level: LogLevelEnum | str = LogLevelEnum.INFO,
     warn_mode: WarnEnum | str = WarnEnum.ALWAYS,
+    logger: Logger = logger,
 ) -> None:
     """Log message with level and warn mode in async context.
 
@@ -19,6 +27,7 @@ async def async_log_at(
         level     (LogLevelEnum | str, optional): Log level when warn mode is `WarnEnum.ALWAYS`.
                                                     Defaults to `LogLevelEnum.INFO`.
         warn_mode (WarnEnum | str    , optional): Warn mode to use. Defaults to `WarnEnum.ALWAYS`.
+        logger    (Logger            , optional): Logger instance to use. Defaults to `logger`.
 
     Raises:
         ValueError: If `level` is not a valid log level.
@@ -32,7 +41,10 @@ async def async_log_at(
         warn_mode = WarnEnum(warn_mode.strip().upper())
 
     if warn_mode == WarnEnum.ALWAYS:
-        await run_in_threadpool(logger.log, level.name, message)
+        if level == LogLevelEnum.EXCEPTION:
+            await run_in_threadpool(logger.exception, message)
+        else:
+            await run_in_threadpool(logger.log, level.name, message)
     elif warn_mode == WarnEnum.DEBUG:
         await run_in_threadpool(logger.debug, message)
 

{beans_logging_fastapi-7.0.0 → beans_logging_fastapi-8.0.0/src/beans_logging_fastapi.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: beans_logging_fastapi
-Version: 7.0.0
+Version: 8.0.0
 Summary: This is a HTTP access log module for FastAPI based on 'beans-logging' package.
 Author-email: Batkhuu Byambajav <batkhuu10@gmail.com>
 Project-URL: Homepage, https://github.com/bybatkhuu/module-fastapi-logging
@@ -170,15 +170,7 @@ logger:
   app_name: "fastapi-app"
   level:
     base: TRACE
-  default_format: "[{time:YYYY-MM-DD HH:mm:ss.SSS Z} | {extra[level_short]:<5} | {name}:{line} | {extra[request_id]}]: {message}"
   http:
-    std:
-      msg_format_str: '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}" {status_code} {content_length}B {response_time}ms'
-      err_msg_format_str: '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}" <n>{status_code}</n>'
-      debug_msg_format_str: '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}"'
-    file:
-      format_str: '{client_host} {request_id} {user_id} [{datetime}] "{method} {url_path} HTTP/{http_version}" {status_code} {content_length} "{h_referer}" "{h_user_agent}" {response_time}'
-      tz: "localtime"
     has_proxy_headers: false
     has_cf_headers: false
   intercept:
@@ -186,10 +178,8 @@ logger:
   handlers:
     std_handler:
       enabled: true
-      format: "[<c>{time:YYYY-MM-DD HH:mm:ss.SSS Z}</c> | <level>{extra[level_short]:<5}</level> | <w>{extra[request_id]}</w> | <w>{name}:{line}</w>]: <level>{message}</level>"
     http_access_std_handler:
       enabled: true
-      format: "[<c>{time:YYYY-MM-DD HH:mm:ss.SSS Z}</c> | <level>{extra[level_short]:<5}</level> | <w>{extra[request_id]}</w>]: <level>{message}</level>"
     http_access_file_handler:
       enabled: true
       sink: "http/{app_name}.http-access.log"
@@ -202,6 +192,7 @@ logger:
     http_err_json_handler:
       enabled: true
       sink: "http.json/{app_name}.http-err.json.log"
+
 ```
 
 [**`.env`**](./examples/.env):
@@ -255,14 +246,17 @@ __all__ = [
 
 ```python
 from pydantic import validate_call
-from fastapi import FastAPI, APIRouter, HTTPException
+from fastapi import FastAPI, APIRouter, HTTPException, Request
 from fastapi.responses import RedirectResponse
 
 router = APIRouter()
 
 
 @router.get("/")
-def root():
+def root(request: Request):
+    _logger = request.state.logger
+    _logger.info("Root endpoint accessed.")
+
     return {"Hello": "World"}
 
 
@@ -452,7 +446,7 @@ logger:
   level:
     base: INFO
     err: WARNING
-  format_str: "[{time:YYYY-MM-DD HH:mm:ss.SSS Z} | {extra[level_short]:<5} | {name}:{line} | {extra[request_id]}]: {message}"
+  default_format: "[{time:YYYY-MM-DD HH:mm:ss.SSS Z} | {extra[level_short]:<5} | {name}:{line} {extra[request_id]}]: {message}"
   file:
     logs_dir: "./logs"
     rotate_size: 10000000
@@ -462,11 +456,11 @@ logger:
   custom_serialize: false
   http:
     std:
-      msg_format_str: '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}" {status_code} {content_length}B {response_time}ms'
-      err_msg_format_str: '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}" <n>{status_code}</n>'
-      debug_msg_format_str: '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}"'
+      sub_format: '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}" {status_code} {content_length}B {response_time}ms'
+      err_sub_format: '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}" <n>{status_code}</n>'
+      debug_sub_format: '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}"'
     file:
-      format_str: '{client_host} {request_id} {user_id} [{datetime}] "{method} {url_path} HTTP/{http_version}" {status_code} {content_length} "{h_referer}" "{h_user_agent}" {response_time}'
+      format_: '{client_host} {request_id} {user_id} [{datetime}] "{method} {url_path} HTTP/{http_version}" {status_code} {content_length} "{h_referer}" "{h_user_agent}" {response_time}'
       tz: localtime
     has_proxy_headers: true
     has_cf_headers: true
@@ -477,14 +471,14 @@ logger:
     include_modules: []
     mute_modules: [uvicorn.access]
   global_extra:
-    trace_id: "-"
-    request_id: "-"
-    user_id: "-"
+    trace_id: ""
+    request_id: ""
+    user_id: ""
   handlers:
     std_handler:
       enabled: true
       type_: STD
-      format: "[<c>{time:YYYY-MM-DD HH:mm:ss.SSS Z}</c> | <level>{extra[level_short]:<5}</level> | <w>{extra[request_id]}</w> | <w>{name}:{line}</w>]: <level>{message}</level>"
+      format: "[<c>{time:YYYY-MM-DD HH:mm:ss.SSS Z}</c> | <level>{extra[level_short]:<5}</level> | <w>{name}:{line}</w> <d><w>{extra[request_id]}</w></d>]: <level>{message}</level>"
       colorize: true
     file_handler:
       enabled: true
@@ -509,7 +503,7 @@ logger:
     http_access_std_handler:
       enabled: true
       type_: STD
-      format: "[<c>{time:YYYY-MM-DD HH:mm:ss.SSS Z}</c> | <level>{extra[level_short]:<5}</level> | <w>{extra[request_id]}</w>]: <level>{message}</level>"
+      format: "[<c>{time:YYYY-MM-DD HH:mm:ss.SSS Z}</c> | <level>{extra[level_short]:<5}</level> | <d><w>{extra[request_id]}</w></d>]: <level>{message}</level>"
       colorize: true
     http_access_file_handler:
       enabled: true

beans_logging_fastapi-7.0.0/src/beans_logging_fastapi/__version__.py

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