feat: logging customization

bentoml/_internal/configuration/containers.py

@@ -178,6 +178,12 @@ def _is_ip_address(addr: str) -> bool:
                 },
             },
         },
+        "logging": {
+            "formatting": {
+                "trace_id_format": str,
+                "span_id_format": str,
+            }
+        },
     }
 )
 
@@ -535,5 +541,12 @@ def duration_buckets(
             )
         return DEFAULT_BUCKET
 
+    @providers.SingletonFactory
+    @staticmethod
+    def logging_formats(
+        cfg: dict[str, t.Any] = Provide[config.logging.formatting],
+    ) -> dict[str, str]:
+        return cfg
+
 
 BentoMLContainer = _BentoMLContainerClass()

bentoml/_internal/configuration/default_configuration.yaml

@@ -51,3 +51,8 @@ tracing:
   otlp:
     protocol: Null
     url: Null
+
+logging:
+  formatting:
+    trace_id_format: 032x
+    span_id_format: 016x

bentoml/_internal/log.py

@@ -9,6 +9,7 @@
 from .context import component_context
 from .configuration import get_debug_mode
 from .configuration import get_quiet_mode
+from .configuration.containers import BentoMLContainer
 
 default_factory = logging.getLogRecordFactory()
 
@@ -50,6 +51,10 @@ def filter(self, record: logging.LogRecord) -> bool:
 )
 DATE_FORMAT = "%Y-%m-%dT%H:%M:%S%z"
 
+LOGGING_FORMATS = BentoMLContainer.logging_formats.get()
+TRACE_ID_FORMAT = LOGGING_FORMATS["trace_id_format"]
+SPAN_ID_FORMAT = LOGGING_FORMATS["span_id_format"]
+
 SERVER_LOGGING_CONFIG: dict[str, t.Any] = {
     "version": 1,
     "disable_existing_loggers": True,
@@ -111,10 +116,13 @@ def trace_record_factory(*args: t.Any, **kwargs: t.Any):
     record = default_factory(*args, **kwargs)
     record.levelname_bracketed = f"[{record.levelname}]"  # type: ignore (adding fields to record)
     record.component = f"[{_component_name()}]"  # type: ignore (adding fields to record)
-    if trace_context.trace_id == 0:
+    trace_id = trace_context.trace_id
+    if trace_id in (0, None):
         record.trace_msg = ""  # type: ignore (adding fields to record)
     else:
-        record.trace_msg = f" (trace={trace_context.trace_id},span={trace_context.span_id},sampled={trace_context.sampled})"  # type: ignore (adding fields to record)
+        trace_id = format(trace_id, TRACE_ID_FORMAT)
+        span_id = format(trace_context.span_id, SPAN_ID_FORMAT)
+        record.trace_msg = f" (trace={trace_id},span={span_id},sampled={trace_context.sampled})"  # type: ignore (adding fields to record)
     record.request_id = trace_context.request_id  # type: ignore (adding fields to record)
 
     return record

docs/source/guides/logging.rst

@@ -59,22 +59,22 @@ logs are logged under the ``"bentoml"`` namespace.
 Web Service Request Logging
 """""""""""""""""""""""""""
 
-For web requests, logging can be enabled and disabled using the `logging.access` parameter at the
-top level of the ``bentoml_configuration.yml``.
+For web requests, logging can be enabled and disabled using the `logging.access` parameter in both the `api_server` and `runner`
+sections of the ``bentoml_configuration.yml``.
 
 .. code-block:: yaml
 
     logging:
       access:
-          enabled: False
-          # whether to log the size of the request body
-          request_content_length: True
-          # whether to log the content type of the request
-          request_content_type: True
-          # whether to log the content length of the response
-          response_content_length: True
-          # whether to log the content type of the response
-          response_content_type: True
+        enabled: False
+        # whether to log the size of the request body
+        request_content_length: True
+        # whether to log the content type of the request
+        request_content_type: True
+        # whether to log the content length of the response
+        response_content_length: True
+        # whether to log the content type of the response
+        response_content_type: True
 
 
 Model Runner Request Logging
@@ -88,15 +88,30 @@ your ``bentoml_configuration.yml``:
 .. code-block:: yaml
 
     runners:
-        logging:
-          access:
-              enabled: True
-              ...
+      logging:
+        access:
+          enabled: True
+          ...
 
 The available configuration options are identical to the webserver request logging options above.
 These logs are disabled by default in order to prevent double logging of requests.
 
 
+Logging Formatting
+""""""""""""""""""
+
+You may configure the logging formatting options at the top level of your ``bentoml_configuration.yml``.
+The default configuration is shown below, where the opentelemetry trace_id and span_id are logged in
+hexadecimal format, consistent with opentelemetry logging instrumentation.
+
+.. code-block:: yaml
+
+    logging:
+      formatting:
+        trace_id_format: 032x
+        span_id_format: 016x
+
+
 Library Logging
 ---------------